Source for file Ethna_Error.php

Documentation is available at Ethna_Error.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_Error.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_error_handler
  13. /**
  14.  *  エラーコールバック関数
  15.  *
  16.  *  @param  int     $errno      エラーレベル
  17.  *  @param  string  $errstr     エラーメッセージ
  18.  *  @param  string  $errfile    エラー発生箇所のファイル名
  19.  *  @param  string  $errline    エラー発生箇所の行番号
  20.  */
  21. function ethna_error_handler($errno, $errstr, $errfile, $errline)
  22. {
  23.     if ($errno === E_STRICT || $errno === E_DEPRECATED
  24.     || ($errno & error_reporting()) === 0) {
  25.         return;
  26.     }
  27.  
  28.     list($level, $name) = Ethna_Logger::errorLevelToLogLevel($errno);
  29.     switch ($errno) {
  30.     case E_ERROR:
  31.     case E_CORE_ERROR:
  32.     case E_COMPILE_ERROR:
  33.     case E_USER_ERROR:
  34.         $php_errno = 'Fatal error'; break;
  35.     case E_WARNING:
  36.     case E_CORE_WARNING:
  37.     case E_COMPILE_WARNING:
  38.     case E_USER_WARNING:
  39.         $php_errno = 'Warning'; break;
  40.     case E_PARSE:
  41.         $php_errno = 'Parse error'; break;
  42.     case E_NOTICE:
  43.     case E_USER_NOTICE:
  44.     case E_STRICT:
  45.     case E_DEPRECATED:
  46.         $php_errno = 'Notice'; break;
  47.     default:
  48.         $php_errno = 'Unknown error'; break;
  49.     }
  50.     $php_errstr = sprintf('PHP %s: %s in %s on line %d',
  51.                           $php_errno, $errstr, $errfile, $errline);
  52.  
  53.     // error_log()
  54.     if (ini_get('log_errors')) {
  55.         $locale = setlocale(LC_TIME, 0);
  56.         setlocale(LC_TIME, 'C');
  57.         error_log($php_errstr, 0);
  58.         setlocale(LC_TIME, $locale);
  59.     }
  60.  
  61.     // $logger->log()
  62.     $c =& Ethna_Controller::getInstance();
  63.     if ($c !== null) {
  64.         $logger =& $c->getLogger();
  65.         $logger->log($level, sprintf("[PHP] %s: %s in %s on line %d",
  66.                                      $name, $errstr, $errfile, $errline));
  67.     }
  68.  
  69.     // printf()
  70.     if (ini_get('display_errors')) {
  71.         $is_debug = true;
  72.         $has_echo = false;
  73.         if ($c !== null) {
  74.             $config =& $c->getConfig();
  75.             $is_debug = $config->get('debug');
  76.             $facility = $logger->getLogFacility();
  77.             $has_echo = is_array($facility)
  78.                         ? in_array('echo', $facility) : $facility === 'echo';
  79.         }
  80.         if ($is_debug == true && $has_echo === false) {
  81.             if ($c !== null && $c->getGateway() === GATEWAY_WWW) {
  82.                 $format = "<b>%s</b>: %s in <b>%s</b> on line <b>%d</b><br />\n";
  83.             } else {
  84.                 $format = "%s: %s in %s on line %d\n";
  85.             }
  86.             printf($format, $php_errno, $errstr, $errfile, $errline);
  87.         }
  88.     }
  89. }
  90. set_error_handler('ethna_error_handler');
  91. // }}}
  92.  
  93. // {{{ ethna_exception_handler
  94.     //  TODO: Implement ethna_exception_handler function.
  95. // }}}
  96.  
  97. // {{{ Ethna_Error
  98. /**
  99.  *  エラークラス
  100.  *
  101.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  102.  *  @access     public
  103.  *  @package    Ethna
  104.  */
  105. class Ethna_Error
  106. {
  107.     /**#@+
  108.      *  @access private
  109.      */
  110.  
  111.     /** @var    object  Ethna_I18N  i18nオブジェクト */
  112.     var $i18n;
  113.  
  114.     /** @var    object  Ethna_Logger    loggerオブジェクト */
  115.     var $logger;
  116.  
  117.     /** @var    string  エラーメッセージ */
  118.     var $message;
  119.  
  120.     /** @var    integer エラーコード */
  121.     var $code;
  122.  
  123.     /** @var    integer エラーモード */
  124.     var $mode;
  125.     
  126.     /** @var    array   エラーモード依存のオプション */
  127.     var $options;
  128.  
  129.     /** @var    string  ユーザー定義もしくはデバッグ関連の追加情報を記した文字列。 */
  130.     var $userinfo;
  131.  
  132.     /**#@-*/
  133.  
  134.     /**
  135.      *  Ethna_Errorクラスのコンストラクタ
  136.      *  $userinfo は第5引数に設定すること。
  137.      *
  138.      *  @access public
  139.      *  @param  string  $message            エラーメッセージ
  140.      *  @param  int     $code               エラーコード
  141.      *  @param  int     $mode               エラーモード(Ethna_Errorはコールバックを
  142.      *                                       常に使用するので実質無視される)
  143.      *  @param  array   $options            エラーモード依存のオプション
  144.      *  @param  array   $userinfo           エラー追加情報($options より後の全ての引数)
  145.      *  @see http://pear.php.net/manual/ja/core.pear.pear-error.pear-error.php
  146.      */
  147.     function Ethna_Error($message = null, $code = null, $mode = null, $options = null)
  148.     {
  149.         $controller =& Ethna_Controller::getInstance();
  150.         if ($controller !== null) {
  151.             $this->i18n =& $controller->getI18N();
  152.         }
  153.  
  154.         // $options 以降の引数 -> $userinfo
  155.         if (func_num_args() > 4) {
  156.             $userinfo = array_slice(func_get_args(), 4);
  157.             if (count($userinfo) == 1) {
  158.                 if (is_array($userinfo[0])) {
  159.                     $this->userinfo = $userinfo[0];
  160.                 } else if (is_null($userinfo[0])) {
  161.                     $this->userinfo = array();
  162.                 }
  163.             } else {
  164.                 $this->userinfo = $userinfo[0];
  165.             }
  166.         } else {
  167.             $this->userinfo = array();
  168.         }
  169.  
  170.         // メッセージ補正処理 ($message)
  171.         if (is_null($message)) {
  172.             // $codeからメッセージを取得する
  173.             $message = $controller->getErrorMessage($code);
  174.             if (is_null($message)) {
  175.                 $message = 'unknown error';
  176.             }
  177.         }
  178.         $this->message = $message;
  179.  
  180.         //  その他メンバ変数設定
  181.         $this->code = $code;
  182.         $this->mode = $mode;
  183.         $this->options = $options; 
  184.         $this->level = ($this->options === NULL) ? E_USER_NOTICE : $options;
  185.  
  186.         //  Ethnaフレームワークのエラーハンドラ(callback)
  187.         Ethna::handleError($this);
  188.     }
  189.  
  190.     /**
  191.      * エラーオブジェクトに関連付けられたエラーコードを返します。
  192.      *
  193.      * @return integer - エラー番号
  194.      */
  195.     function getCode()
  196.     {
  197.         return $this->code;
  198.     }
  199.  
  200.     /**
  201.      *  levelへのアクセサ(R)
  202.      *
  203.      *  @access public
  204.      *  @return int     エラーレベル
  205.      */
  206.     function getLevel()
  207.     {
  208.         return $this->level;
  209.     }
  210.  
  211.     /**
  212.      *  messageへのアクセサ(R)
  213.      *
  214.      *  以下の処理を行う
  215.      *  - エラーメッセージのi18n処理
  216.      *  - $userinfoとして渡されたデータによるvsprintf()処理
  217.      *
  218.      *  @access public
  219.      *  @return string  エラーメッセージ
  220.      */
  221.     function getMessage()
  222.     {
  223.         $tmp_message = $this->i18n ? $this->i18n->get($this->message) : $this->message;
  224.         $tmp_userinfo = to_array($this->userinfo);
  225.         $tmp_message_arg_list = array();
  226.         for ($i = 0; $i < count($tmp_userinfo); $i++) {
  227.             $tmp_message_arg_list[] = $this->i18n ? $this->i18n->get($tmp_userinfo[$i]) : $tmp_userinfo[$i];
  228.         }
  229.         return vsprintf($tmp_message, $tmp_message_arg_list);
  230.     }
  231.  
  232.     /**
  233.      *  エラー追加情報へのアクセサ(R)
  234.      *
  235.      *  エラー追加情報配列の個々のエントリへのアクセスをサポート
  236.      *
  237.      *  @access public
  238.      *  @param  int     $n      エラー追加情報のインデックス(省略可)
  239.      *  @return mixed   message引数
  240.      */
  241.     function getUserInfo($n = null)
  242.     {
  243.         if (is_null($n)) {
  244.             return $this->userinfo;
  245.         }
  246.  
  247.         if (isset($this->userinfo[$n])) {
  248.             return $this->userinfo[$n];
  249.         } else {
  250.             return null;
  251.         }
  252.     }
  253.  
  254.     /**
  255.      *  エラー追加情報へのアクセサ(W)
  256.      *
  257.      *  @access public
  258.      *  @param  string  $info   追加するエラー情報
  259.      */
  260.     function addUserInfo($info)
  261.     {
  262.         $this->userinfo[] = $info;
  263.     }
  264. }
  265. // }}}
  266.  
  267. ?>

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