Source for file ValidatorManager.php

Documentation is available at ValidatorManager.php

  1. <?php
  2. /**
  3.  * Teeple2 - PHP5 Web Application Framework inspired by Seasar2
  4.  *
  5.  * PHP versions 5
  6.  *
  7.  * LICENSE: This source file is subject to version 3.0 of the PHP license
  8.  * that is available through the world-wide-web at the following URI:
  9.  * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
  10.  * the PHP License and are unable to obtain it through the web, please
  11.  * send a note to license@php.net so we can mail you a copy immediately.
  12.  *
  13.  * @package     teeple
  14.  * @author      Mitsutaka Sato <miztaka@gmail.com>
  15.  * @license     http://www.php.net/license/3_0.txt  PHP License 3.0
  16.  */
  17.  
  18. /**
  19.  * フォームセットのバリデーションを実行します。
  20.  * 
  21.  * <pre>
  22.  * ■configの仕様:
  23.  *   array(
  24.  *       array(
  25.  *           'name' => 'フィールド名', // 必須
  26.  *           'label' => 'ラベル名',    // 任意
  27.  *           'validation' => array(
  28.  *               'Validator名' => array(
  29.  *                   '設定1' => '設定値1',
  30.  *                   '設定2' => '設定値2',
  31.  *                   ....
  32.  *               ),
  33.  *               ....
  34.  *           ),
  35.  *       ),
  36.  *       ....
  37.  *   )
  38.  *  
  39.  * ■エラーメッセージについて
  40.  * 
  41.  * </pre>
  42.  * 
  43.  *
  44.  * @package teeple
  45.  */
  46. class Teeple_ValidatorManager
  47. {
  48.     
  49.     const DEFAULT_MESSAGE = '{0}が正しく入力されていません。';
  50.  
  51.     /**
  52.      * @var Logger 
  53.      */
  54.     protected $log;
  55.     
  56.     /**
  57.      * @var Teeple_Request 
  58.      */
  59.     private $request;
  60.     public function setComponent_Teeple_Request($c) {
  61.         $this->request = $c;
  62.     }
  63.     
  64.     /**
  65.      * @var Teeple_Resource 
  66.      */
  67.     private $resource;
  68.     public function setComponent_Teeple_Resource($c) {
  69.         $this->resource = $c;
  70.     }
  71.     
  72.     /**
  73.      * @var Teeple_Container 
  74.      */
  75.     private $container;
  76.     public function setComponent_container($c) {
  77.         $this->container = $c;
  78.     }
  79.     
  80.     /**
  81.      * コンストラクタ
  82.      *
  83.      */
  84.     public function __construct() {
  85.         $this->log = LoggerManager::getLogger(get_class($this));
  86.     }
  87.     
  88.     /**
  89.      * YAML形式の設定をパースします。
  90.      * @param $yaml YAML形式の文字列
  91.      * @return array config
  92.      */
  93.     public function parseYAML($yaml) {
  94.         
  95.         $yamlConfig = Horde_Yaml::load($yaml);
  96.         if (! is_array($yamlConfig)) {
  97.             throw new Teeple_Exception("Validationの設定を解析できませんでした。");
  98.         }
  99.         //$this->log->debug(var_export($yamlConfig, true));
  100.         
  101.         $validationConfig = array();
  102.         foreach($yamlConfig as $field => $validations) {
  103.             $oneConfig = array();
  104.             $fields = explode('.',$field, 2);
  105.             if (count($fields) == 2) {
  106.                 $oneConfig['label'] = $fields[1];
  107.             }
  108.             $oneConfig['name'] = $fields[0];
  109.             $oneConfig['validation'] = $validations;
  110.             
  111.             array_push($validationConfig, $oneConfig);
  112.         }
  113.         //$this->log->debug(var_export($validationConfig, true));
  114.         
  115.         return $validationConfig;
  116.     }
  117.         
  118.     /**
  119.      * 指定されたconfigでバリデーションを実行します。
  120.      * エラーがあった場合はエラーメッセージを組み立てて
  121.      * Requestにメッセージを追加します。
  122.      *
  123.      * @param object $obj 
  124.      * @param array $config 
  125.      * @return boolean 
  126.      */
  127.     public function execute($obj, &$config) {
  128.         
  129.         $result = TRUE;
  130.         foreach($config as $fieldConfig) {
  131.             $fieldName = $fieldConfig['name'];
  132.             foreach($fieldConfig['validation'] as $validatorName => $attr) {
  133.                 
  134.                 // Validatorインスタンスを作成
  135.                 $validator = $this->container->getPrototype("Teeple_Validator_". ucfirst($validatorName));
  136.                 if (! is_object($validator)) {
  137.                     throw new Teeple_Exception("Validatorのインスタンスを作成できません。($validatorName)");
  138.                 }
  139.                 // 属性をセット
  140.                 foreach($attr as $key => $value) {
  141.                     $validator->$key = $value;
  142.                 }
  143.                 // Validatorを実行
  144.                 if (! $validator->validate($obj, $fieldName)) {
  145.                     $result = FALSE;
  146.                     // エラーメッセージをセット
  147.                     $this->setErrorMessage($validator, $validatorName, $attr, $fieldConfig);
  148.                     break;
  149.                 }
  150.             }
  151.         }
  152.         return $result;
  153.     }
  154.     
  155.     /**
  156.      * エラーメッセージをセットします。
  157.      *
  158.      * @param Teeple_Validator $validator 
  159.      * @param string $validatorName 
  160.      * @param array $validatorConfig 
  161.      * @param array $fieldConfig 
  162.      */
  163.     private function setErrorMessage($validator, $validatorName, &$validatorConfig, &$fieldConfig) {
  164.         
  165.         // メッセージとラベルの取得
  166.         $msg = $this->getMessage($validatorName, $validatorConfig);
  167.         $label = $this->getLabel($fieldConfig);
  168.         
  169.         // パラメータを準備
  170.         $param = array();
  171.         // {0}は必ずラベル名
  172.         array_push($param, $label);
  173.         foreach($validator->args as $propName) {
  174.             array_push($param, $validator->$propName);
  175.         }
  176.         
  177.         // メッセージをフォーマットしてセット
  178.         $errorMessage = Teeple_Util::formatErrorMessage($msg, $param);
  179.         $this->request->addErrorMessage($errorMessage, $fieldConfig['name']);
  180.         return;
  181.     }
  182.     
  183.     /**
  184.      * エラーメッセージを取得します。
  185.      *
  186.      * @param string $validatorName 
  187.      * @param array $validatorConfig 
  188.      * @return string 
  189.      */
  190.     private function getMessage($validatorName, &$validatorConfig) {
  191.         
  192.         if (isset($validatorConfig['msg']) && ! Teeple_Util::isBlank($validatorConfig['msg'])) {
  193.             return $validatorConfig['msg'];
  194.         }
  195.         $msg = $this->resource->getResource('errors.'. $validatorName);
  196.         if (Teeple_Util::isBlank($msg)) {
  197.             $msg = self::DEFAULT_MESSAGE;
  198.         }
  199.         return $msg;
  200.     }
  201.     
  202.     /**
  203.      * ラベル名を取得します。
  204.      *
  205.      * @param array $fieldConfig 
  206.      * @return string 
  207.      */
  208.     private function getLabel(&$fieldConfig) {
  209.         
  210.         if (isset($fieldConfig['label']) && ! Teeple_Util::isBlank($fieldConfig['label'])) {
  211.             return $fieldConfig['label'];
  212.         }
  213.         $label = $this->resource->getResource('form.'. $fieldConfig['name']);
  214.         if (Teeple_Util::isBlank($label)) {
  215.             $label = $fieldConfig['name'];
  216.         }
  217.         return $label;
  218.     }
  219.     
  220. }
  221. ?>
Documentation generated on Mon, 26 Apr 2010 09:00:04 +0900 by phpDocumentor 1.4.3