Source for file ActionClass.php

Documentation is available at ActionClass.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  ActionClass.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: fe3fef6769eb39580c681736db08e0f2cbbbed01 $
  10.  */
  11.  
  12. // {{{ Ethna_ActionClass
  13. /**
  14.  *  action実行クラス
  15.  *
  16.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  17.  *  @access     public
  18.  *  @package    Ethna
  19.  */
  20. class Ethna_ActionClass
  21. {
  22.     /**#@+
  23.      *  @access private
  24.      */
  25.  
  26.     /** @protected    object  Ethna_Backend       backendオブジェクト */
  27.     protected $backend;
  28.  
  29.     /** @protected    object  Ethna_Config        設定オブジェクト    */
  30.     protected $config;
  31.  
  32.     /** @protected    object  Ethna_I18N          i18nオブジェクト */
  33.     protected $i18n;
  34.  
  35.     /** @protected    object  Ethna_ActionError   アクションエラーオブジェクト */
  36.     protected $action_error;
  37.  
  38.     /** @protected    object  Ethna_ActionError   アクションエラーオブジェクト(省略形) */
  39.     protected $ae;
  40.  
  41.     /** @protected    object  Ethna_ActionForm    アクションフォームオブジェクト */
  42.     protected $action_form;
  43.  
  44.     /** @protected    object  Ethna_ActionForm    アクションフォームオブジェクト(省略形) */
  45.     protected $af;
  46.  
  47.     /** @protected    object  Ethna_Session       セッションオブジェクト */
  48.     protected $session;
  49.  
  50.     /** @public    object  Ethna_Plugin        プラグインオブジェクト */
  51.     public $plugin;
  52.  
  53.     /** @protected    object  Ethna_Logger    ログオブジェクト */
  54.     protected $logger;
  55.  
  56.     /** @protected    array   Preload plugins definition  */
  57.     protected $plugins = array();
  58.  
  59.     /**#@-*/
  60.  
  61.     /**
  62.      *  Ethna_ActionClassのコンストラクタ
  63.      *
  64.      *  @access public
  65.      *  @param  object  Ethna_Backend   $backend    backendオブジェクト
  66.      */
  67.     public function __construct($backend)
  68.     {
  69.         $c = $backend->getController();
  70.         $this->backend = $backend;
  71.         $this->config = $this->backend->getConfig();
  72.         $this->i18n = $this->backend->getI18N();
  73.  
  74.         $this->action_error = $this->backend->getActionError();
  75.         $this->ae = $this->action_error;
  76.  
  77.         $this->action_form = $this->backend->getActionForm();
  78.         $this->af = $this->action_form;
  79.  
  80.         $this->session = $this->backend->getSession();
  81.         $this->plugin = $this->backend->getPlugin();
  82.         $this->logger = $this->backend->getLogger();
  83.  
  84.         $this->preloadPlugin();
  85.     }
  86.  
  87.     /**
  88.      *  アクション実行前の認証処理を行う
  89.      *
  90.      *  @access public
  91.      *  @return string  遷移名(nullなら正常終了, falseなら処理終了)
  92.      */
  93.     public function authenticate()
  94.     {
  95.         return null;
  96.     }
  97.  
  98.     /**
  99.      *  アクション実行前の処理(フォーム値チェック等)を行う
  100.      *
  101.      *  @access public
  102.      *  @return string  遷移名(nullなら正常終了, falseなら処理終了)
  103.      */
  104.     public function prepare()
  105.     {
  106.         return null;
  107.     }
  108.  
  109.     /**
  110.      *  アクション実行
  111.      *
  112.      *  @access public
  113.      *  @return string  遷移名(nullなら遷移は行わない)
  114.      */
  115.     public function perform()
  116.     {
  117.         return null;
  118.     }
  119.  
  120.     /**
  121.      *  get plugin object
  122.      *
  123.      *  @access protected
  124.      */
  125.     protected function preloadPlugin()
  126.     {
  127.         foreach ($this->plugins as $alias => $plugin) {
  128.             $plugin_alias = $alias;
  129.             if (is_int($alias)) {
  130.                 $plugin_alias = $plugin;
  131.             }
  132.  
  133.             $plugin_name = explode('_', $plugin);
  134.             if (count($plugin_name) === 1) {
  135.                 $plugin_alias[] = null;
  136.             }
  137.  
  138.             $this->plugin->setPlugin($plugin_alias, $plugin_name);
  139.         }
  140.     }
  141. }
  142. // }}}

Documentation generated on Fri, 11 Nov 2011 03:57:16 +0900 by phpDocumentor 1.4.3