documentation/moodle/_rule_registry_8php_source.html

00001 <?php
00002 /* vim: set expandtab tabstop=4 shiftwidth=4: */
00003 // +----------------------------------------------------------------------+
00004 // | PHP version 4.0                                                      |
00005 // +----------------------------------------------------------------------+
00006 // | Copyright (c) 1997-2003 The PHP Group                                |
00007 // +----------------------------------------------------------------------+
00008 // | This source file is subject to version 2.0 of the PHP license,       |
00009 // | that is bundled with this package in the file LICENSE, and is        |
00010 // | available at through the world-wide-web at                           |
00011 // | http://www.php.net/license/2_02.txt.                                 |
00012 // | If you did not receive a copy of the PHP license and are unable to   |
00013 // | obtain it through the world-wide-web, please send a note to          |
00014 // | license@php.net so we can mail you a copy immediately.               |
00015 // +----------------------------------------------------------------------+
00016 // | Authors: Adam Daniel <adaniel1@eesus.jnj.com>                        |
00017 // |          Alexey Borzov <borz_off@cs.msu.su>                          |
00018 // |          Bertrand Mansion <bmansion@mamasam.com>                     |
00019 // +----------------------------------------------------------------------+
00020 //
00021 // $Id: RuleRegistry.php,v 1.3 2010/12/14 17:35:24 moodlerobot Exp $
00022
00027 class HTML_QuickForm_RuleRegistry
00028 {
00034     var $_rules = array();
00035
00036
00047     function &singleton()
00048     {
00049         static $obj;
00050         if (!isset($obj)) {
00051             $obj = new HTML_QuickForm_RuleRegistry();
00052         }
00053         return $obj;
00054     } // end func singleton
00055
00077     function registerRule($ruleName, $type, $data1, $data2 = null)
00078     {
00079         $type = strtolower($type);
00080         if ($type == 'regex') {
00081             // Regular expression
00082             $rule =& $this->getRule('regex');
00083             $rule->addData($ruleName, $data1);
00084             $GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName] = $GLOBALS['_HTML_QuickForm_registered_rules']['regex'];
00085
00086         } elseif ($type == 'function' || $type == 'callback') {
00087             // Callback function
00088             $rule =& $this->getRule('callback');
00089             $rule->addData($ruleName, $data1, $data2, 'function' == $type);
00090             $GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName] = $GLOBALS['_HTML_QuickForm_registered_rules']['callback'];
00091
00092         } elseif (is_object($data1)) {
00093             // An instance of HTML_QuickForm_Rule
00094             $this->_rules[strtolower(get_class($data1))] = $data1;
00095             $GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName] = array(strtolower(get_class($data1)), null);
00096
00097         } else {
00098             // Rule class name
00099             $GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName] = array(strtolower($data1), $data2);
00100         }
00101     } // end func registerRule
00102
00110     function &getRule($ruleName)
00111     {
00112         list($class, $path) = $GLOBALS['_HTML_QuickForm_registered_rules'][$ruleName];
00113
00114         if (!isset($this->_rules[$class])) {
00115             if (!empty($path)) {
00116                 include_once($path);
00117             }
00118             $this->_rules[$class] = new $class();
00119         }
00120         $this->_rules[$class]->setName($ruleName);
00121         return $this->_rules[$class];
00122     } // end func getRule
00123
00135     function validate($ruleName, $values, $options = null, $multiple = false)
00136     {
00137         $rule =& $this->getRule($ruleName);
00138
00139         if (is_array($values) && !$multiple) {
00140             $result = 0;
00141             foreach ($values as $value) {
00142                 if ($rule->validate($value, $options) === true) {
00143                     $result++;
00144                 }
00145             }
00146             return ($result == 0) ? false : $result;
00147         } else {
00148             return $rule->validate($values, $options);
00149         }
00150     } // end func validate
00151
00161     function getValidationScript(&$element, $elementName, $ruleData)
00162     {
00163         $reset =  (isset($ruleData['reset'])) ? $ruleData['reset'] : false;
00164         $rule  =& $this->getRule($ruleData['type']);
00165         if (!is_array($element)) {
00166             list($jsValue, $jsReset) = $this->_getJsValue($element, $elementName, $reset, null);
00167         } else {
00168             $jsValue = "  value = new Array();\n";
00169             $jsReset = '';
00170             for ($i = 0; $i < count($element); $i++) {
00171                 list($tmp_value, $tmp_reset) = $this->_getJsValue($element[$i], $element[$i]->getName(), $reset, $i);
00172                 $jsValue .= "\n" . $tmp_value;
00173                 $jsReset .= $tmp_reset;
00174             }
00175         }
00176         $jsField = isset($ruleData['group'])? $ruleData['group']: $elementName;
00177         list ($jsPrefix, $jsCheck) = $rule->getValidationScript($ruleData['format']);
00178         if (!isset($ruleData['howmany'])) {
00179             $js = $jsValue . "\n" . $jsPrefix .
00180                   "  if (" . str_replace('{jsVar}', 'value', $jsCheck) . " && !errFlag['{$jsField}']) {\n" .
00181                   "    errFlag['{$jsField}'] = true;\n" .
00182                   "    _qfMsg = _qfMsg + '\\n - {$ruleData['message']}';\n" .
00183                   $jsReset .
00184                   "  }\n";
00185         } else {
00186             $js = $jsValue . "\n" . $jsPrefix .
00187                   "  var res = 0;\n" .
00188                   "  for (var i = 0; i < value.length; i++) {\n" .
00189                   "    if (!(" . str_replace('{jsVar}', 'value[i]', $jsCheck) . ")) {\n" .
00190                   "      res++;\n" .
00191                   "    }\n" .
00192                   "  }\n" .
00193                   "  if (res < {$ruleData['howmany']} && !errFlag['{$jsField}']) {\n" .
00194                   "    errFlag['{$jsField}'] = true;\n" .
00195                   "    _qfMsg = _qfMsg + '\\n - {$ruleData['message']}';\n" .
00196                   $jsReset .
00197                   "  }\n";
00198         }
00199         return $js;
00200     } // end func getValidationScript
00201
00202
00213     function _getJsValue(&$element, $elementName, $reset = false, $index = null)
00214     {
00215         $jsIndex = isset($index)? '[' . $index . ']': '';
00216         $tmp_reset = $reset? "    var field = frm.elements['$elementName'];\n": '';
00217         if (is_a($element, 'html_quickform_group')) {
00218             $value = "  _qfGroups['{$elementName}'] = {";
00219             $elements =& $element->getElements();
00220             for ($i = 0, $count = count($elements); $i < $count; $i++) {
00221                 $append = ($elements[$i]->getType() == 'select' && $elements[$i]->getMultiple())? '[]': '';
00222                 $value .= "'" . $element->getElementName($i) . $append . "': true" .
00223                           ($i < $count - 1? ', ': '');
00224             }
00225             $value .=
00226                 "};\n" .
00227                 "  value{$jsIndex} = new Array();\n" .
00228                 "  var valueIdx = 0;\n" .
00229                 "  for (var i = 0; i < frm.elements.length; i++) {\n" .
00230                 "    var _element = frm.elements[i];\n" .
00231                 "    if (_element.name in _qfGroups['{$elementName}']) {\n" .
00232                 "      switch (_element.type) {\n" .
00233                 "        case 'checkbox':\n" .
00234                 "        case 'radio':\n" .
00235                 "          if (_element.checked) {\n" .
00236                 "            value{$jsIndex}[valueIdx++] = _element.value;\n" .
00237                 "          }\n" .
00238                 "          break;\n" .
00239                 "        case 'select-one':\n" .
00240                 "          if (-1 != _element.selectedIndex) {\n" .
00241                 "            value{$jsIndex}[valueIdx++] = _element.options[_element.selectedIndex].value;\n" .
00242                 "          }\n" .
00243                 "          break;\n" .
00244                 "        case 'select-multiple':\n" .
00245                 "          var tmpVal = new Array();\n" .
00246                 "          var tmpIdx = 0;\n" .
00247                 "          for (var j = 0; j < _element.options.length; j++) {\n" .
00248                 "            if (_element.options[j].selected) {\n" .
00249                 "              tmpVal[tmpIdx++] = _element.options[j].value;\n" .
00250                 "            }\n" .
00251                 "          }\n" .
00252                 "          if (tmpIdx > 0) {\n" .
00253                 "            value{$jsIndex}[valueIdx++] = tmpVal;\n" .
00254                 "          }\n" .
00255                 "          break;\n" .
00256                 "        default:\n" .
00257                 "          value{$jsIndex}[valueIdx++] = _element.value;\n" .
00258                 "      }\n" .
00259                 "    }\n" .
00260                 "  }\n";
00261             if ($reset) {
00262                 $tmp_reset =
00263                     "    for (var i = 0; i < frm.elements.length; i++) {\n" .
00264                     "      var _element = frm.elements[i];\n" .
00265                     "      if (_element.name in _qfGroups['{$elementName}']) {\n" .
00266                     "        switch (_element.type) {\n" .
00267                     "          case 'checkbox':\n" .
00268                     "          case 'radio':\n" .
00269                     "            _element.checked = _element.defaultChecked;\n" .
00270                     "            break;\n" .
00271                     "          case 'select-one':\n" .
00272                     "          case 'select-multiple':\n" .
00273                     "            for (var j = 0; j < _element.options.length; j++) {\n" .
00274                     "              _element.options[j].selected = _element.options[j].defaultSelected;\n" .
00275                     "            }\n" .
00276                     "            break;\n" .
00277                     "          default:\n" .
00278                     "            _element.value = _element.defaultValue;\n" .
00279                     "        }\n" .
00280                     "      }\n" .
00281                     "    }\n";
00282             }
00283
00284         } elseif ($element->getType() == 'select') {
00285             if ($element->getMultiple()) {
00286                 $elementName .= '[]';
00287                 $value =
00288                     "  value{$jsIndex} = new Array();\n" .
00289                     "  var valueIdx = 0;\n" .
00290                     "  for (var i = 0; i < frm.elements['{$elementName}'].options.length; i++) {\n" .
00291                     "    if (frm.elements['{$elementName}'].options[i].selected) {\n" .
00292                     "      value{$jsIndex}[valueIdx++] = frm.elements['{$elementName}'].options[i].value;\n" .
00293                     "    }\n" .
00294                     "  }\n";
00295             } else {
00296                 $value = "  value{$jsIndex} = frm.elements['{$elementName}'].selectedIndex == -1? '': frm.elements['{$elementName}'].options[frm.elements['{$elementName}'].selectedIndex].value;\n";
00297             }
00298             if ($reset) {
00299                 $tmp_reset .=
00300                     "    for (var i = 0; i < field.options.length; i++) {\n" .
00301                     "      field.options[i].selected = field.options[i].defaultSelected;\n" .
00302                     "    }\n";
00303             }
00304
00305         } elseif ($element->getType() == 'checkbox') {
00306             if (is_a($element, 'html_quickform_advcheckbox')) {
00307                 $value = "  value{$jsIndex} = frm.elements['$elementName'][1].checked? frm.elements['$elementName'][1].value: frm.elements['$elementName'][0].value;\n";
00308                 $tmp_reset .= $reset ? "    field[1].checked = field[1].defaultChecked;\n" : '';
00309             } else {
00310                 $value = "  value{$jsIndex} = frm.elements['$elementName'].checked? '1': '';\n";
00311                 $tmp_reset .= $reset ? "    field.checked = field.defaultChecked;\n" : '';
00312             }
00313
00314         } elseif ($element->getType() == 'radio') {
00315             $value = "  value{$jsIndex} = '';\n" .
00316                      // Fix for bug #5644
00317                      "  var els = 'length' in frm.elements['$elementName']? frm.elements['$elementName']: [ frm.elements['$elementName'] ];\n" .
00318                      "  for (var i = 0; i < els.length; i++) {\n" .
00319                      "    if (els[i].checked) {\n" .
00320                      "      value{$jsIndex} = els[i].value;\n" .
00321                      "    }\n" .
00322                      "  }";
00323             if ($reset) {
00324                 $tmp_reset .= "    for (var i = 0; i < field.length; i++) {\n" .
00325                               "      field[i].checked = field[i].defaultChecked;\n" .
00326                               "    }";
00327             }
00328
00329         } else {
00330             $value = "  value{$jsIndex} = frm.elements['$elementName'].value;";
00331             $tmp_reset .= ($reset) ? "    field.value = field.defaultValue;\n" : '';
00332         }
00333         return array($value, $tmp_reset);
00334     }
00335 } // end class HTML_QuickForm_RuleRegistry
00336 ?>