CCaptchaValidator
| 包 | system.validators |
|---|---|
| 继承 | class CCaptchaValidator » CValidator » CComponent |
| 可用自 | 1.0 |
| 版本 | $Id$ |
CCaptchaValidator validates that the attribute value is the same as the verification code displayed in the CAPTCHA.
CCaptchaValidator should be used together with CCaptchaAction.
CCaptchaValidator should be used together with CCaptchaAction.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| allowEmpty | boolean | whether the attribute value can be null or empty. | CCaptchaValidator |
| attributes | array | list of attributes to be validated. | CValidator |
| builtInValidators | array | list of built-in validators (name=>class) | CValidator |
| captchaAction | string | ID of the action that renders the CAPTCHA image. | CCaptchaValidator |
| caseSensitive | boolean | whether the comparison is case sensitive. | CCaptchaValidator |
| message | string | the user-defined error message. | CValidator |
| on | array | list of scenarios that the validator should be applied. | 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 |
| 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 |
| 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. | CCaptchaValidator |
属性详情
allowEmpty
属性
public boolean $allowEmpty;
whether the attribute value can be null or empty. Defaults to false, meaning the attribute is invalid if it is empty.
captchaAction
属性
public string $captchaAction;
ID of the action that renders the CAPTCHA image. Defaults to 'captcha', meaning the 'captcha' action declared in the current controller. This can also be a route consisting of controller ID and action ID.
caseSensitive
属性
public boolean $caseSensitive;
whether the comparison is case sensitive. Defaults to false.
方法详情
validateAttribute()
方法
|
protected void validateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | the object being validated |
| $attribute | string | the attribute being validated |
Validates the attribute of the object. If there is any error, the error message is added to the object.