CBooleanValidator
| Package | system.validators |
|---|---|
| Inheritance | class CBooleanValidator » CValidator » CComponent |
| Source Code | framework/validators/CBooleanValidator.php |
CBooleanValidator validates that the attribute value is either trueValue or falseValue.
When using the message property to define a custom error message, the message may contain additional placeholders that will be replaced with the actual content. In addition to the "{attribute}" placeholder, recognized by all validators (see CValidator), CBooleanValidator allows for the following placeholders to be specified:
When using the message property to define a custom error message, the message may contain additional placeholders that will be replaced with the actual content. In addition to the "{attribute}" placeholder, recognized by all validators (see CValidator), CBooleanValidator allows for the following placeholders to be specified:
- {true}: replaced with value representing the true status trueValue.
- {false}: replaced with value representing the false status falseValue.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| allowEmpty | boolean | whether the attribute value can be null or empty. | CBooleanValidator |
| attributes | array | list of attributes to be validated. | CValidator |
| builtInValidators | array | list of built-in validators (name=>class) | CValidator |
| enableClientValidation | boolean | whether to perform client-side validation. | CValidator |
| except | array | list of scenarios that the validator should not be applied to. | CValidator |
| falseValue | mixed | the value representing false status. | CBooleanValidator |
| message | string | the user-defined error message. | CValidator |
| on | array | list of scenarios that the validator should be applied. | CValidator |
| 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 |
| strict | boolean | whether the comparison to trueValue and falseValue is strict. | CBooleanValidator |
| trueValue | mixed | the value representing true status. | CBooleanValidator |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __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 needed for performing client-side validation. | CBooleanValidator |
| 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 |
| validateValue() | Validates a static value to see if it is a valid boolean. | CBooleanValidator |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| 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. | CBooleanValidator |
Property Details
allowEmpty property
public boolean $allowEmpty;
whether the attribute value can be null or empty. Defaults to true, meaning that if the attribute is empty, it is considered valid.
falseValue property
public mixed $falseValue;
the value representing false status. Defaults to '0'.
strict property
public boolean $strict;
whether the comparison to trueValue and falseValue is strict. When this is true, the attribute value and type must both match those of trueValue or falseValue. Defaults to false, meaning only the value needs to be matched.
trueValue property
public mixed $trueValue;
the value representing true status. Defaults to '1'.
Method Details
clientValidateAttribute() method (available since v1.1.7)
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. |
Source Code: framework/validators/CBooleanValidator.php#97 (show)
public function clientValidateAttribute($object,$attribute)
{
$message=$this->message!==null ? $this->message : Yii::t('yii','{attribute} must be either {true} or {false}.');
$message=strtr($message, array(
'{attribute}'=>$object->getAttributeLabel($attribute),
'{true}'=>$this->trueValue,
'{false}'=>$this->falseValue,
));
return "
if(".($this->allowEmpty ? "jQuery.trim(value)!='' && " : '')."value!=".CJSON::encode($this->trueValue)." && value!=".CJSON::encode($this->falseValue).") {
messages.push(".CJSON::encode($message).");
}
";
}
Returns the JavaScript needed for performing client-side validation.
See Also
validateAttribute() method
protected void validateAttribute(CModel $object, string $attribute) | ||
| $object | CModel | the object being validated |
| $attribute | string | the attribute being validated |
Source Code: framework/validators/CBooleanValidator.php#54 (show)
protected function validateAttribute($object,$attribute)
{
$value=$object->$attribute;
if($this->allowEmpty && $this->isEmpty($value))
return;
if(!$this->validateValue($value))
{
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be either {true} or {false}.');
$this->addError($object,$attribute,$message,array(
'{true}'=>$this->trueValue,
'{false}'=>$this->falseValue,
));
}
}
Validates the attribute of the object. If there is any error, the error message is added to the object.
validateValue() method (available since v1.1.17)
public boolean validateValue(mixed $value) | ||
| $value | mixed | the value to be validated |
| {return} | boolean | whether the value is a valid boolean |
Source Code: framework/validators/CBooleanValidator.php#81 (show)
public function validateValue($value)
{
if ($this->strict)
return $value===$this->trueValue || $value===$this->falseValue;
else
return $value==$this->trueValue || $value==$this->falseValue;
}
Validates a static value to see if it is a valid boolean. This method is provided so that you can call it directly without going through the model validation rule mechanism.
Note that this method does not respect the allowEmpty property.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CBooleanValidator