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

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

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

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

Each.php

128 lines

1	<?php
2
3	namespace {
4	/**
5	* Validates all elements in a Container using a template Rule
6	*
7	* PHP version 5
8	*
9	* LICENSE:
10	*
11	* Copyright (c) 2006-2010, Alexey Borzov <avb@php.net>,
12	* Bertrand Mansion <golgote@mamasam.com>
13	* All rights reserved.
14	*
15	* Redistribution and use in source and binary forms, with or without
16	* modification, are permitted provided that the following conditions
17	* are met:
18	*
19	* * Redistributions of source code must retain the above copyright
20	* notice, this list of conditions and the following disclaimer.
21	* * Redistributions in binary form must reproduce the above copyright
22	* notice, this list of conditions and the following disclaimer in the
23	* documentation and/or other materials provided with the distribution.
24	* * The names of the authors may not be used to endorse or promote products
25	* derived from this software without specific prior written permission.
26	*
27	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
28	* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
29	* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
31	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
35	* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38	*
39	* @category HTML
40	* @package HTML_QuickForm2
41	* @author Alexey Borzov <avb@php.net>
42	* @author Bertrand Mansion <golgote@mamasam.com>
43	* @license http://opensource.org/licenses/bsd-license.php New BSD License
44	* @version SVN: $Id: Each.php 294057 2010-01-26 21:10:28Z avb $
45	* @link http://pear.php.net/package/HTML_QuickForm2
46	*/
47	/**
48	* Base class for HTML_QuickForm2 rules
49	*/
50	// require_once 'HTML/QuickForm2/Rule.php';
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	* Sets the template Rule to use for actual validation
94	*
95	* We do not allow using Required rules here, they are able to validate
96	* containers themselves without the help of Each rule.
97	*
98	* @param HTML_QuickForm2_Rule Template Rule
99	* @return HTML_QuickForm2_Rule
100	* @throws HTML_QuickForm2_InvalidArgumentException if $config is either not
101	* an instance of Rule or is an instance of Rule_Required
102	*/
103	public function setConfig($config)
104	{
105	if (!$config instanceof \HTML_QuickForm2_Rule) {
106	throw new \HTML_QuickForm2_InvalidArgumentException('Each Rule requires a template Rule to validate with, ' . \preg_replace('/\\s+/', ' ', \var_export($config, \true)) . ' given');
107	} elseif ($config instanceof \HTML_QuickForm2_Rule_Required) {
108	throw new \HTML_QuickForm2_InvalidArgumentException('Cannot use "required" Rule as a template');
109	}
110	return parent::setConfig($config);
111	}
112	/**
113	* Sets the element that will be validated by this rule
114	*
115	* @param HTML_QuickForm2_Container Container to validate
116	* @throws HTML_QuickForm2_InvalidArgumentException if trying to use
117	* this Rule on something that isn't a Container
118	*/
119	public function setOwner(\HTML_QuickForm2_Node $owner)
120	{
121	if (!$owner instanceof \HTML_QuickForm2_Container) {
122	throw new \HTML_QuickForm2_InvalidArgumentException('Each Rule can only validate Containers, ' . \get_class($owner) . ' given');
123	}
124	parent::setOwner($owner);
125	}
126	}
127	}
128