0 follower

CNumberValidator

Package system.validators
Inheritance class CNumberValidator » CValidator » CComponent
Since 1.0
Source Code framework/validators/CNumberValidator.php
CNumberValidator validates that the attribute value is a number.

In addition to the message property for setting a custom error message, CNumberValidator has a couple custom error messages you can set that correspond to different validation scenarios. To specify a custom message when the numeric value is too big, you may use the tooBig property. Similarly with tooSmall. The messages may contain additional placeholders that will be replaced with the actual content. In addition to the "{attribute}" placeholder, recognized by all validators (see CValidator), CNumberValidator allows for the following placeholders to be specified:
  • {min}: when using tooSmall, replaced with the lower limit of the number min.
  • {max}: when using tooBig, replaced with the upper limit of the number max.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined 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
enableClientValidation boolean whether to perform client-side validation. CValidator
except array list of scenarios that the validator should not be applied to. CValidator
integerOnly boolean whether the attribute value can only be an integer. CNumberValidator
integerPattern string the regular expression for matching integers. CNumberValidator
max integer|float upper limit of the number. CNumberValidator
message string the user-defined error message. CValidator
min integer|float lower limit of the number. CNumberValidator
numberPattern string the regular expression for matching numbers. CNumberValidator
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
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

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
clientValidateAttribute() Returns the JavaScript needed for performing client-side validation. CNumberValidator
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

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

integerPattern property (available since v1.1.7)
public string $integerPattern;

the regular expression for matching integers.

max property
public integer|float $max;

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

min property
public integer|float $min;

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

numberPattern property (available since v1.1.7)
public string $numberPattern;

the regular expression for matching numbers.

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

clientValidateAttribute() method (available since v1.1.7)
public string clientValidateAttribute(CModel $object, string $attribute)
$object CModel the data object being validated
$attribute string the name of the attribute to be validated.
{return} string the client-side validation script.
Source Code: framework/validators/CNumberValidator.php#125 (show)
public function clientValidateAttribute($object,$attribute)
{
    $label=$object->getAttributeLabel($attribute);

    if(($message=$this->message)===null)
        $message=$this->integerOnly ? Yii::t('yii','{attribute} must be an integer.') : Yii::t('yii','{attribute} must be a number.');
    $message=strtr($message, array(
        '{attribute}'=>$label,
    ));

    if(($tooBig=$this->tooBig)===null)
        $tooBig=Yii::t('yii','{attribute} is too big (maximum is {max}).');
    $tooBig=strtr($tooBig, array(
        '{attribute}'=>$label,
        '{max}'=>$this->max,
    ));

    if(($tooSmall=$this->tooSmall)===null)
        $tooSmall=Yii::t('yii','{attribute} is too small (minimum is {min}).');
    $tooSmall=strtr($tooSmall, array(
        '{attribute}'=>$label,
        '{min}'=>$this->min,
    ));

    $pattern=$this->integerOnly ? $this->integerPattern : $this->numberPattern;
    $js="
if(!value.match($pattern)) {
messages.push(".CJSON::encode($message).");
}
";
    if($this->min!==null)
    {
        $js.="
if(value<{$this->min}) {
messages.push(".CJSON::encode($tooSmall).");
}
";
    }
    if($this->max!==null)
    {
        $js.="
if(value>{$this->max}) {
messages.push(".CJSON::encode($tooBig).");
}
";
    }

    if($this->allowEmpty)
    {
        $js="
if(jQuery.trim(value)!='') {
$js
}
";
    }

    return $js;
}

Returns the JavaScript needed for performing client-side validation.

See Also

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#76 (show)
protected function validateAttribute($object,$attribute)
{
    $value=$object->$attribute;
    if($this->allowEmpty && $this->isEmpty($value))
        return;
    if(!is_numeric($value))
    {
        // https://github.com/yiisoft/yii/issues/1955
        // https://github.com/yiisoft/yii/issues/1669
        $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be a number.');
        $this->addError($object,$attribute,$message);
        return;
    }
    if($this->integerOnly)
    {
        if(!preg_match($this->integerPattern,"$value"))
        {
            $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be an integer.');
            $this->addError($object,$attribute,$message);
        }
    }
    else
    {
        if(!preg_match($this->numberPattern,"$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.