Source for file Ethna_Plugin_Filter.php

Documentation is available at Ethna_Plugin_Filter.php

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

Documentation generated on Thu, 08 May 2008 00:15:06 +0900 by phpDocumentor 1.4.2