CNumberValidator

Package	system.validators
Inheritance	class CNumberValidator » CValidator » CComponent
Since	1.0
Version	$Id$
Source Code	framework/validators/CNumberValidator.php

CNumberValidator validates that the attribute value is a number.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
allowEmpty	boolean	whether the attribute value can be null or empty.	CNumberValidator
attributes	array	list of attributes to be validated.	CValidator
builtInValidators	array	list of built-in validators (name=>class)	CValidator
integerOnly	boolean	whether the attribute value can only be an integer.	CNumberValidator
max	integer\|double	upper limit of the number.	CNumberValidator
message	string	the user-defined error message.	CValidator
min	integer\|double	lower limit of the number.	CNumberValidator
on	array	list of scenarios that the validator should be applied.	CValidator
tooBig	string	user-defined error message used when the value is too big.	CNumberValidator
tooSmall	string	user-defined error message used when the value is too small.	CNumberValidator

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

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.	CNumberValidator

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.

integerOnly property

public boolean $integerOnly;

whether the attribute value can only be an integer. Defaults to false.

max property

public integer|double $max;

upper limit of the number. Defaults to null, meaning no upper limit.

min property

public integer|double $min;

lower limit of the number. Defaults to null, meaning no lower limit.

tooBig property

public string $tooBig;

user-defined error message used when the value is too big.

tooSmall property

public string $tooSmall;

user-defined error message used when the value is too small.

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/CNumberValidator.php#54 (show)


protected function validateAttribute($object,$attribute)
{
    $value=$object->$attribute;
    if($this->allowEmpty && $this->isEmpty($value))
        return;
    if($this->integerOnly)
    {
        if(!preg_match('/^\s*[+-]?\d+\s*$/',"$value"))
        {
            $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be an integer.');
            $this->addError($object,$attribute,$message);
        }
    }
    else
    {
        if(!preg_match('/^\s*[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?\s*$/',"$value"))
        {
            $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be a number.');
            $this->addError($object,$attribute,$message);
        }
    }
    if($this->min!==null && $value<$this->min)
    {
        $message=$this->tooSmall!==null?$this->tooSmall:Yii::t('yii','{attribute} is too small (minimum is {min}).');
        $this->addError($object,$attribute,$message,array('{min}'=>$this->min));
    }
    if($this->max!==null && $value>$this->max)
    {
        $message=$this->tooBig!==null?$this->tooBig:Yii::t('yii','{attribute} is too big (maximum is {max}).');
        $this->addError($object,$attribute,$message,array('{max}'=>$this->max));
    }
}

Validates the attribute of the object. If there is any error, the error message is added to the object.

User Contributed Notes