0 follower

CTypeValidator

Package system.validators
Inheritance class CTypeValidator » CValidator » CComponent
Since 1.0
Version $Id$
Source Code framework/validators/CTypeValidator.php
CTypeValidator verifies if the attribute is of the type specified by type.

The following data types are supported:
  • integer A 32-bit signed integer data type.
  • float A double-precision floating point number data type.
  • string A string data type.
  • date A date data type.
  • time A time data type (available since version 1.0.5).
  • datetime A date and time data type (available since version 1.0.5).


For date type, the property dateFormat will be used to determine how to parse the date string. If the given date value doesn't follow the format, the attribute is considered as invalid.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
allowEmpty boolean whether the attribute value can be null or empty. CTypeValidator
attributes array list of attributes to be validated. CValidator
builtInValidators array list of built-in validators (name=>class) CValidator
dateFormat string the format pattern that the date value should follow. CTypeValidator
datetimeFormat string the format pattern that the datetime value should follow. CTypeValidator
message string the user-defined error message. CValidator
on array list of scenarios that the validator should be applied. CValidator
timeFormat string the format pattern that the time value should follow. CTypeValidator
type string the data type that the attribute should be. CTypeValidator

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
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
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

MethodDescriptionDefined 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. 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 (available since v1.0.5)
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'.

timeFormat property (available since v1.0.5)
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', 'date', 'time' and 'datetime'. Note that 'time' and 'datetime' have been available since version 1.0.5.

Method Details

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/CTypeValidator.php#73 (show)
protected function validateAttribute($object,$attribute)
{
    $value=$object->$attribute;
    if($this->allowEmpty && $this->isEmpty($value))
        return;

    if($this->type==='integer')
        $valid=preg_match('/^[-+]?[0-9]+$/',trim($value));
    else if($this->type==='float')
        $valid=preg_match('/^[-+]?([0-9]*\.)?[0-9]+([eE][-+]?[0-9]+)?$/',trim($value));
    else if($this->type==='date')
        $valid=CDateTimeParser::parse($value,$this->dateFormat)!==false;
    else if($this->type==='time')
        $valid=CDateTimeParser::parse($value,$this->timeFormat)!==false;
    else if($this->type==='datetime')
        $valid=CDateTimeParser::parse($value,$this->datetimeFormat)!==false;
    else
        return;

    if(!$valid)
    {
        $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.