Source for file FilterChain.php

Documentation is available at FilterChain.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.  * Filterを保持するクラス
  20.  *
  21.  * @package     teeple
  22.  */
  23. class Teeple_FilterChain
  24. {
  25.     /**
  26.      * Filterを保持する
  27.      * @var array 
  28.      */
  29.     protected $_list = array();
  30.  
  31.     /**
  32.      * Filterの位置を保持する
  33.      * @var array 
  34.      */
  35.     protected $_position = array();
  36.  
  37.     /**
  38.      * 現在実行されているFilterの位置を保持する
  39.      * @var int 
  40.      */
  41.     protected $_index = -1;
  42.  
  43.     /**
  44.      * @var Logger 
  45.      */
  46.     protected $log;
  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_Request 
  59.      */
  60.     private $request;
  61.     public function setComponent_Teeple_Request($c) {
  62.         $this->request = $c;
  63.     }
  64.         
  65.     /**
  66.      * コンストラクタ
  67.      *
  68.      */
  69.     public function __construct() {
  70.         $this->log = LoggerManager::getLogger(get_class($this));
  71.     }
  72.  
  73.     /**
  74.      * FilterChainの最後にFilterを追加
  75.      *
  76.      * @param   string  $name   Filterのクラス名
  77.      * @param   string  $alias  Filterのエイリアス名
  78.      * @param   array   $attributes Filterの属性値
  79.      */
  80.     public function add($name, $alias = '', $attributes = NULL) {
  81.  
  82.         // エイリアス名が指定されていない場合はクラス名をセット
  83.         if (empty($alias)) {
  84.             $alias = $name;
  85.         }
  86.  
  87.         // Filterの実行が既に始まっていたらエラー(実行後の追加はエラー)
  88.         if ($this->_index > -1) {
  89.             throw new Teeple_Exception("既にフィルターが実行されています。");
  90.         }
  91.  
  92.         // Filterのクラス名が不正だったらエラー
  93.         if (!preg_match("/^[0-9a-zA-Z_]+$/", $name)) {
  94.             throw new Teeple_Exception("フィルターのクラス名が不正です。({$name})");
  95.         }
  96.  
  97.         // 既に同名のFilterが追加されていたら何もしない
  98.         if (isset($this->_list[$alias]) && is_object($this->_list[$alias])) {
  99.             $this->log->info("このFilterは既に登録されています(${name}[alias:${alias}])");
  100.             return;
  101.         }
  102.  
  103.         // オブジェクトの生成に失敗していたらエラー
  104.         $className = "Teeple_Filter_" . ucfirst($name);
  105.         $filter = $this->container->getComponent($className);
  106.         if (!is_object($filter)) {
  107.             throw new Teeple_Exception("Filterオブジェクトの生成に失敗しました。({$name})");
  108.         }
  109.         if (is_array($attributes)) {
  110.             $filter->setAttributes($attributes);
  111.         }        
  112.  
  113.         $this->_list[$alias] = $filter;
  114.         $this->_position[] = $alias;
  115.  
  116.         return;
  117.     }
  118.  
  119.     /**
  120.      * FilterChainをクリア
  121.      *
  122.      */
  123.     public function clear() {
  124.  
  125.         $this->_list     = array();
  126.         $this->_position = array();
  127.         $this->_index    = -1;
  128.     }
  129.  
  130.     /**
  131.      * FilterChainの長さを返却
  132.      *
  133.      * @return  integer FilterChainの長さ
  134.      */
  135.     public function getSize() {
  136.         return count($this->_list);
  137.     }
  138.  
  139.     /**
  140.      * FilterChainを組み立てる
  141.      *
  142.      * @param string $configfile 
  143.      */
  144.     public function build($configfile = TEEPLE_FILTER_CONFIG) {
  145.         
  146.         $this->log->debug("FilterChainをセットアップします。");
  147.         
  148.         $config = Teeple_Util::readIniFile($configfile);
  149.         //$this->log->debug(var_export($config, true));
  150.         if (is_array($config)) {
  151.             foreach ($config as $section => $value_ar) {
  152.                 // フィルタ名とエイリアス名を取得
  153.                 $sections = explode(':', $section);
  154.                 $filterName = $sections[0]; // フィルタ名
  155.                 $alias = $filterName;
  156.                 if (isset($sections[1]) && $sections[1]) {
  157.                     $alias = $sections[1]; // エイリアス名
  158.                 }
  159.                 // FilterChainに追加
  160.                 $this->add($filterName, $alias, $value_ar);
  161.             }
  162.         }
  163.         
  164.         // 最後にActionとViewを追加する。
  165.         $this->add('Action');
  166.         $this->add('View');
  167.         
  168.         return;
  169.     }
  170.  
  171.     /**
  172.      * FilterChainの中の次のFilterを実行
  173.      *
  174.      * このメソッドはクラスメソッド
  175.      *
  176.      * @access  public
  177.      * @since   3.0.0
  178.      */
  179.     public function execute() {
  180.  
  181.         if ($this->getSize() < 1) {
  182.             throw new Teeple_Exception("実行するフィルタがありません。");
  183.         }
  184.  
  185.         if ($this->_index < ($this->getSize() - 1)) {
  186.             $this->_index++;
  187.             $name = $this->_position[$this->_index];
  188.             $filter = $this->_list[$name];
  189.             if (!is_object($filter)) {
  190.                 throw new Teeple_Exception("Filterオブジェクトの取得に失敗しました。({$name})");
  191.             }
  192.             $filter->execute();
  193.         }
  194.         
  195.         return;
  196.     }
  197.     
  198.     /**
  199.      * Actionの完了をセットします。
  200.      *
  201.      */
  202.     public function completeAction() {
  203.         $this->request->completeAction();
  204.     }
  205.     
  206.     /**
  207.      * Responseの完了をセットします。
  208.      *
  209.      */
  210.     public function completeResponse() {
  211.         $this->request->completeResponse();
  212.     }
  213.     
  214.     /**
  215.      * Actionが完了したかどうか？
  216.      * @return boolean 
  217.      */
  218.     public function isCompleteAction() {
  219.         return $this->request->isCompleteAction();
  220.     }
  221.     
  222.     /**
  223.      * Responseが完了したかどうか？
  224.      * @return boolean 
  225.      */
  226.     public function isCompleteResponse() {
  227.         return $this->request->isCompleteResponse();
  228.     }
  229.     
  230. }
  231. ?>
Documentation generated on Mon, 26 Apr 2010 08:59:49 +0900 by phpDocumentor 1.4.3