Source for file ActionChain.php

Documentation is available at ActionChain.php

  1. <?php
  2. /**
  3.  * Teeple2 - PHP5 Web Application Framework inspired by Seasar2
  4.  *
  5.  * PHP versions 5
  6.  *
  7.  * LICENSE: This source file is subject to version 3.0 of the PHP license
  8.  * that is available through the world-wide-web at the following URI:
  9.  * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
  10.  * the PHP License and are unable to obtain it through the web, please
  11.  * send a note to license@php.net so we can mail you a copy immediately.
  12.  *
  13.  * @package     teeple
  14.  * @author      Mitsutaka Sato <miztaka@gmail.com>
  15.  * @license     http://www.php.net/license/3_0.txt  PHP License 3.0
  16.  */
  17.  
  18. /**
  19.  * Actionを管理するクラス。
  20.  * このクラスを使ってActionのForwardに対応する。
  21.  * @package     teeple
  22.  */
  23. class Teeple_ActionChain
  24. {
  25.     /**
  26.      * Actionのリスト
  27.      * @var array 
  28.      */
  29.     protected $_list = array();
  30.  
  31.     /**
  32.      * @var 現在実行されているActionの位置を保持する 
  33.      */
  34.     protected $_index = 0;
  35.     
  36.     /**
  37.      * @var Logger 
  38.      */
  39.     protected $log;
  40.     
  41.     /**
  42.      * @var Teeple_Request 
  43.      */
  44.     private $request;
  45.     public function setComponent_Teeple_Request($c) {
  46.         $this->request = $c;
  47.     }
  48.     
  49.     /**
  50.      * @var Teeple_Container 
  51.      */
  52.     private $container;
  53.     public function setComponent_container($c) {
  54.         $this->container = $c;
  55.     }
  56.     
  57.     /**
  58.      * @var Teeple_Response 
  59.      */
  60.     private $response;
  61.     public function setComponent_Teeple_Response($c) {
  62.         $this->response = $c;
  63.     }
  64.     
  65.     /**
  66.      * @var Teeple_ValidatorManager 
  67.      */
  68.     private $validatorManager;
  69.     public function setComponent_Teeple_ValidatorManager($c) {
  70.         $this->validatorManager = $c;
  71.     }
  72.  
  73.     /**
  74.      * @var Teeple_ConverterManager 
  75.      */
  76.     private $converterManager;
  77.     public function setComponent_Teeple_ConverterManager($c) {
  78.         $this->converterManager = $c;
  79.     }
  80.     
  81.     /**
  82.      * コンストラクター
  83.      */
  84.     public function __construct() {
  85.         $this->log = LoggerManager::getLogger(get_class($this));
  86.     }
  87.  
  88.     /**
  89.      * Actionを追加する
  90.      *
  91.      * @param   string  $name   Actionのクラス名
  92.      */
  93.     public function add($name) {
  94.  
  95.         // Actionのクラス名をチェック
  96.         if (!preg_match("/^[0-9a-zA-Z_]+$/", $name)) {
  97.             throw new Teeple_Exception("Actionクラス名が不正です。");
  98.         }
  99.  
  100.         // Actionクラスのインスタンス化
  101.         $className = Teeple_Util::capitalizedClassName($name);
  102.         $action = $this->container->getPrototype($className);
  103.         if (!is_object($action)) {
  104.             throw new Teeple_Exception("Actionクラスの生成に失敗しました。({$className})");
  105.         }
  106.  
  107.         array_push($this->_list, $action);
  108.         return;
  109.     }
  110.  
  111.     /**
  112.      * ActionChainをクリアする。
  113.      *
  114.      */
  115.     public function clear() {
  116.         $this->_list = array();
  117.         $this->_index     = 0;
  118.     }
  119.  
  120.     /**
  121.      * ActionChainに次のActionがあるかどうか？
  122.      * @return boolean 
  123.      */
  124.     public function hasNext() {
  125.         return ($this->_index < (count($this->_list) - 1));
  126.     }
  127.  
  128.     /**
  129.      * ActionChainを次に進める
  130.      *
  131.      */
  132.     public function next() {
  133.         
  134.         if ($this->_index >= count($this->_list)) {
  135.             throw new Teeple_Exception("次のアクションはありません。");
  136.         }
  137.         $this->_index++;
  138.         return;
  139.     }
  140.  
  141.     /**
  142.      * 現在のAction名を返却
  143.      *
  144.      * @return  string  Actionの名前
  145.      */
  146.     public function getCurActionName() {
  147.         return strtolower(get_class($this->getCurAction()));
  148.     }
  149.     
  150.     /**
  151.      * リストの先頭のActionのインスタンスを返却
  152.      *
  153.      * @return Teeple_ActionBase 
  154.      */
  155.     public function getCurAction() {
  156.         return $this->_list[$this->_index];
  157.     }
  158.     
  159.     /**
  160.      * ActionChainを実行します。
  161.      *
  162.      */
  163.     public function execute() {
  164.         
  165.         if (count($this->_list) == 0) {
  166.             throw new Teeple_Exception("Actionが1つも登録されていません。");
  167.         }
  168.         
  169.         while (true) {
  170.             // Actionを実行する
  171.             $view = $this->executeAction();
  172.             if ($view == "") {
  173.                 $actionName = $this->getCurActionName();
  174.                 $view = str_replace('_','/',$actionName).".html";
  175.             }
  176.             // Actionへのフォワードの場合
  177.             if (preg_match("/^action:/", $view)) {
  178.                 $action = preg_replace("/action:/", "", $view);
  179.                 $this->add(trim($action));
  180.                 $this->request->setFilterError(NULL);
  181.             } else {
  182.                 $this->response->setView($view);
  183.             }
  184.             // 次へ進む
  185.             if (! $this->hasNext()) {
  186.                 break;
  187.             }
  188.             $this->next();
  189.         }
  190.         return;
  191.     }
  192.  
  193.     /**
  194.      * Actionを実行
  195.      *
  196.      * @return string viewのパス
  197.      */
  198.     private function executeAction() {
  199.  
  200.         // 現在のアクションを取得
  201.         $action = $this->getCurAction();
  202.         if (!is_object($action)) {
  203.             throw new Teeple_Exception("Actionオブジェクトが取得できません。");
  204.         }
  205.         $className = get_class($action);
  206.         $this->log->info("アクション {$className} を実行します。");
  207.         
  208.         // メソッド名
  209.         $methodName = $this->request->getActionMethod();
  210.         if (! method_exists($action, $methodName)) {
  211.             $methodName = 'execute';
  212.         }
  213.         
  214.         // Converterの実行
  215.         $params = $this->request->getParameters();
  216.         $this->doConverter($action, $params);
  217.         
  218.         // Requestの値をActionに移す
  219.         if (count($params) > 0) {
  220.             foreach($params as $name => $value) {
  221.                 if (preg_match('/^__/', $name)) {
  222.                     continue;
  223.                 }
  224.                 $action->$name = $params[$name];
  225.             }
  226.         }
  227.         
  228.         if (! $this->request->isFilterError()) {
  229.             // Validatorの実行
  230.             $this->doValidation($action, $methodName);
  231.         }
  232.         
  233.         // エラーが発生している場合は、onXXError()メソッドを実行する。
  234.         if ($this->request->isFilterError()) {
  235.             $type = $this->request->getFilterError();
  236.             $this->log->debug("errortype: $type");
  237.             if ($type != "") {
  238.                 $methodName = 'on'.$type.'Error';
  239.                 $this->log->info("メソッド {$methodName} を実行します。");
  240.                 if (method_exists($action, $methodName)) {
  241.                     return $action->$methodName();
  242.                 }
  243.                 $this->log->warn("メソッド {$methodName} が存在しません。");
  244.                 return NULL;
  245.             }
  246.         }
  247.         
  248.         // Actionメソッドを実行する。
  249.         $this->log->info("メソッド {$methodName} を実行します。");
  250.         return $action->$methodName();
  251.     }
  252.     
  253.     /**
  254.      * バリデーションを実行します。
  255.      *
  256.      * @param Teeple_ActionBase $action 
  257.      * @param string $methodName 
  258.      */
  259.     private function doValidation($action, $methodName) {
  260.         
  261.         $className = get_class($action);
  262.         if (! defined($className."::VALIDATION_CONFIG")) {
  263.             return;
  264.         }
  265.         if (defined($className."::VALIDATION_TARGET")) {
  266.             $targets = explode(',', constant($className."::VALIDATION_TARGET"));
  267.             array_walk($targets, 'trim');
  268.             if (! in_array($methodName, $targets)) {
  269.                 $this->log->info("メソッド{$methodName}はValidation対象ではありません。");
  270.                 return;
  271.             }
  272.         }
  273.         
  274.         $validationConfig = $this->validatorManager->parseYAML(constant($className."::VALIDATION_CONFIG"));
  275.         if (! $this->validatorManager->execute($action, $validationConfig)) {
  276.             $this->request->setFilterError('Validate');
  277.         }
  278.         
  279.         return;
  280.     }
  281.     
  282.     /**
  283.      * Converterを実行します。
  284.      *
  285.      * @param Teeple_ActionBase $action 
  286.      * @param array $params 
  287.      */
  288.     private function doConverter($action, &$params) {
  289.         
  290.         $className = get_class($action);
  291.         if (! defined($className."::CONVERTER_CONFIG")) {
  292.             return;
  293.         }
  294.         
  295.         $yamlConfig = Horde_Yaml::load(constant($className."::CONVERTER_CONFIG"));
  296.         if (! is_array($yamlConfig)) {
  297.             throw new Teeple_Exception("Converterの設定を解析できませんでした。");
  298.         }
  299.         //$this->log->debug(var_export($yamlConfig, true));
  300.         
  301.         $this->converterManager->execute($params, $yamlConfig);
  302.     }
  303.  
  304. }
  305. ?>
Documentation generated on Mon, 26 Apr 2010 08:59:28 +0900 by phpDocumentor 1.4.3