1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
<?php
/**
* Base class for HTML_QuickForm2 rules
*
* PHP version 5
*
* LICENSE:
*
* Copyright (c) 2006-2010, Alexey Borzov <avb@php.net>,
* Bertrand Mansion <golgote@mamasam.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * The names of the authors may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category HTML
* @package HTML_QuickForm2
* @author Alexey Borzov <avb@php.net>
* @author Bertrand Mansion <golgote@mamasam.com>
* @license http://opensource.org/licenses/bsd-license.php New BSD License
* @version SVN: $Id: Rule.php 299706 2010-05-24 18:32:37Z avb $
* @link http://pear.php.net/package/HTML_QuickForm2
*/
/**
* Abstract base class for HTML_QuickForm2 rules
*
* This class provides methods that allow chaining several rules together.
* Its validate() method executes the whole rule chain starting from this rule.
*
* @category HTML
* @package HTML_QuickForm2
* @author Alexey Borzov <avb@php.net>
* @author Bertrand Mansion <golgote@mamasam.com>
* @version Release: @package_version@
*/
abstract class HTML_QuickForm2_Rule
{
/**
* Constant showing that validation should be run server-side
* @see HTML_QuickForm2_Node::addRule()
*/
const RUNAT_SERVER = 1;
/**
* Constant showing that validation should be run client-side
* @see HTML_QuickForm2_Node::addRule()
*/
const RUNAT_CLIENT = 2;
/**
* An element whose value will be validated by this rule
* @var HTML_QuickForm2_Node
*/
protected $owner;
/**
* An error message to display if validation fails
* @var string
*/
protected $message;
/**
* Configuration data for the rule
* @var mixed
*/
protected $config;
/**
* Rules chained to this via "and" and "or" operators
*
* The contents can be described as "disjunctive normal form", where an outer
* array represents a disjunction of conjunctive clauses represented by inner
* arrays.
*
* @var array
*/
protected $chainedRules = array(array());
/**
* Class constructor
*
* @param HTML_QuickForm2_Node Element to validate
* @param string Error message to display if validation fails
* @param mixed Configuration data for the rule
*/
public function __construct(HTML_QuickForm2_Node $owner, $message = '', $config = null)
{
$this->setOwner($owner);
$this->setMessage($message);
$this->setConfig($config);
}
/**
* Merges local configuration with that provided for registerRule()
*
* Default behaviour is for global config to override local one, different
* Rules may implement more complex merging behaviours.
*
* @param mixed Local configuration
* @param mixed Global configuration, usually provided to {@link HTML_QuickForm2_Factory::registerRule()}
* @return mixed Merged configuration
*/
public static function mergeConfig($localConfig, $globalConfig)
{
return is_null($globalConfig)? $localConfig: $globalConfig;
}
/**
* Sets configuration data for the rule
*
* @param mixed Rule configuration data (specific for a Rule)
* @return HTML_QuickForm2_Rule
* @throws HTML_QuickForm2_InvalidArgumentException in case of invalid
* configuration data
*/
public function setConfig($config)
{
$this->config = $config;
return $this;
}
/**
* Returns the rule's configuration data
*
* @return mixed Configuration data (specific for a Rule)
*/
public function getConfig()
{
return $this->config;
}
/**
* Sets the error message output by the rule
*
* @param string Error message to display if validation fails
* @return HTML_QuickForm2_Rule
*/
public function setMessage($message)
{
$this->message = (string)$message;
return $this;
}
/**
* Returns the error message output by the rule
*
* @return string Error message
*/
public function getMessage()
{
return $this->message;
}
/**
* Sets the element that will be validated by this rule
*
* @param HTML_QuickForm2_Node Element to validate
*/
public function setOwner(HTML_QuickForm2_Node $owner)
{
if (null !== $this->owner) {
$this->owner->removeRule($this);
}
$this->owner = $owner;
}
/**
* Adds a rule to the chain with an "and" operator
*
* Evaluation is short-circuited, next rule will not be evaluated if the
* previous one returns false. The method is named this way because "and" is
* a reserved word in PHP.
*
* @param HTML_QuickForm2_Rule
* @return HTML_QuickForm2_Rule first rule in the chain (i.e. $this)
* @throws HTML_QuickForm2_InvalidArgumentException when trying to add
* a "required" rule to the chain
*/
public function and_(HTML_QuickForm2_Rule $next)
{
if ($next instanceof HTML_QuickForm2_Rule_Required) {
throw new HTML_QuickForm2_InvalidArgumentException(
'and_(): Cannot add a "required" rule'
);
}
$this->chainedRules[count($this->chainedRules) - 1][] = $next;
return $this;
}
/**
* Adds a rule to the chain with an "or" operator
*
* Evaluation is short-circuited, next rule will not be evaluated if the
* previous one returns true. The method is named this way because "or" is
* a reserved word in PHP.
*
* @param HTML_QuickForm2_Rule
* @return HTML_QuickForm2_Rule first rule in the chain (i.e. $this)
* @throws HTML_QuickForm2_InvalidArgumentException when trying to add
* a "required" rule to the chain
*/
public function or_(HTML_QuickForm2_Rule $next)
{
if ($next instanceof HTML_QuickForm2_Rule_Required) {
throw new HTML_QuickForm2_InvalidArgumentException(
'or_(): Cannot add a "required" rule'
);
}
$this->chainedRules[] = array($next);
return $this;
}
/**
* Performs validation
*
* The whole rule chain is executed. Note that the side effect of this
* method is setting the error message on element if validation fails
*
* @return boolean Whether the element is valid
*/
public function validate()
{
$globalValid = false;
$localValid = $this->validateOwner();
foreach ($this->chainedRules as $item) {
foreach ($item as $multiplier) {
if (!($localValid = $localValid && $multiplier->validate())) {
break;
}
}
if ($globalValid = $globalValid || $localValid) {
break;
}
$localValid = true;
}
$globalValid or $this->setOwnerError();
return $globalValid;
}
/**
* Validates the owner element
*
* @return bool Whether owner element is valid according to the rule
*/
abstract protected function validateOwner();
/**
* Sets the error message on the owner element
*/
protected function setOwnerError()
{
if (strlen($this->getMessage()) && !$this->owner->getError()) {
$this->owner->setError($this->getMessage());
}
}
/**
* Returns the client-side validation callback
*
* This essentially builds a Javascript version of validateOwner() method,
* with element ID and Rule configuration hardcoded.
*
* @return string Javascript function to validate the element's value
* @throws HTML_QuickForm2_Exception if Rule can only be run server-side
*/
protected function getJavascriptCallback()
{
throw new HTML_QuickForm2_Exception(
get_class($this) . ' does not implement javascript validation'
);
}
/**
* Returns the client-side representation of the Rule
*
* The Javascript object returned contains the following fields:
* - callback: {@see getJavascriptCallback()}
* - elementId: element ID to set error for if validation fails
* - errorMessage: error message to set if validation fails
* - chained: chained rules, array of arrays like in $chainedRules property
*
* @return string
* @throws HTML_QuickForm2_Exception if Rule or its chained Rules can only
* be run server-side
*/
public function getJavascript()
{
$js = "{\n\tcallback: " . $this->getJavascriptCallback() . ",\n" .
"\telementId: '" . $this->owner->getId() . "',\n" .
"\terrorMessage: '" . strtr($this->getMessage(), array(
"\r" => '\r',
"\n" => '\n',
"\t" => '\t',
"'" => "\\'",
'"' => '\"',
'\\' => '\\\\'
)) . "',\n\tchained: [";
$chained = array();
foreach ($this->chainedRules as $item) {
$multipliers = array();
foreach ($item as $multiplier) {
$multipliers[] = $multiplier->getJavascript();
}
$chained[] = '[' . implode(",\n", $multipliers) . ']';
}
$js .= implode(",\n", $chained) . "]\n}";
return $js;
}
}
?>
|