RuleRegistry.php 15 KB

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