Source for file Filter.php

Documentation is available at Filter.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  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: ea7917f1639ee89ee24c416f72f9b8cd3bca1a9d $
  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 extends Ethna_Plugin_Abstract
  27. {
  28.     /**
  29.      *  実行前フィルタ
  30.      *
  31.      *  @access public
  32.      *  @return Ethna_Error:実行中止 any:正常終了
  33.      */
  34.     public function preFilter()
  35.     {
  36.     }
  37.  
  38.     /**
  39.      *  アクション実行前フィルタ
  40.      *
  41.      *  @access public
  42.      *  @param  string  $action_name    実行されるアクション名
  43.      *  @return string  null:正常終了 (string):実行するアクション名を変更
  44.      */
  45.     public function preActionFilter($action_name)
  46.     {
  47.         return null;
  48.     }
  49.  
  50.     /**
  51.      *  アクション実行後フィルタ
  52.      *
  53.      *  @access public
  54.      *  @param  string  $action_name    実行されたアクション名
  55.      *  @param  string  $forward_name   実行されたアクションからの戻り値
  56.      *  @return string  null:正常終了 (string):遷移名を変更
  57.      */
  58.     public function postActionFilter($action_name, $forward_name)
  59.     {
  60.         return null;
  61.     }
  62.  
  63.     /**
  64.      *  実行後フィルタ
  65.      *
  66.      *  @access public
  67.      *  @return Ethna_Error:実行中止 any:正常終了
  68.      */
  69.     public function postFilter()
  70.     {
  71.     }
  72. }
  73. // }}}

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