Each.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 1.3.1

matomo / app / libs / HTML / QuickForm2 / Rule / Each.php

matomo / app / libs / HTML / QuickForm2 / Rule Last commit date

Callback.php 6 years ago Compare.php 6 years ago Each.php 6 years ago Empty.php 6 years ago Length.php 6 years ago MaxFileSize.php 6 years ago MimeType.php 6 years ago Nonempty.php 6 years ago NotCallback.php 6 years ago NotRegex.php 6 years ago Regex.php 6 years ago Required.php 6 years ago

Each.php

138 lines

1	<?php
2	/**
3	* Validates all elements in a Container using a template Rule
4	*
5	* PHP version 5
6	*
7	* LICENSE:
8	*
9	* Copyright (c) 2006-2010, Alexey Borzov <avb@php.net>,
10	* Bertrand Mansion <golgote@mamasam.com>
11	* All rights reserved.
12	*
13	* Redistribution and use in source and binary forms, with or without
14	* modification, are permitted provided that the following conditions
15	* are met:
16	*
17	* * Redistributions of source code must retain the above copyright
18	* notice, this list of conditions and the following disclaimer.
19	* * Redistributions in binary form must reproduce the above copyright
20	* notice, this list of conditions and the following disclaimer in the
21	* documentation and/or other materials provided with the distribution.
22	* * The names of the authors may not be used to endorse or promote products
23	* derived from this software without specific prior written permission.
24	*
25	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
26	* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27	* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
29	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
33	* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36	*
37	* @category HTML
38	* @package HTML_QuickForm2
39	* @author Alexey Borzov <avb@php.net>
40	* @author Bertrand Mansion <golgote@mamasam.com>
41	* @license http://opensource.org/licenses/bsd-license.php New BSD License
42	* @version SVN: $Id: Each.php 294057 2010-01-26 21:10:28Z avb $
43	* @link http://pear.php.net/package/HTML_QuickForm2
44	*/
45
46	/**
47	* Base class for HTML_QuickForm2 rules
48	*/
49	// require_once 'HTML/QuickForm2/Rule.php';
50
51	/**
52	* Validates all elements in a Container using a template Rule
53	*
54	* This Rule needs one configuration parameter for its work: the template Rule
55	* to use for actual validation. It can be passed either to
56	* {@link HTML_QuickForm2_Rule::__construct() the Rule constructor} as local
57	* configuration or to {@link HTML_QuickForm2_Factory::registerRule()} as
58	* global one. As usual, global configuration overrides local.
59	*
60	* The container will be considered valid if all its elements are valid
61	* according to a template Rule.
62	*
63	* <code>
64	* $group->addRule('each', 'The fields should contain only letters',
65	* $group->createRule('regex', '/^[a-z]+$/i'));
66	* </code>
67	*
68	* @category HTML
69	* @package HTML_QuickForm2
70	* @author Alexey Borzov <avb@php.net>
71	* @author Bertrand Mansion <golgote@mamasam.com>
72	* @version Release: @package_version@
73	*/
74	class HTML_QuickForm2_Rule_Each extends HTML_QuickForm2_Rule
75	{
76	/**
77	* Validates the owner's children using the template Rule
78	*
79	* @return bool Whether all children are valid according to a template Rule
80	*/
81	protected function validateOwner()
82	{
83	$rule = clone $this->getConfig();
84	foreach ($this->owner->getRecursiveIterator(RecursiveIteratorIterator::LEAVES_ONLY) as $child) {
85	$rule->setOwner($child);
86	if (!$rule->validateOwner()) {
87	return false;
88	}
89	}
90	return true;
91	}
92
93	/**
94	* Sets the template Rule to use for actual validation
95	*
96	* We do not allow using Required rules here, they are able to validate
97	* containers themselves without the help of Each rule.
98	*
99	* @param HTML_QuickForm2_Rule Template Rule
100	* @return HTML_QuickForm2_Rule
101	* @throws HTML_QuickForm2_InvalidArgumentException if $config is either not
102	* an instance of Rule or is an instance of Rule_Required
103	*/
104	public function setConfig($config)
105	{
106	if (!$config instanceof HTML_QuickForm2_Rule) {
107	throw new HTML_QuickForm2_InvalidArgumentException(
108	'Each Rule requires a template Rule to validate with, ' .
109	preg_replace('/\s+/', ' ', var_export($config, true)) . ' given'
110	);
111	} elseif ($config instanceof HTML_QuickForm2_Rule_Required) {
112	throw new HTML_QuickForm2_InvalidArgumentException(
113	'Cannot use "required" Rule as a template'
114	);
115	}
116	return parent::setConfig($config);
117	}
118
119	/**
120	* Sets the element that will be validated by this rule
121	*
122	* @param HTML_QuickForm2_Container Container to validate
123	* @throws HTML_QuickForm2_InvalidArgumentException if trying to use
124	* this Rule on something that isn't a Container
125	*/
126	public function setOwner(HTML_QuickForm2_Node $owner)
127	{
128	if (!$owner instanceof HTML_QuickForm2_Container) {
129	throw new HTML_QuickForm2_InvalidArgumentException(
130	'Each Rule can only validate Containers, '.
131	get_class($owner) . ' given'
132	);
133	}
134	parent::setOwner($owner);
135	}
136	}
137	?>
138