0 follower

CStringValidator

Package system.validators
Inheritance class CStringValidator » CValidator » CComponent
Since 1.0
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.

In addition to the message property for setting a custom error message, CStringValidator has a couple custom error messages you can set that correspond to different validation scenarios. For defining a custom message when the string is too short, you may use the tooShort property. Similarly with tooLong. The messages may contain placeholders that will be replaced with the actual content. In addition to the "{attribute}" placeholder, recognized by all validators (see CValidator), CStringValidator allows for the following placeholders to be specified:
  • {min}: when using tooShort, replaced with minimum length, min, if set.
  • {max}: when using tooLong, replaced with the maximum length, max, if set.
  • {length}: when using message, replaced with the exact required length, is, if set.

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
enableClientValidation boolean whether to perform client-side validation. CValidator
encoding string the encoding of the string value to be validated (e.g. 'UTF-8'). CStringValidator
except array list of scenarios that the validator should not be applied to. 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
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
tooLong string user-defined error message used when the value is too long. CStringValidator
tooShort string user-defined error message used when the value is too short. 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
clientValidateAttribute() Returns the JavaScript needed for performing client-side validation. CStringValidator
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. 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.

encoding property (available since v1.1.1)
public string $encoding;

the encoding of the string value to be validated (e.g. 'UTF-8'). This property is used only when mbstring PHP extension is enabled. The value of this property will be used as the 2nd parameter of the mb_strlen() function. If this property is not set, the application charset will be used. If this property is set false, then strlen() will be used even if mbstring is enabled.

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

tooShort property
public string $tooShort;

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

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/CStringValidator.php#120 (show)
public function clientValidateAttribute($object,$attribute)
{
    $label=$object->getAttributeLabel($attribute);

    if(($message=$this->message)===null)
        $message=Yii::t('yii','{attribute} is of the wrong length (should be {length} characters).');
    $message=strtr($message, array(
        '{attribute}'=>$label,
        '{length}'=>$this->is,
    ));

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

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

    $js='';
    if($this->min!==null)
    {
        $js.="
if(value.length<{$this->min}) {
messages.push(".CJSON::encode($tooShort).");
}
";
    }
    if($this->max!==null)
    {
        $js.="
if(value.length>{$this->max}) {
messages.push(".CJSON::encode($tooLong).");
}
";
    }
    if($this->is!==null)
    {
        $js.="
if(value.length!={$this->is}) {
messages.push(".CJSON::encode($message).");
}
";
    }

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

    if(is_array($value))
    {
        // https://github.com/yiisoft/yii/issues/1955
        $this->addError($object,$attribute,Yii::t('yii','{attribute} is invalid.'));
        return;
    }

    if(function_exists('mb_strlen') && $this->encoding!==false)
        $length=mb_strlen((string)$value, $this->encoding ? $this->encoding : Yii::app()->charset);
    else
        $length=strlen((string)$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.