CInlineValidator
| 包 | system.validators |
|---|---|
| 继承 | class CInlineValidator » CValidator » CComponent |
| 可用自 | 1.0 |
| 源码 | framework/validators/CInlineValidator.php |
CInlineValidator represents a validator which is defined as a method in the object being validated.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| attributes | array | list of attributes to be validated. | CValidator |
| builtInValidators | array | list of built-in validators (name=>class) | CValidator |
| clientValidate | string | the name of the method that returns the client validation code (See clientValidateAttribute). | CInlineValidator |
| enableClientValidation | boolean | whether to perform client-side validation. | CValidator |
| except | array | list of scenarios that the validator should not be applied to. | CValidator |
| message | string | the user-defined error message. | CValidator |
| method | string | the name of the validation method defined in the active record class | CInlineValidator |
| on | array | list of scenarios that the validator should be applied. | CValidator |
| params | array | additional parameters that are passed to the validation method | CInlineValidator |
| safe | boolean | whether attributes listed with this validator should be considered safe for massive assignment. | CValidator |
| skipOnError | boolean | whether this validation rule should be skipped when there is already a validation error for the current attribute. | CValidator |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| applyTo() | Returns a value indicating whether the validator applies to the specified scenario. | CValidator |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| clientValidateAttribute() | Returns the JavaScript code needed to perform client-side validation by calling the clientValidate method. | CInlineValidator |
| createValidator() | Creates a validator object. | CValidator |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| raiseEvent() | Raises an event. | CComponent |
| validate() | Validates the specified object. | CValidator |
受保护的方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| addError() | Adds an error about the specified attribute to the active record. | CValidator |
| isEmpty() | Checks if the given value is empty. | CValidator |
| validateAttribute() | Validates the attribute of the object. | CInlineValidator |
属性详情
clientValidate
属性
public string $clientValidate;
the name of the method that returns the client validation code (See clientValidateAttribute).
method
属性
public string $method;
the name of the validation method defined in the active record class
params
属性
public array $params;
additional parameters that are passed to the validation method
方法详情
clientValidateAttribute()
方法
（自版本 v1.1.9 可用）
|
public string clientValidateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | the data object being validated |
| $attribute | string | the name of the attribute to be validated. |
| {return} | string | the client-side validation script. |
源码： framework/validators/CInlineValidator.php#74 (显示)
public function clientValidateAttribute($object,$attribute)
{
if($this->clientValidate!==null)
{
$method=$this->clientValidate;
return $object->$method($attribute,$this->params);
}
}
Returns the JavaScript code needed to perform client-side validation by calling the clientValidate method. In the client validation code, these variables are predefined:
- value: the current input value associated with this attribute.
- messages: an array that may be appended with new error messages for the attribute.
- attribute: a data structure keeping all client-side options for the attribute
If clientValidate is set to "clientValidate123", clientValidate123() is the name of the method that returns the client validation code and can look like:
<?php
public function clientValidate123($attribute,$params)
{
if(!isset($params['message']))
$params['message']='Value should be 123';
$js = "if(value != '123') { messages.push($params['message']); }";
return $js;
}
?>
validateAttribute()
方法
|
protected void validateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | the object being validated |
| $attribute | string | the attribute being validated |
源码： framework/validators/CInlineValidator.php#39 (显示)
protected function validateAttribute($object,$attribute)
{
$method=$this->method;
$object->$method($attribute,$this->params);
}
Validates the attribute of the object. If there is any error, the error message is added to the object.