Source for file ActionError.php

Documentation is available at ActionError.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  ActionError.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: 614dea2d18a9f551b3b71346ac34785c6d308c70 $
  10.  */
  11.  
  12. // {{{ Ethna_ActionError
  13. /**
  14.  *  アプリケーションエラー管理クラス
  15.  *
  16.  *  @access     public
  17.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  18.  *  @package    Ethna
  19.  *  @todo   配列フォームを扱えるようにする
  20.  */
  21. class Ethna_ActionError
  22. {
  23.     /**#@+
  24.      *  @access private
  25.      */
  26.  
  27.     /** @protected    array   エラーオブジェクトの一覧 */
  28.     protected $error_list = array();
  29.  
  30.     /** @protected    object  Ethna_ActionForm    アクションフォームオブジェクト */
  31.     protected $action_form = null;
  32.  
  33.     /** @protected    object  Ethna_Logger        ログオブジェクト */
  34.     protected $logger = null;
  35.     /**#@-*/
  36.  
  37.     /**
  38.      *  Ethna_ActionErrorクラスのコンストラクタ
  39.      *
  40.      *  @access public
  41.      */
  42.     public function __construct()
  43.     {
  44.     }
  45.  
  46.     /**
  47.      *  エラーオブジェクトを生成/追加する
  48.      *
  49.      *  @access public
  50.      *  @param  string  $name       エラーの発生したフォーム項目名(不要ならnull)
  51.      *  @param  string  $message    エラーメッセージ
  52.      *  @param  int     $code       エラーコード
  53.      *  @return Ethna_Error エラーオブジェクト
  54.      */
  55.     public function add($name, $message, $code = null)
  56.     {
  57.         if (func_num_args() > 3) {
  58.             $userinfo = array_slice(func_get_args(), 3);
  59.             $error = Ethna::raiseNotice($message, $code, $userinfo);
  60.         } else {
  61.             $error = Ethna::raiseNotice($message, $code);
  62.         }
  63.         $this->addObject($name, $error);
  64.         return $error;
  65.     }
  66.  
  67.     /**
  68.      *  Ethna_Errorオブジェクトを追加する
  69.      *
  70.      *  @access public
  71.      *  @param  string              $name   エラーに対応するフォーム項目名(不要ならnull)
  72.      *  @param  object  Ethna_Error $error  エラーオブジェクト
  73.      */
  74.     public function addObject($name, $error)
  75.     {
  76.         $elt = array();
  77.         $elt['name'] = $name;
  78.         $elt['object'] = $error;
  79.         $this->error_list[] = $elt;
  80.  
  81.         // ログ出力(補足)
  82.         $af = $this->_getActionForm();
  83.         $logger = $this->_getLogger();
  84.         $logger->log(LOG_NOTICE, '{form} -> [%s]', $this->action_form->getName($name));
  85.     }
  86.  
  87.     /**
  88.      *  エラーオブジェクトの数を返す
  89.      *
  90.      *  @access public
  91.      *  @return int     エラーオブジェクトの数
  92.      */
  93.     public function count()
  94.     {
  95.         return count($this->error_list);
  96.     }
  97.  
  98.     /**
  99.      *  エラーオブジェクトの数を返す(count()メソッドのエイリアス)
  100.      *
  101.      *  @access public
  102.      *  @return int     エラーオブジェクトの数
  103.      */
  104.     public function length()
  105.     {
  106.         return count($this->error_list);
  107.     }
  108.  
  109.     /**
  110.      *  登録されたエラーオブジェクトを全て削除する
  111.      *
  112.      *  @access public
  113.      */
  114.     public function clear()
  115.     {
  116.         $this->error_list = array();
  117.     }
  118.  
  119.     /**
  120.      *  指定されたフォーム項目にエラーが発生しているかどうかを返す
  121.      *
  122.      *  @access public
  123.      *  @param  string  $name   フォーム項目名
  124.      *  @return bool    true:エラーが発生している false:エラーが発生していない
  125.      */
  126.     public function isError($name)
  127.     {
  128.         foreach ($this->error_list as $error) {
  129.             if (strcasecmp($error['name'], $name) == 0) {
  130.                 return true;
  131.             }
  132.         }
  133.         return false;
  134.     }
  135.  
  136.     /**
  137.      *  指定されたフォーム項目に対応するエラーメッセージを返す
  138.      *
  139.      *  @access public
  140.      *  @param  string  $name   フォーム項目名
  141.      *  @return string  エラーメッセージ(エラーが無い場合はnull)
  142.      */
  143.     function getMessage($name)
  144.     {
  145.         foreach ($this->error_list as $error) {
  146.             if (strcasecmp($error['name'], $name) == 0) {
  147.                 return $this->_getMessage($error);
  148.             }
  149.         }
  150.         return null;
  151.     }
  152.  
  153.     /**
  154.      *  エラーオブジェクトを配列にして返す
  155.      *
  156.      *  @access public
  157.      *  @return array   エラーオブジェクトの配列
  158.      */
  159.     function getErrorList()
  160.     {
  161.         return $this->error_list;
  162.     }
  163.  
  164.     /**
  165.      *  エラーメッセージを配列にして返す
  166.      *
  167.      *  @access public
  168.      *  @return array   エラーメッセージの配列
  169.      */
  170.     function getMessageList()
  171.     {
  172.         $message_list = array();
  173.  
  174.         foreach ($this->error_list as $error) {
  175.             $message_list[] = $this->_getMessage($error);
  176.         }
  177.         return $message_list;
  178.     }
  179.  
  180.     /**
  181.      *  アプリケーションエラーメッセージを取得する
  182.      *
  183.      *  @access private
  184.      *  @param  array   エラーエントリ
  185.      *  @return string  エラーメッセージ
  186.      */
  187.     function _getMessage(&$error)
  188.     {
  189.         $af = $this->_getActionForm();
  190.         $form_name = $af->getName($error['name']);
  191.         return str_replace("{form}", $form_name, $error['object']->getMessage());
  192.     }
  193.  
  194.     /**
  195.      *  Ethna_ActionFormオブジェクトを取得する
  196.      *
  197.      *  @access private
  198.      *  @return object  Ethna_ActionForm 
  199.      */
  200.     private function _getActionForm()
  201.     {
  202.         if (isset($this->action_form) == false) {
  203.             $controller = Ethna_Controller::getInstance();
  204.             $this->action_form = $controller->getActionForm();
  205.         }
  206.         return $this->action_form;
  207.     }
  208.  
  209.     /**
  210.      *  Ethna_Loggerオブジェクトを取得する
  211.      *
  212.      *  @access private
  213.      *  @return object  Ethna_Logger 
  214.      */
  215.     private function _getLogger()
  216.     {
  217.         if (is_null($this->logger)) {
  218.             $controller = Ethna_Controller::getInstance();
  219.             $this->logger = $controller->getLogger();
  220.         }
  221.         return $this->logger;
  222.     }
  223. }
  224. // }}}

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