0 follower

CStringValidator

Package system.validators
Inheritance class CStringValidator » CValidator » CComponent
Since 1.0
Version $Id$
Source Code framework/validators/CStringValidator.php
CStringValidator validates that the attribute value is of certain length.

Note, this validator should only be used with string-typed attributes.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
allowEmpty boolean whether the attribute value can be null or empty. CStringValidator
attributes array list of attributes to be validated. CValidator
builtInValidators array list of built-in validators (name=>class) CValidator
is integer exact length. CStringValidator
max integer maximum length. CStringValidator
message string the user-defined error message. CValidator
min integer minimum length. CStringValidator
on array list of scenarios that the validator should be applied. CValidator
tooLong string user-defined error message used when the value is too short. CStringValidator
tooShort string user-defined error message used when the value is too long. CStringValidator

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

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.

is property
public integer $is;

exact length. Defaults to null, meaning no exact length limit.

max property
public integer $max;

maximum length. Defaults to null, meaning no maximum limit.

min property
public integer $min;

minimum length. Defaults to null, meaning no minimum limit.

tooLong property
public string $tooLong;

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

tooShort property
public string $tooShort;

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

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/CStringValidator.php#55 (show)
protected function validateAttribute($object,$attribute)
{
    $value=$object->$attribute;
    if($this->allowEmpty && $this->isEmpty($value))
        return;
    $length=strlen($value);
    if($this->min!==null && $length<$this->min)
    {
        $message=$this->tooShort!==null?$this->tooShort:Yii::t('yii','{attribute} is too short (minimum is {min} characters).');
        $this->addError($object,$attribute,$message,array('{min}'=>$this->min));
    }
    if($this->max!==null && $length>$this->max)
    {
        $message=$this->tooLong!==null?$this->tooLong:Yii::t('yii','{attribute} is too long (maximum is {max} characters).');
        $this->addError($object,$attribute,$message,array('{max}'=>$this->max));
    }
    if($this->is!==null && $length!==$this->is)
    {
        $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} is of the wrong length (should be {length} characters).');
        $this->addError($object,$attribute,$message,array('{length}'=>$this->is));
    }
}

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