blob: d5f172ff875de773c89ed3bb697e8eecbc38c3f7 (
plain)
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
|
<?php
/**
* TCustomValidator class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\WebControls
*/
namespace Prado\Web\UI\WebControls;
/**
* Using TBaseValidator class
*/
Prado::using('System.Web.UI.WebControls.TBaseValidator');
/**
* TCustomValidator class
*
* TCustomValidator performs user-defined validation (either
* server-side or client-side or both) on an input component.
*
* To create a server-side validation function, provide a handler for
* the {@link onServerValidate OnServerValidate} event that performs the validation.
* The data string of the input control to validate can be accessed
* by {@link TServerValidateEventParameter::getValue Value} of the event parameter.
* The result of the validation should be stored in the
* {@link TServerValidateEventParameter::getIsValid IsValid} property of the event
* parameter.
*
* To create a client-side validation function, add the client-side
* validation javascript function to the page template.
* The function should have the following signature:
* <code>
* <script type="text/javascript"><!--
* function ValidationFunctionName(sender, parameter)
* {
* // if(parameter == ...)
* // return true;
* // else
* // return false;
* }
* --></script>
* </code>
* Use the {@link setClientValidationFunction ClientValidationFunction} property
* to specify the name of the client-side validation script function associated
* with the TCustomValidator.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class TCustomValidator extends TBaseValidator
{
/**
* Gets the name of the javascript class responsible for performing validation for this control.
* This method overrides the parent implementation.
* @return string the javascript class name
*/
protected function getClientClassName()
{
return 'Prado.WebUI.TCustomValidator';
}
/**
* @return string the name of the custom client-side script function used for validation.
*/
public function getClientValidationFunction()
{
return $this->getViewState('ClientValidationFunction','');
}
/**
* Sets the name of the custom client-side script function used for validation.
* @param string the script function name
*/
public function setClientValidationFunction($value)
{
$this->setViewState('ClientValidationFunction',$value,'');
}
/**
* This method overrides the parent's implementation.
* The validation succeeds if {@link onServerValidate} returns true.
* @return boolean whether the validation succeeds
*/
public function evaluateIsValid()
{
$value = '';
if($this->getValidationTarget()!==null)
$value=$this->getValidationValue($this->getValidationTarget());
return $this->onServerValidate($value);
}
/**
* This method is invoked when the server side validation happens.
* It will raise the <b>OnServerValidate</b> event.
* The method also allows derived classes to handle the event without attaching a delegate.
* <b>Note</b> The derived classes should call parent implementation
* to ensure the <b>OnServerValidate</b> event is raised.
* @param string the value to be validated
* @return boolean whether the value is valid
*/
public function onServerValidate($value)
{
$param=new TServerValidateEventParameter($value,true);
$this->raiseEvent('OnServerValidate',$this,$param);
return $param->getIsValid();
}
/**
* @return TControl control to be validated. Null if no control is found.
*/
public function getValidationTarget()
{
if(($id=$this->getControlToValidate())!=='' && ($control=$this->findControl($id))!==null)
return $control;
else if(($id=$this->getControlToValidate())!=='')
throw new TInvalidDataTypeException('basevalidator_validatable_required',get_class($this));
else
return null;
}
/**
* Returns an array of javascript validator options.
* @return array javascript validator options.
*/
protected function getClientScriptOptions()
{
$options=parent::getClientScriptOptions();
if(($clientJs=$this->getClientValidationFunction())!=='')
$options['ClientValidationFunction']=$clientJs;
return $options;
}
/**
* Only register the client-side validator if
* {@link setClientValidationFunction ClientValidationFunction} is set.
*/
protected function registerClientScriptValidator()
{
if($this->getClientValidationFunction()!=='')
parent::registerClientScriptValidator();
}
}
|
