CValidator

Подробное описание свойств

attributes свойство

public array $attributes;

список атрибутов, которые нужно проверить.

builtInValidators свойство

public static array $builtInValidators;

список встроенных валидаторов (имя=>класс)

enableClientValidation свойство (доступно начиная с v1.1.7)

public boolean $enableClientValidation;

выполнять ли проверку на стороне клиента. По умолчанию true. Подробнее о проверке на стороне клиента см. CActiveForm::enableClientValidation.

except свойство (доступно начиная с v1.1.11)

public array $except;

список сценариев, к которым валидатор не должен применяться. Каждое значение массива — имя сценария, совпадающее с именем его ключа.

message свойство

public string $message;

пользовательское сообщение об ошибке. Различные валидаторы могут определять различные плейсхолдеры в сообщении, которые должны быть заменены фактическими значениями. Все валидаторы распознают плейсхолдер "{attribute}", который будет заменён на метку атрибута.

on свойство

public array $on;

список сценариев, к которым должен применяться валидатор. Каждое значение массива — имя сценария, совпадающее с именем его ключа.

safe свойство (доступно начиная с v1.1.4)

public boolean $safe;

считаются ли атрибуты, указанные с этим валидатором, безопасными для массового назначения. По умолчанию true.

skipOnError свойство (доступно начиная с v1.1.1)

public boolean $skipOnError;

должен ли этот валидатор пропустить проверку, когда для текущего атрибута уже есть ошибка. По умолчанию false.

Подробное описание методов

addError() метод

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));
}

Добавляет ошибку об указанном атрибуте в активную запись. Это вспомогательный метод, который выполняет выбор сообщения и локализацию.

applyTo() метод

public boolean applyTo(string $scenario)

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

Возвращает значение, указывающее, применяется ли валидатор к указанному сценарию. Валидатор применяется к сценарию, если выполняется любое из следующих условий:

• свойство "on" валидатора пустое
• свойство "on" валидатора содержит указанный сценарий

clientValidateAttribute() метод (доступно начиная с v1.1.7)

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

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

Возвращает JavaScript, необходимый для выполнения проверки на стороне клиента. Не переопределяйте этот метод, если валидатор не поддерживает проверку на стороне клиента. Можно использовать две предопределённые переменные JavaScript:

• value: значение, которое необходимо проверить
• messages: массив, используемый для хранения сообщений об ошибках проверки для значения

createValidator() метод

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;
}

Создаёт объект валидатора.

isEmpty() метод

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)==='';
}

Проверяет, является ли заданное значение пустым. Значение считается пустым, если оно равно null, пустой массив или обрезанный результат — пустая строка. Обратите внимание, что этот метод отличается от PHP empty(). Он вернёт false для значения 0.

validate() метод

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);
    }
}

Проверяет указанный объект.

validateAttribute() метод

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

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

Проверяет один атрибут. Этот метод должен быть переопределён дочерними классами.