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
|
<?php
/**
* TActiveCustomValidator class file.
*
* @author Wei Zhuo <weizhuo[at]gamil[dot]com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\ActiveControls
*/
namespace Prado\Web\UI\ActiveControls;
use Prado\Exceptions\TNotSupportedException;
use Prado\Prado;
use Prado\Web\UI\WebControls\TBaseValidator;
use Prado\Web\UI\WebControls\TCustomValidator;
/**
* TActiveCustomValidator Class
*
* Performs custom validation using only server-side {@link onServerValidate onServerValidate}
* validation event. The client-side uses callbacks to raise
* the {@link onServerValidate onServerValidate} event.
*
* Beware that the {@link onServerValidate onServerValidate} may be
* raised when the control to validate on the client side
* changes value, that is, the server validation may be called many times.
*
* After the callback or postback, the {@link onServerValidate onServerValidate}
* is raised once more. The {@link getIsCallback IsCallback} property
* will be true when validation is made during a callback request.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @package Prado\Web\UI\ActiveControls
* @since 3.1
*/
class TActiveCustomValidator extends TCustomValidator
implements ICallbackEventHandler, IActiveControl
{
/**
* @var boolean true if validation is made during a callback request.
*/
private $_isCallback = false;
/**
* @return boolean true if validation is made during a callback request.
*/
public function getIsCallback()
{
return $this->_isCallback;
}
/**
* Creates a new callback control, sets the adapter to
* TActiveControlAdapter. If you override this class, be sure to set the
* adapter appropriately by, for example, by calling this constructor.
*/
public function __construct()
{
parent::__construct();
$this->setAdapter(new TActiveControlAdapter($this));
$this->getActiveControl()->setClientSide(new TActiveCustomValidatorClientSide);
}
/**
* @return TBaseActiveCallbackControl standard callback control options.
*/
public function getActiveControl()
{
return $this->getAdapter()->getBaseActiveControl();
}
/**
* @return TCallbackClientSide client side request options.
*/
public function getClientSide()
{
return $this->getAdapter()->getBaseActiveControl()->getClientSide();
}
/**
* Client validation function is NOT supported.
*/
public function setClientValidationFunction($value)
{
throw new TNotSupportedException('tactivecustomvalidator_clientfunction_unsupported',
get_class($this));
}
/**
* Raises the callback event. This method is required by {@link
* ICallbackEventHandler} interface. The {@link onServerValidate
* OnServerValidate} event is raised first and then the
* {@link onCallback OnCallback} event.
* This method is mainly used by framework and control developers.
* @param TCallbackEventParameter the event parameter
*/
public function raiseCallbackEvent($param)
{
$this->_isCallback = true;
$result = $this->onServerValidate($param->getCallbackParameter());
$param->setResponseData($result);
$this->onCallback($param);
}
/**
* @param boolean whether the value is valid; this method will trigger a clientside update if needed
*/
public function setIsValid($value)
{
parent::setIsValid($value);
if($this->getActiveControl()->canUpdateClientSide())
{
$client = $this->getPage()->getCallbackClient();
$func = 'Prado.Validation.updateActiveCustomValidator';
$client->callClientFunction($func, array($this, $value));
}
}
/**
* This method is invoked when a callback is requested. The method raises
* 'OnCallback' event to fire up the event handlers. If you override this
* method, be sure to call the parent implementation so that the event
* handler can be invoked.
* @param TCallbackEventParameter event parameter to be passed to the event handlers
*/
public function onCallback($param)
{
$this->raiseEvent('OnCallback', $this, $param);
}
/**
* Returns an array of javascript validator options.
* @return array javascript validator options.
*/
protected function getClientScriptOptions()
{
$options=TBaseValidator::getClientScriptOptions();
$options['EventTarget'] = $this->getUniqueID();
return $options;
}
/**
* Sets the text for the error message. Updates client-side erorr message.
* @param string the error message
*/
public function setErrorMessage($value)
{
parent::setErrorMessage($value);
if($this->getActiveControl()->canUpdateClientSide())
{
$client = $this->getPage()->getCallbackClient();
$func = 'Prado.Validation.setErrorMessage';
$client->callClientFunction($func, array($this, $value));
}
}
/**
* It's mandatory for the EnableClientScript to be activated or the TActiveCustomValidator won't work.
* @return boolean whether client-side validation is enabled.
*/
public function getEnableClientScript()
{
return true;
}
/**
* Ensure that the ID attribute is rendered and registers the javascript code
* for initializing the active control.
*/
protected function addAttributesToRender($writer)
{
parent::addAttributesToRender($writer);
TBaseValidator::registerClientScriptValidator();
}
/**
* @return string corresponding javascript class name for this this.
*/
protected function getClientClassName()
{
return 'Prado.WebUI.TActiveCustomValidator';
}
}
|
