Source for file Filter.php

Documentation is available at Filter.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Filter.php
  5.  *
  6.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id: e882f25f52bd6ce41075ec92ff41c1f9bc8dc610 $
  10.  */
  11.  
  12. // {{{ Ethna_Filter
  13. /**
  14.  *  フレームワークのフィルタ基底クラス
  15.  *
  16.  *  Mojaviの真似です（きっぱり）。アクション実行前に各種処理を行うことが
  17.  *  出来ます。
  18.  *
  19.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  20.  *  @access     public
  21.  *  @package    Ethna
  22.  *  @obsolete
  23.  */
  24. class Ethna_Filter
  25. {
  26.     /**#@+
  27.      *  @access private
  28.      */
  29.  
  30.     /** @protected    object  Ethna_Controller    controllerオブジェクト */
  31.     protected $controller;
  32.  
  33.     /** @protected    object  Ethna_Controller    controllerオブジェクト($controllerの省略形) */
  34.     protected $ctl;
  35.  
  36.     /** @protected    object  Ethna_Config        設定オブジェクト */
  37.     protected $config;
  38.  
  39.     /** @protected    object  Ethna_Logger        ログオブジェクト */
  40.     protected $logger;
  41.  
  42.     /**#@-*/
  43.  
  44.  
  45.     /**
  46.      *  Ethna_Filterのコンストラクタ
  47.      *
  48.      *  @access public
  49.      *  @param  object  Ethna_Controller    &$controller    コントローラオブジェクト
  50.      */
  51.     public function __construct(&$controller)
  52.     {
  53.         // オブジェクトの設定
  54.         $this->controller = $controller;
  55.         $this->ctl = $this->controller;
  56.  
  57.         $this->config = $controller->getConfig();
  58.         $this->logger = $this->controller->getLogger();
  59.     }
  60.  
  61.     /**
  62.      *  実行前フィルタ
  63.      *
  64.      *  @access public
  65.      *  @return Ethna_Error:実行中止 any:正常終了
  66.      */
  67.     function preFilter()
  68.     {
  69.     }
  70.  
  71.     /**
  72.      *  アクション実行前フィルタ
  73.      *
  74.      *  @access public
  75.      *  @param  string  $action_name    実行されるアクション名
  76.      *  @return string  null:正常終了 (string):実行するアクション名を変更
  77.      */
  78.     function preActionFilter($action_name)
  79.     {
  80.         return null;
  81.     }
  82.  
  83.     /**
  84.      *  アクション実行後フィルタ
  85.      *
  86.      *  @access public
  87.      *  @param  string  $action_name    実行されたアクション名
  88.      *  @param  string  $forward_name   実行されたアクションからの戻り値
  89.      *  @return string  null:正常終了 (string):遷移名を変更
  90.      */
  91.     function postActionFilter($action_name, $forward_name)
  92.     {
  93.         return null;
  94.     }
  95.  
  96.     /**
  97.      *  実行後フィルタ
  98.      *
  99.      *  @access public
  100.      *  @return Ethna_Error:実行中止 any:正常終了
  101.      */
  102.     function postFilter()
  103.     {
  104.     }
  105. }
  106. // }}}

Documentation generated on Fri, 11 Nov 2011 03:58:08 +0900 by phpDocumentor 1.4.3