Source for file Ethna_Plugin_Validator.php

Documentation is available at Ethna_Plugin_Validator.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_Plugin_Validator.php
  5.  *
  6.  *  @author     ICHII Takashi <ichii386@schweetheart.jp>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id$
  10.  */
  11.  
  12. // UPLOAD_ERR_* が未定義の場合 (PHP 4.3.0 以前)
  13. if (defined('UPLOAD_ERR_OK') == false) {
  14.     define('UPLOAD_ERR_OK', 0);
  15. }
  16.  
  17. // {{{ Ethna_Plugin_Validator
  18. /**
  19.  *  バリデータプラグインの基底クラス
  20.  *  
  21.  *  @author     ICHII Takashi <ichii386@schweetheart.jp>
  22.  *  @access     public
  23.  *  @package    Ethna
  24.  */
  25. class Ethna_Plugin_Validator
  26. {
  27.     /**#@+
  28.      *  @access private
  29.      */
  30.  
  31.     /** @var    object  Ethna_Backend   backendオブジェクト */
  32.     var $backend;
  33.  
  34.     /** @var    object  Ethna_Logger    ログオブジェクト */
  35.     var $logger;
  36.  
  37.     /** @var    object  Ethna_ActionForm    フォームオブジェクト */
  38.     var $action_form;
  39.  
  40.     /** @var    object  Ethna_ActionForm    フォームオブジェクト */
  41.     var $af;
  42.  
  43.     /** @var    bool    配列を受け取るバリデータかどうかのフラグ */
  44.     var $accept_array = false;
  45.  
  46.     /**#@-*/
  47.  
  48.     /**
  49.      *  コンストラクタ
  50.      *
  51.      *  @access public
  52.      *  @param  object  Ethna_Controller    $controller コントローラオブジェクト
  53.      */
  54.     function Ethna_Plugin_Validator(&$controller)
  55.     {
  56.         $this->backend =& $controller->getBackend();
  57.         $this->logger =& $controller->getLogger();
  58.         $this->action_form =& $controller->getActionForm();
  59.         $this->af =& $this->action_form;
  60.     }
  61.  
  62.     /**
  63.      *  フォーム値検証のためにActionFormから呼び出されるメソッド
  64.      *
  65.      *  @access public
  66.      *  @param  string  $name       フォームの名前
  67.      *  @param  mixed   $var        フォームの値
  68.      *  @param  array   $params     プラグインのパラメータ
  69.      */
  70.     function &validate($name, $var, $params)
  71.     {
  72.         die('override!');
  73.     }
  74.  
  75.     /**
  76.      *  フォーム定義を取得する
  77.      *
  78.      *  @access public
  79.      *  @param  string  $name       フォームの名前
  80.      */
  81.     function getFormDef($name)
  82.     {
  83.         return $this->af->getDef($name);
  84.     }
  85.  
  86.     /**
  87.      *  フォームのtypeを取得する(配列の場合は値のみ)
  88.      *
  89.      *  @access public
  90.      *  @param  string  $name       フォームの名前
  91.      */
  92.     function getFormType($name)
  93.     {
  94.         $def = $this->af->getDef($name);
  95.         if (isset($def['type'])) {
  96.             if (is_array($def['type'])) {
  97.                 return $def['type'][0];
  98.             } else {
  99.                 return $def['type'];
  100.             }
  101.         } else {
  102.             return null;
  103.         }
  104.     }
  105.  
  106.     /**
  107.      *  フォーム値が空かどうかを判定 (配列フォームの場合は各要素に対して呼び出す)
  108.      *
  109.      *  @access protected
  110.      *  @param  mixed   $var       フォームの値 (配列フォームの場合は各要素)
  111.      *  @param  int     $type      フォームのtype
  112.      */
  113.     function isEmpty($var, $type)
  114.     {
  115.         if ($type == VAR_TYPE_FILE) {
  116.             if (isset($var['error']) == false || $var['error'] != UPLOAD_ERR_OK) {
  117.                 return true;
  118.             }
  119.             if (isset($var['tmp_name']) == false || is_uploaded_file($var['tmp_name']) == false) {
  120.                 return true;
  121.             }
  122.             if (isset($var['size']) == false || $var['size'] == 0) {
  123.                 return true;
  124.             }
  125.         } else {
  126.             if (is_scalar($var) == false || strlen($var) == 0) {
  127.                 return true;
  128.             }
  129.         }
  130.         return false;
  131.     }
  132.  
  133.     /**
  134.      *  true を参照で返す
  135.      *
  136.      *  @access protected
  137.      */
  138.     function &ok()
  139.     {
  140.         $true = true;
  141.         return $true;
  142.     }
  143.  
  144.     /**
  145.      *  エラーを返す
  146.      *
  147.      *  @access protected
  148.      *  @param  string  $msg        エラーメッセージ
  149.      *  @param  int     $code       エラーコード
  150.      *  @param  mixed   $info       エラーメッセージにsprintfで渡すパラメータ
  151.      */
  152.     function &error($msg, $code, $info = null)
  153.     {
  154.         if ($info != null) {
  155.             if (is_array($info)) {
  156.                 return Ethna::raiseNotice($msg, $code, $info);
  157.             } else {
  158.                 return Ethna::raiseNotice($msg, $code, array($info));
  159.             }
  160.         } else {
  161.             return Ethna::raiseNotice($msg, $code);
  162.         }
  163.     }
  164. }
  165. // }}}
  166. ?>

Documentation generated on Fri, 11 Nov 2011 04:00:39 +0900 by phpDocumentor 1.4.3