HTML_QuickForm
[ class tree: HTML_QuickForm ] [ index: HTML_QuickForm ] [ all elements ]

Source for file RuleRegistry.php

Documentation is available at RuleRegistry.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3.  
  4. /**
  5.  * Registers rule objects and uses them for validation
  6.  * 
  7.  * PHP versions 4 and 5
  8.  *
  9.  * LICENSE: This source file is subject to version 3.01 of the PHP license
  10.  * that is available through the world-wide-web at the following URI:
  11.  * http://www.php.net/license/3_01.txt If you did not receive a copy of
  12.  * the PHP License and are unable to obtain it through the web, please
  13.  * send a note to license@php.net so we can mail you a copy immediately.
  14.  *
  15.  * @category    HTML
  16.  * @package     HTML_QuickForm
  17.  * @author      Adam Daniel <adaniel1@eesus.jnj.com>
  18.  * @author      Bertrand Mansion <bmansion@mamasam.com>
  19.  * @author      Alexey Borzov <avb@php.net>
  20.  * @copyright   2001-2011 The PHP Group
  21.  * @license     http://www.php.net/license/3_01.txt PHP License 3.01
  22.  * @version     CVS: $Id: RuleRegistry.php 317587 2011-10-01 07:55:53Z avb $
  23.  * @link        http://pear.php.net/package/HTML_QuickForm
  24.  */
  25.  
  26. /**
  27.  * Registers rule objects and uses them for validation
  28.  *
  29.  * @category    HTML
  30.  * @package     HTML_QuickForm
  31.  * @author      Adam Daniel <adaniel1@eesus.jnj.com>
  32.  * @author      Bertrand Mansion <bmansion@mamasam.com>
  33.  * @author      Alexey Borzov <avb@php.net>
  34.  * @version     Release: 3.2.13
  35.  * @since       3.2
  36.  */
  37. {
  38.     /**
  39.      * Array containing references to used rules
  40.      * @var     array 
  41.      * @access  private
  42.      */
  43.     var $_rules = array();
  44.  
  45.  
  46.     /**
  47.      * Returns a singleton of HTML_QuickForm_RuleRegistry
  48.      *
  49.      * Usually, only one RuleRegistry object is needed, this is the reason
  50.      * why it is recommended to use this method to get the validation object.
  51.      *
  52.      * @access    public
  53.      * @static
  54.      * @return    HTML_QuickForm_RuleRegistry 
  55.      */
  56.     function &singleton()
  57.     {
  58.         static $obj;
  59.         if (!isset($obj)) {
  60.             $obj = new HTML_QuickForm_RuleRegistry();
  61.         }
  62.         return $obj;
  63.     // end func singleton
  64.  
  65.     /**
  66.      * Registers a new validation rule
  67.      *
  68.      * In order to use a custom rule in your form, you need to register it
  69.      * first. For regular expressions, one can directly use the 'regex' type
  70.      * rule in addRule(), this is faster than registering the rule.
  71.      *
  72.      * Functions and methods can be registered. Use the 'function' type.
  73.      * When registering a method, specify the class name as second parameter.
  74.      *
  75.      * You can also register an HTML_QuickForm_Rule subclass with its own
  76.      * validate() method.
  77.      *
  78.      * @param     string    $ruleName   Name of validation rule
  79.      * @param     string    $type       Either: 'regex', 'function' or null
  80.      * @param     string    $data1      Name of function, regular expression or
  81.      *                                   HTML_QuickForm_Rule object class name
  82.      * @param     string    $data2      Object parent of above function or HTML_QuickForm_Rule file path
  83.      * @access    public
  84.      * @return    void 
  85.      */
  86.     function registerRule($ruleName$type$data1$data2 = null)
  87.     {
  88.         $type strtolower($type);
  89.         if ($type == 'regex'{
  90.             // Regular expression
  91.             $rule =$this->getRule('regex');
  92.             $rule->addData($ruleName$data1);
  93.             $GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName$GLOBALS['_HTML_QuickForm_registered_rules']['regex'];
  94.  
  95.         elseif ($type == 'function' || $type == 'callback'{
  96.             // Callback function
  97.             $rule =$this->getRule('callback');
  98.             $rule->addData($ruleName$data1$data2'function' == $type);
  99.             $GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName$GLOBALS['_HTML_QuickForm_registered_rules']['callback'];
  100.  
  101.         elseif (is_object($data1)) {
  102.             // An instance of HTML_QuickForm_Rule
  103.             $this->_rules[strtolower(get_class($data1))$data1;
  104.             $GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName= array(strtolower(get_class($data1))null);
  105.  
  106.         else {
  107.             // Rule class name
  108.             $GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName= array(strtolower($data1)$data2);
  109.         }
  110.     // end func registerRule
  111.  
  112.     /**
  113.      * Returns a reference to the requested rule object
  114.      *
  115.      * @param     string   $ruleName        Name of the requested rule
  116.      * @access    public
  117.      * @return    HTML_QuickForm_Rule 
  118.      */
  119.     function &getRule($ruleName)
  120.     {
  121.         list($class$path$GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName];
  122.  
  123.         if (!isset($this->_rules[$class])) {
  124.             if (!empty($path)) {
  125.                 include_once($path);
  126.             }
  127.             $this->_rules[$class=new $class();
  128.         }
  129.         $this->_rules[$class]->setName($ruleName);
  130.         return $this->_rules[$class];
  131.     // end func getRule
  132.  
  133.     /**
  134.      * Performs validation on the given values
  135.      *
  136.      * @param     string   $ruleName        Name of the rule to be used
  137.      * @param     mixed    $values          Can be a scalar or an array of values
  138.      *                                       to be validated
  139.      * @param     mixed    $options         Options used by the rule
  140.      * @param     mixed    $multiple        Whether to validate an array of values altogether
  141.      * @access    public
  142.      * @return    mixed    true if no error found, int of valid values (when an array of values is given) or false if error
  143.      */
  144.     function validate($ruleName$values$options = null$multiple = false)
  145.     {
  146.         $rule =$this->getRule($ruleName);
  147.  
  148.         if (is_array($values&& !$multiple{
  149.             $result = 0;
  150.             foreach ($values as $value{
  151.                 if ($rule->validate($value$options=== true{
  152.                     $result++;
  153.                 }
  154.             }
  155.             return ($result == 0? false : $result;
  156.         else {
  157.             return $rule->validate($values$options);
  158.         }
  159.     // end func validate
  160.  
  161.     /**
  162.      * Returns the validation test in javascript code
  163.      *
  164.      * @param     array|HTML_QuickForm_element Element(s) the rule applies to
  165.      * @param     string                        Element name, in case $element is
  166.      *                                           not an array
  167.      * @param     array                         Rule data
  168.      * @access    public
  169.      * @return    string    JavaScript for the rule
  170.      */
  171.     function getValidationScript(&$element$elementName$ruleData)
  172.     {
  173.         $reset =  (isset($ruleData['reset'])) $ruleData['reset': false;
  174.         $rule  =$this->getRule($ruleData['type']);
  175.         if (!is_array($element)) {
  176.             list($jsValue$jsReset$this->_getJsValue($element$elementName$resetnull);
  177.         else {
  178.             $jsValue "  value = new Array();\n";
  179.             $jsReset '';
  180.             for ($i = 0; $i count($element)$i++{
  181.                 list($tmp_value$tmp_reset$this->_getJsValue($element[$i]$element[$i]->getName()$reset$i);
  182.                 $jsValue .= "\n" $tmp_value;
  183.                 $jsReset .= $tmp_reset;
  184.             }
  185.         }
  186.         $jsField = isset($ruleData['group'])$ruleData['group']$elementName;
  187.         list ($jsPrefix$jsCheck$rule->getValidationScript($ruleData['format']);
  188.         if (!isset($ruleData['howmany'])) {
  189.             $js $jsValue "\n" $jsPrefix 
  190.                   "  if (" str_replace('{jsVar}''value'$jsCheck. " && !errFlag['{$jsField}']) {\n" .
  191.                   "    errFlag['{$jsField}'] = true;\n" .
  192.                   "    _qfMsg = _qfMsg + '\\n - {$ruleData['message']}';\n" .
  193.                   $jsReset .
  194.                   "  }\n";
  195.         else {
  196.             $js $jsValue "\n" $jsPrefix 
  197.                   "  var res = 0;\n" .
  198.                   "  for (var i = 0; i < value.length; i++) {\n" .
  199.                   "    if (!(" str_replace('{jsVar}''value[i]'$jsCheck")) {\n" .
  200.                   "      res++;\n" .
  201.                   "    }\n" .
  202.                   "  }\n" 
  203.                   "  if (res < {$ruleData['howmany']} && !errFlag['{$jsField}']) {\n" . 
  204.                   "    errFlag['{$jsField}'] = true;\n" .
  205.                   "    _qfMsg = _qfMsg + '\\n - {$ruleData['message']}';\n" .
  206.                   $jsReset .
  207.                   "  }\n";
  208.         }
  209.         return $js;
  210.     // end func getValidationScript
  211.  
  212.  
  213.    /**
  214.     * Returns JavaScript to get and to reset the element's value
  215.     * 
  216.     * @access private
  217.     * @param  HTML_QuickForm_element    element being processed
  218.     * @param  string                    element's name
  219.     * @param  bool                      whether to generate JavaScript to reset
  220.     *                                    the value
  221.     * @param  integer                   value's index in the array (only used for
  222.     *                                    multielement rules)
  223.     * @return array     first item is value javascript, second is reset
  224.     */
  225.     function _getJsValue(&$element$elementName$reset = false$index = null)
  226.     {
  227.         $jsIndex = isset($index)'[' $index ']''';
  228.         $tmp_reset $reset? "    var field = frm.elements['$elementName'];\n": '';
  229.         if (is_a($element'html_quickform_group')) {
  230.             $value = "  _qfGroups['{$elementName}'] = {";
  231.             $elements =$element->getElements();
  232.             for ($i = 0$count count($elements)$i $count$i++{
  233.                 $append ($elements[$i]->getType(== 'select' && $elements[$i]->getMultiple())'[]''';
  234.                 $value .= "'" $element->getElementName($i$append "': true" .
  235.                           ($i $count - 1? ', ''');
  236.             }
  237.             $value .=
  238.                 "};\n" .
  239.                 "  value{$jsIndex} = new Array();\n" .
  240.                 "  var valueIdx = 0;\n" .
  241.                 "  for (var i = 0; i < frm.elements.length; i++) {\n" .
  242.                 "    var _element = frm.elements[i];\n" .
  243.                 "    if (_element.name in _qfGroups['{$elementName}']) {\n" . 
  244.                 "      switch (_element.type) {\n" .
  245.                 "        case 'checkbox':\n" .
  246.                 "        case 'radio':\n" .
  247.                 "          if (_element.checked) {\n" .
  248.                 "            value{$jsIndex}[valueIdx++] = _element.value;\n" .
  249.                 "          }\n" .
  250.                 "          break;\n" .
  251.                 "        case 'select-one':\n" .
  252.                 "          if (-1 != _element.selectedIndex) {\n" .
  253.                 "            value{$jsIndex}[valueIdx++] = _element.options[_element.selectedIndex].value;\n" .
  254.                 "          }\n" .
  255.                 "          break;\n" .
  256.                 "        case 'select-multiple':\n" .
  257.                 "          var tmpVal = new Array();\n" .
  258.                 "          var tmpIdx = 0;\n" .
  259.                 "          for (var j = 0; j < _element.options.length; j++) {\n" .
  260.                 "            if (_element.options[j].selected) {\n" .
  261.                 "              tmpVal[tmpIdx++] = _element.options[j].value;\n" .
  262.                 "            }\n" .
  263.                 "          }\n" .
  264.                 "          if (tmpIdx > 0) {\n" .
  265.                 "            value{$jsIndex}[valueIdx++] = tmpVal;\n" .
  266.                 "          }\n" .
  267.                 "          break;\n" .
  268.                 "        default:\n" .
  269.                 "          value{$jsIndex}[valueIdx++] = _element.value;\n" .
  270.                 "      }\n" .
  271.                 "    }\n" .
  272.                 "  }\n";
  273.             if ($reset{
  274.                 $tmp_reset =
  275.                     "    for (var i = 0; i < frm.elements.length; i++) {\n" .
  276.                     "      var _element = frm.elements[i];\n" .
  277.                     "      if (_element.name in _qfGroups['{$elementName}']) {\n" . 
  278.                     "        switch (_element.type) {\n" .
  279.                     "          case 'checkbox':\n" .
  280.                     "          case 'radio':\n" .
  281.                     "            _element.checked = _element.defaultChecked;\n" .
  282.                     "            break;\n" .
  283.                     "          case 'select-one':\n" .
  284.                     "          case 'select-multiple':\n" .
  285.                     "            for (var j = 0; j < _element.options.length; j++) {\n" .
  286.                     "              _element.options[j].selected = _element.options[j].defaultSelected;\n" .
  287.                     "            }\n" .
  288.                     "            break;\n" .
  289.                     "          default:\n" .
  290.                     "            _element.value = _element.defaultValue;\n" .
  291.                     "        }\n" .
  292.                     "      }\n" .
  293.                     "    }\n";
  294.             }
  295.  
  296.         elseif ($element->getType(== 'select'{
  297.             if ($element->getMultiple()) {
  298.                 $elementName .= '[]';
  299.                 $value =
  300.                     "  value{$jsIndex} = new Array();\n" .
  301.                     "  var valueIdx = 0;\n" .
  302.                     "  for (var i = 0; i < frm.elements['{$elementName}'].options.length; i++) {\n" . 
  303.                     "    if (frm.elements['{$elementName}'].options[i].selected) {\n" .
  304.                     "      value{$jsIndex}[valueIdx++] = frm.elements['{$elementName}'].options[i].value;\n" .
  305.                     "    }\n" .
  306.                     "  }\n";
  307.             else {
  308.                 $value = "  value{$jsIndex} = frm.elements['{$elementName}'].selectedIndex == -1? '': frm.elements['{$elementName}'].options[frm.elements['{$elementName}'].selectedIndex].value;\n";
  309.             }
  310.             if ($reset{
  311.                 $tmp_reset .= 
  312.                     "    for (var i = 0; i < field.options.length; i++) {\n" .
  313.                     "      field.options[i].selected = field.options[i].defaultSelected;\n" .
  314.                     "    }\n";
  315.             }
  316.  
  317.         elseif ($element->getType(== 'checkbox'{
  318.             if (is_a($element'html_quickform_advcheckbox')) {
  319.                 $value = "  value{$jsIndex} = frm.elements['$elementName'][1].checked? frm.elements['$elementName'][1].value: frm.elements['$elementName'][0].value;\n";
  320.                 $tmp_reset .= $reset "    field[1].checked = field[1].defaultChecked;\n" '';
  321.             else {
  322.                 $value = "  value{$jsIndex} = frm.elements['$elementName'].checked? '1': '';\n";
  323.                 $tmp_reset .= $reset "    field.checked = field.defaultChecked;\n" '';
  324.             }
  325.  
  326.         elseif ($element->getType(== 'radio'{
  327.             $value = "  value{$jsIndex} = '';\n" .
  328.                      // Fix for bug #5644
  329.                      "  var els = 'length' in frm.elements['$elementName']? frm.elements['$elementName']: [ frm.elements['$elementName'] ];\n" .
  330.                      "  for (var i = 0; i < els.length; i++) {\n" .
  331.                      "    if (els[i].checked) {\n" .
  332.                      "      value{$jsIndex} = els[i].value;\n" .
  333.                      "    }\n" .
  334.                      "  }";
  335.             if ($reset{
  336.                 $tmp_reset .= "    for (var i = 0; i < field.length; i++) {\n" .
  337.                               "      field[i].checked = field[i].defaultChecked;\n" .
  338.                               "    }";
  339.             }
  340.  
  341.         else {
  342.             $value = "  value{$jsIndex} = frm.elements['$elementName'].value;";
  343.             $tmp_reset .= ($reset"    field.value = field.defaultValue;\n" '';
  344.         }
  345.         return array($value$tmp_reset);
  346.     }
  347. // end class HTML_QuickForm_RuleRegistry
  348. ?>

Documentation generated on Sat, 01 Oct 2011 09:00:19 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.