Look up a class, method, property or event

CTypeValidator

Package	system.validators
Inheritance	class CTypeValidator » CValidator » CComponent
Since	1.0
Version	$Id: CTypeValidator.php 3515 2011-12-28 12:29:24Z mdomba $
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.
array An array value.
date A date data type.
time A time data type.
datetime A date and time data type.

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.

Starting from version 1.1.7, we have a dedicated date validator CDateValidator. Please consider using this validator to validate a date-typed value.

When using the message property to define a custom error message, the message may contain additional placeholders that will be replaced with the actual content. In addition to the "{attribute}" placeholder, recognized by all validators (see CValidator), CTypeValidator allows for the following placeholders to be specified:

{type}: replaced with data type the attribute should be type.

Public Properties

Hide inherited properties

Property	Type	Description	Defined 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
enableClientValidation	boolean	whether to perform client-side validation.	CValidator
message	string	the user-defined error message.	CValidator
on	array	list of scenarios that the validator should be applied.	CValidator
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
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

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.	CValidator
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.	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'.

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)
$object	CModel	the object being validated
$attribute	string	the attribute being validated

Source Code: framework/validators/CTypeValidator.php#82 (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,array('month'=>1,'day'=>1,'hour'=>0,'minute'=>0,'second'=>0))!==false;
    else if($this->type==='time')
        $valid=CDateTimeParser::parse($value,$this->timeFormat)!==false;
    else if($this->type==='datetime')
        $valid=CDateTimeParser::parse($value,$this->datetimeFormat, array('month'=>1,'day'=>1,'hour'=>0,'minute'=>0,'second'=>0))!==false;
    else if($this->type==='array')
        $valid=is_array($value);
    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.

CTypeValidator

Public Properties

Public Methods

Protected Methods

Property Details

Method Details

Total 1 comment

Leave a comment

Yii Supporters