CValidator

Property Details

attributes property

public array $attributes;

list of attributes to be validated.

builtInValidators property

public static array $builtInValidators;

list of built-in validators (name=>class)

enableClientValidation property (available since v1.1.7)

public boolean $enableClientValidation;

whether to perform client-side validation. Defaults to true. Please refer to CActiveForm::enableClientValidation for more details about client-side validation.

except property (available since v1.1.11)

public array $except;

list of scenarios that the validator should not be applied to. Each array value refers to a scenario name with the same name as its array key.

message property

public string $message;

the user-defined error message. Different validators may define various placeholders in the message that are to be replaced with actual values. All validators recognize "{attribute}" placeholder, which will be replaced with the label of the attribute.

on property

public array $on;

list of scenarios that the validator should be applied. Each array value refers to a scenario name with the same name as its array key.

safe property (available since v1.1.4)

public boolean $safe;

whether attributes listed with this validator should be considered safe for massive assignment. Defaults to true.

skipOnError property (available since v1.1.1)

public boolean $skipOnError;

whether this validation rule should be skipped when there is already a validation error for the current attribute. Defaults to false.

Method Details

addError() method

protected void addError(CModel $object, string $attribute, string $message, array $params=array ( ))

protected function addError($object,$attribute,$message,$params=array())
{
    $params['{attribute}']=$object->getAttributeLabel($attribute);
    $object->addError($attribute,strtr($message,$params));
}

Adds an error about the specified attribute to the active record. This is a helper method that performs message selection and internationalization.

applyTo() method

public boolean applyTo(string $scenario)

public function applyTo($scenario)
{
    if(isset($this->except[$scenario]))
        return false;
    return empty($this->on) || isset($this->on[$scenario]);
}

Returns a value indicating whether the validator applies to the specified scenario. A validator applies to a scenario as long as any of the following conditions is met:

• the validator's "on" property is empty
• the validator's "on" property contains the specified scenario

clientValidateAttribute() method (available since v1.1.7)

public string clientValidateAttribute(CModel $object, string $attribute)

public function clientValidateAttribute($object,$attribute)
{
}

Returns the JavaScript needed for performing client-side validation. Do not override this method if the validator does not support client-side validation. Two predefined JavaScript variables can be used:

• value: the value to be validated
• messages: an array used to hold the validation error messages for the value

createValidator() method

public static CValidator createValidator(string $name, CModel $object, mixed $attributes, array $params=array ( ))

public static function createValidator($name,$object,$attributes,$params=array())
{
    if(is_string($attributes))
        $attributes=preg_split('/\s*,\s*/',trim($attributes, " \t\n\r\0\x0B,"),-1,PREG_SPLIT_NO_EMPTY);

    if(isset($params['on']))
    {
        if(is_array($params['on']))
            $on=$params['on'];
        else
            $on=preg_split('/[\s,]+/',$params['on'],-1,PREG_SPLIT_NO_EMPTY);
    }
    else
        $on=array();

    if(isset($params['except']))
    {
        if(is_array($params['except']))
            $except=$params['except'];
        else
            $except=preg_split('/[\s,]+/',$params['except'],-1,PREG_SPLIT_NO_EMPTY);
    }
    else
        $except=array();

    if(method_exists($object,$name))
    {
        $validator=new CInlineValidator;
        $validator->attributes=$attributes;
        $validator->method=$name;
        if(isset($params['clientValidate']))
        {
            $validator->clientValidate=$params['clientValidate'];
            unset($params['clientValidate']);
        }
        $validator->params=$params;
        if(isset($params['skipOnError']))
            $validator->skipOnError=$params['skipOnError'];
    }
    else
    {
        $params['attributes']=$attributes;
        if(isset(self::$builtInValidators[$name]))
            $className=Yii::import(self::$builtInValidators[$name],true);
        else
            $className=Yii::import($name,true);
        $validator=new $className;
        foreach($params as $name=>$value)
            $validator->$name=$value;
    }

    $validator->on=empty($on) ? array() : array_combine($on,$on);
    $validator->except=empty($except) ? array() : array_combine($except,$except);

    return $validator;
}

Creates a validator object.

isEmpty() method

protected boolean isEmpty(mixed $value, boolean $trim=false)

protected function isEmpty($value,$trim=false)
{
    return $value===null || $value===array() || $value==='' || $trim && is_scalar($value) && trim($value)==='';
}

Checks if the given value is empty. A value is considered empty if it is null, an empty array, or the trimmed result is an empty string. Note that this method is different from PHP empty(). It will return false when the value is 0.

validate() method

public void validate(CModel $object, array $attributes=NULL)

public function validate($object,$attributes=null)
{
    if(is_array($attributes))
        $attributes=array_intersect($this->attributes,$attributes);
    else
        $attributes=$this->attributes;
    foreach($attributes as $attribute)
    {
        if(!$this->skipOnError || !$object->hasErrors($attribute))
            $this->validateAttribute($object,$attribute);
    }
}

Validates the specified object.

validateAttribute() method

abstract protected void validateAttribute(CModel $object, string $attribute)

abstract protected function validateAttribute($object,$attribute);

Validates a single attribute. This method should be overridden by child classes.