class/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     /**#@-*/
  54
  55     /**
  56      *  Ethna_ActionClass¤Î¥³¥ó¥¹¥È¥é¥¯¥¿
  57      *
  58      *  @access public
  59      *  @param  object  Ethna_Backend   $backend    backend¥ª¥Ö¥¸¥§¥¯¥È
  60      */
  61     function Ethna_ActionClass(&$backend)
  62     {
  63         $c =& $backend->getController();
  64         $this->backend =& $backend;
  65         $this->config =& $this->backend->getConfig();
  66         $this->i18n =& $this->backend->getI18N();
  67
  68         $this->action_error =& $this->backend->getActionError();
  69         $this->ae =& $this->action_error;
  70
  71         $this->action_form =& $this->backend->getActionForm();
  72         $this->af =& $this->action_form;
  73
  74         $this->session =& $this->backend->getSession();
  75         $this->plugin =& $this->backend->getPlugin();
  76     }
  77
  78     /**
  79      *  ¥¢¥¯¥·¥ç¥ó¼Â¹ÔÁ°¤ÎÇ§¾Ú½èÍý¤ò¹Ô¤¦
  80      *
  81      *  @access public
  82      *  @return string  Á«°ÜÌ¾(null¤Ê¤éÀµ¾ï½ªÎ», false¤Ê¤é½èÍý½ªÎ»)
  83      */
  84     function authenticate()
  85     {
  86         return null;
  87     }
  88
  89     /**
  90      *  ¥¢¥¯¥·¥ç¥ó¼Â¹ÔÁ°¤Î½èÍý(¥Õ¥©¡¼¥àÃÍ¥Á¥§¥Ã¥¯Åù)¤ò¹Ô¤¦
  91      *
  92      *  @access public
  93      *  @return string  Á«°ÜÌ¾(null¤Ê¤éÀµ¾ï½ªÎ», false¤Ê¤é½èÍý½ªÎ»)
  94      */
  95     function prepare()
  96     {
  97         return null;
  98     }
  99
 100     /**
 101      *  ¥¢¥¯¥·¥ç¥ó¼Â¹Ô
 102      *
 103      *  @access public
 104      *  @return string  Á«°ÜÌ¾(null¤Ê¤éÁ«°Ü¤Ï¹Ô¤ï¤Ê¤¤)
 105      */
 106     function perform()
 107     {
 108         return null;
 109     }
 110 }
 111 // }}}
 112 ?>