CRangeValidator

Package	system.validators
Inheritance	class CRangeValidator » CValidator » CComponent
Since	1.0
Source Code	framework/validators/CRangeValidator.php

CRangeValidator validates that the attribute value is among the list (specified via range). You may invert the validation logic with help of the not property (available since 1.1.5). For example,

class QuestionForm extends CFormModel
{
    public function rules()
    {
        return array(
            array('text, tag', 'required'),
            array('text, 'type', 'type' => 'string'),
            array('tag', 'in', 'range' => array('php', 'mysql', 'jquery')),
        );
    }
}

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
allowEmpty	boolean	whether the attribute value can be null or empty.	CRangeValidator
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
message	string	the user-defined error message.	CValidator
not	boolean	whether to invert the validation logic.	CRangeValidator
on	array	list of scenarios that the validator should be applied.	CValidator
range	array	list of valid values that the attribute value should be among	CRangeValidator
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 is strict (both type and value must be the same)	CRangeValidator

Public Methods

Hide inherited 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.	CRangeValidator
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

Protected Methods

Hide inherited 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.	CRangeValidator

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.

not property (available since v1.1.5)

public boolean $not;

whether to invert the validation logic. Defaults to false. If set to true, the attribute value should NOT be among the list of values defined via range.

range property

public array $range;

list of valid values that the attribute value should be among

strict property

public boolean $strict;

whether the comparison is strict (both type and value must be the same)

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/CRangeValidator.php#102 (show)


public function clientValidateAttribute($object,$attribute)
{
    if(!is_array($this->range))
        throw new CException(Yii::t('yii','The "range" property must be specified with a list of values.'));

    if(($message=$this->message)===null)
        $message=$this->not ? Yii::t('yii','{attribute} is in the list.') : Yii::t('yii','{attribute} is not in the list.');
    $message=strtr($message,array(
        '{attribute}'=>$object->getAttributeLabel($attribute),
    ));

    $range=array();
    foreach($this->range as $value)
        $range[]=(string)$value;
    $range=CJSON::encode($range);

    return "
if(".($this->allowEmpty ? "jQuery.trim(value)!='' && " : '').($this->not ? "jQuery.inArray(value, $range)>=0" : "jQuery.inArray(value, $range)<0").") {
messages.push(".CJSON::encode($message).");
}
";
}

Returns the JavaScript needed for performing client-side validation.


protected function validateAttribute($object,$attribute)
{
    $value=$object->$attribute;
    if($this->allowEmpty && $this->isEmpty($value))
        return;
    if(!is_array($this->range))
        throw new CException(Yii::t('yii','The "range" property must be specified with a list of values.'));
    $result = false;
    if($this->strict)
        $result=in_array($value,$this->range,true);
    else
    {
        foreach($this->range as $r)
        {
            $result = $r === '' || $value === '' ? $r === $value : $r == $value;
            if($result)
                break;
        }
    }
    if(!$this->not && !$result)
    {
        $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} is not in the list.');
        $this->addError($object,$attribute,$message);
    }
    elseif($this->not && $result)
    {
        $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} is in the list.');
        $this->addError($object,$attribute,$message);
    }
}

Validates the attribute of the object. If there is any error, the error message is added to the object.

User Contributed Notes

protected void validateAttribute(CModel $object, string $attribute)
$object	CModel	the object being validated
$attribute	string	the attribute being validated