Source for file Ethna_ActionClass.php

Documentation is available at Ethna_ActionClass.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_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$
  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.     /** @var    object  Ethna_Backend       backendオブジェクト */
  27.     var $backend;
  28.  
  29.     /** @var    object  Ethna_Config        設定オブジェクト    */
  30.     var $config;
  31.  
  32.     /** @var    object  Ethna_I18N          i18nオブジェクト */
  33.     var $i18n;
  34.  
  35.     /** @var    object  Ethna_ActionError   アクションエラーオブジェクト */
  36.     var $action_error;
  37.  
  38.     /** @var    object  Ethna_ActionError   アクションエラーオブジェクト(省略形) */
  39.     var $ae;
  40.  
  41.     /** @var    object  Ethna_ActionForm    アクションフォームオブジェクト */
  42.     var $action_form;
  43.  
  44.     /** @var    object  Ethna_ActionForm    アクションフォームオブジェクト(省略形) */
  45.     var $af;
  46.  
  47.     /** @var    object  Ethna_Session       セッションオブジェクト */
  48.     var $session;
  49.  
  50.     /** @var    object  Ethna_Plugin        プラグインオブジェクト */
  51.     var $plugin;
  52.  
  53.     /** @var    object  Ethna_Logger    ログオブジェクト */
  54.     var $logger;
  55.  
  56.     /**#@-*/
  57.  
  58.     /**
  59.      *  Ethna_ActionClassのコンストラクタ
  60.      *
  61.      *  @access public
  62.      *  @param  object  Ethna_Backend   $backend    backendオブジェクト
  63.      */
  64.     function Ethna_ActionClass(&$backend)
  65.     {
  66.         $c =& $backend->getController();
  67.         $this->backend =& $backend;
  68.         $this->config =& $this->backend->getConfig();
  69.         $this->i18n =& $this->backend->getI18N();
  70.  
  71.         $this->action_error =& $this->backend->getActionError();
  72.         $this->ae =& $this->action_error;
  73.  
  74.         $this->action_form =& $this->backend->getActionForm();
  75.         $this->af =& $this->action_form;
  76.  
  77.         $this->session =& $this->backend->getSession();
  78.         $this->plugin =& $this->backend->getPlugin();
  79.         $this->logger =& $this->backend->getLogger();
  80.     }
  81.  
  82.     /**
  83.      *  アクション実行前の認証処理を行う
  84.      *
  85.      *  @access public
  86.      *  @return string  遷移名(nullなら正常終了, falseなら処理終了)
  87.      */
  88.     function authenticate()
  89.     {
  90.         return null;
  91.     }
  92.  
  93.     /**
  94.      *  アクション実行前の処理(フォーム値チェック等)を行う
  95.      *
  96.      *  @access public
  97.      *  @return string  遷移名(nullなら正常終了, falseなら処理終了)
  98.      */
  99.     function prepare()
  100.     {
  101.         return null;
  102.     }
  103.  
  104.     /**
  105.      *  アクション実行
  106.      *
  107.      *  @access public
  108.      *  @return string  遷移名(nullなら遷移は行わない)
  109.      */
  110.     function perform()
  111.     {
  112.         return null;
  113.     }
  114. }
  115. // }}}
  116. ?>

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