CTypeValidator

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.

dateFormat property

public string $dateFormat;

the format pattern that the date value should follow. Defaults to 'MM/dd/yyyy'. Please see CDateTimeParser for details about how to specify a date format. This property is effective only when type is 'date'.

datetimeFormat property

public string $datetimeFormat;

the format pattern that the datetime value should follow. Defaults to 'MM/dd/yyyy hh:mm'. Please see CDateTimeParser for details about how to specify a datetime format. This property is effective only when type is 'datetime'.

strict property (available since v1.1.13)

public boolean $strict;

whether the actual PHP type of attribute value should be checked. Defaults to false, meaning that correctly formatted strings are accepted for integer and float validators.

timeFormat property

public string $timeFormat;

the format pattern that the time value should follow. Defaults to 'hh:mm'. Please see CDateTimeParser for details about how to specify a time format. This property is effective only when type is 'time'.

type property

public string $type;

the data type that the attribute should be. Defaults to 'string'. Valid values include 'string', 'integer', 'float', 'array', 'date', 'time' and 'datetime'.

Method Details

validateAttribute() method

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

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 {type}.');
        $this->addError($object,$attribute,$message,array('{type}'=>$this->type));
    }
}

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.13)

public boolean validateValue(mixed $value)

public function validateValue($value)
{
    $type=$this->type==='float' ? 'double' : $this->type;
    if($type===gettype($value))
        return true;
    elseif($this->strict || is_array($value) || is_object($value) || is_resource($value) || is_bool($value))
        return false;

    if($type==='integer')
        return (boolean)preg_match('/^[-+]?[0-9]+$/',trim($value));
    elseif($type==='double')
        return (boolean)preg_match('/^[-+]?([0-9]*\.)?[0-9]+([eE][-+]?[0-9]+)?$/',trim($value));
    elseif($type==='date')
        return CDateTimeParser::parse($value,$this->dateFormat,array('month'=>1,'day'=>1,'hour'=>0,'minute'=>0,'second'=>0))!==false;
    elseif($type==='time')
        return CDateTimeParser::parse($value,$this->timeFormat)!==false;
    elseif($type==='datetime')
        return CDateTimeParser::parse($value,$this->datetimeFormat, array('month'=>1,'day'=>1,'hour'=>0,'minute'=>0,'second'=>0))!==false;

    return false;
}

Validates a static value. Note that this method does not respect allowEmpty property. This method is provided so that you can call it directly without going through the model validation rule mechanism.