Source for file Simple.php

Documentation is available at Simple.php

  1. <?php
  2. /**
  3.  *  Simple.php
  4.  *
  5.  *  @author     Keisuke SATO <riaf@me.com>
  6.  *  @package    Ethna
  7.  *  @version    $Id: b05bd254b9b40e0c2f998380421e86bf7868467c $
  8.  */
  9.  
  10. /**
  11.  *  URLハンドラクラス
  12.  *
  13.  *  @author     Keisuke SATO <riaf@me.com>
  14.  *  @access     public
  15.  *  @package    Ethna
  16.  */
  17. class Ethna_UrlHandler_Simple
  18. {
  19.     /** @var    array   アクションマッピング */
  20.     protected $action_map = array(
  21.         // 'index' => '/',
  22.         // 'wozozo_index' => '/wozozo',
  23.         // 'wozozo_message' => '/wozozo/{message}',
  24.         // 'message_show' => array(
  25.         //     'path' => '/message/{id}',
  26.         //     'patterns' => array(
  27.         //         'id' => '\d+',
  28.         //     ),
  29.         //     'defaults' => array(
  30.         //         'id' => 123,
  31.         //     ),
  32.         // ),
  33.     );
  34.  
  35.     /**
  36.      *  アクションをユーザリクエストに変換する
  37.      *
  38.      *  @access public
  39.      */
  40.     public function actionToRequest($action, $param=array())
  41.     {
  42.         $ret = null;
  43.         $action_map = $this->getActionMap();
  44.  
  45.         if (isset($action_map[$action])) {
  46.             $def = $action_map[$action];
  47.  
  48.             $paths = $this->sortPaths($def['path'], SORT_DESC);
  49.  
  50.             foreach ($paths as $path) {
  51.                 if (strpos($path, '{') && preg_match_all('/\{(.*?)\}/', $path, $matches)) {
  52.                     $keys = array_unique($matches[1]);
  53.                     $replaces = array();
  54.  
  55.                     foreach ($keys as $key) {
  56.                         $val = null;
  57.                         if (isset($param[$key])) {
  58.                             $val = $param[$key];
  59.                         } else if (isset($def['defaults']) && isset($def['defaults'][$key])) {
  60.                             $val = $def['defaults'][$key];
  61.                         }
  62.  
  63.                         if (!is_null($val)) {
  64.                             $replaces['{'.$key.'}'] = $val;
  65.                         } else {
  66.                             continue 2;
  67.                         }
  68.                     }
  69.  
  70.                     $ret = array(str_replace(array_keys($replaces), array_values($replaces), $path), $keys);
  71.                     break;
  72.                 } else {
  73.                     $ret = array($path, array());
  74.                     break;
  75.                 }
  76.             }
  77.         }
  78.  
  79.         return $ret;
  80.     }
  81.  
  82.     /**
  83.      * ユーザリクエストをアクションに変換する
  84.      *
  85.      * @param array $http_vars 
  86.      */
  87.     public function requestToAction($http_vars)
  88.     {
  89.         $path = '/';
  90.         $detected_action = null;
  91.  
  92.         if (isset($http_vars['__url_info__'])) {
  93.             $path = $this->normalizePath($http_vars['__url_info__']);
  94.         }
  95.  
  96.         foreach ($this->getActionMap() as $action => $def) {
  97.             foreach ($def['path'] as $pattern) {
  98.                 if (strpos($pattern, '{')) {
  99.                     $action = $this->getActionByRegex($path, $action, $def, $http_vars);
  100.  
  101.                     if (!is_null($action)) {
  102.                         $detected_action = $action;
  103.                         break;
  104.                     }
  105.                 } else {
  106.                     if ($path === $pattern) {
  107.                         $detected_action = $action;
  108.                         break;
  109.                     }
  110.                 }
  111.             }
  112.         }
  113.  
  114.         if (is_null($detected_action)) {
  115.             $http_vars = array();
  116.         } else {
  117.             $http_vars = $this->buildActionParameter($http_vars, $detected_action);
  118.         }
  119.  
  120.         return $http_vars;
  121.     }
  122.  
  123.     /**
  124.      * 正規表現でマッチさせる
  125.      *
  126.      * @param string $path 
  127.      * @param string $action 
  128.      * @param array $def 
  129.      * @param array $http_vars 
  130.      */
  131.     protected function getActionByRegex($path, $action, $def, &$http_vars)
  132.     {
  133.         $ret_action = null;
  134.         $regex_pattern = array();
  135.         $request_keys = array();
  136.  
  137.         foreach ($def['path'] as $pattern) {
  138.             if (preg_match_all('/\{(.*?)\}/', $pattern, $matches)) {
  139.                 $request_keys = $matches[1];
  140.  
  141.                 $replaces = array();
  142.                 foreach ($matches[0] as $i => $from) {
  143.                     $key = $matches[1][$i];
  144.                     $to = '([^\/]+?)';
  145.  
  146.                     if (isset($def['patterns']) && isset($def['patterns'][$key])) {
  147.                         $to = '('.$def['patterns'][$key].')';
  148.                     }
  149.  
  150.                     $replaces[preg_quote($from, '/')] = $to;
  151.                 }
  152.  
  153.                 $regex_pattern = '/^'.str_replace(array_keys($replaces), array_values($replaces), preg_quote($pattern, '/')).'$/';
  154.  
  155.                 if (preg_match($regex_pattern, $path, $match)) {
  156.                     $ret_action = $action;
  157.  
  158.                     foreach ($request_keys as $i => $key) {
  159.                         if (isset($match[$i+1])) {
  160.                             $http_vars[$key] = $match[$i+1];
  161.                         }
  162.                     }
  163.                 }
  164.             }
  165.         }
  166.  
  167.         return $ret_action;
  168.     }
  169.  
  170.     /**
  171.      *  Ethna_UrlHandlerクラスのインスタンスを取得する
  172.      *
  173.      *  $name がクラス名 ('_'を含む) の場合はそのクラスを、
  174.      *  そうでないときはプラグイン名とみなしてインスタンスを返す
  175.      *
  176.      *  @access public
  177.      */
  178.     public static function getInstance($name = null)
  179.     {
  180.         static $instance = array();
  181.         if ($name === null) {
  182.             $name = __CLASS__;
  183.         }
  184.         if (isset($instance[$name])) {
  185.             return $instance[$name];
  186.         }
  187.  
  188.         if (strpos($name, '_') !== false) {
  189.             $instance[$name] = new $name();
  190.         } else {
  191.             // get instance with plugin
  192.             $ctl = Ethna_Controller::getInstance();
  193.             $plugin = $ctl->getPlugin();
  194.             $instance[$name] = $plugin->getPlugin('Urlhandler', $name);
  195.         }
  196.  
  197.         return $instance[$name];
  198.     }
  199.  
  200.     /**
  201.      * get action_map
  202.      * より複雑な定義などを行うときはこれをオーバーライドする
  203.      *
  204.      * @return array 
  205.      */
  206.     protected function getActionMap()
  207.     {
  208.         foreach ($this->action_map as &$def) {
  209.             if (is_string($def)) {
  210.                 $def = array(
  211.                     'path' => array($def),
  212.                 );
  213.             } else if (is_array($def) && isset($def['path']) && is_string($def['path'])) {
  214.                 $def['path'] = array($def['path']);
  215.             }
  216.         }
  217.  
  218.         return $this->action_map;
  219.     }
  220.  
  221.     /**
  222.      *  ゲートウェイパスを正規化する
  223.      *
  224.      *  @access protected
  225.      */
  226.     protected function normalizePath($path)
  227.     {
  228.         if ($path == "") {
  229.             return array($path, false);
  230.         }
  231.  
  232.         $path = preg_replace('|/+|', '/', $path);
  233.         $path = '/'.trim($path, '/');
  234.  
  235.         return $path;
  236.     }
  237.  
  238.     /**
  239.      * 引数順にソートする
  240.      *
  241.      * @access protected
  242.      */
  243.     protected function sortPaths(array $paths, $sort = SORT_ASC)
  244.     {
  245.         $counts = array();
  246.         foreach ($paths as $path) {
  247.             $counts[] = substr_count($path, '{');
  248.         }
  249.  
  250.         array_multisort($paths, $sort, $counts);
  251.  
  252.         return $paths;
  253.     }
  254.  
  255.     /**
  256.      *  アクションをリクエストパラメータに変換する
  257.      *
  258.      *  @access protected
  259.      */
  260.     protected function buildActionParameter($http_vars, $action)
  261.     {
  262.         if ($action == "") {
  263.             return $http_vars;
  264.         }
  265.  
  266.         $key = sprintf('action_%s', $action);
  267.         $http_vars[$key] = 'true';
  268.  
  269.         return $http_vars;
  270.     }
  271. }

Documentation generated on Fri, 11 Nov 2011 03:59:04 +0900 by phpDocumentor 1.4.3