0 follower

CRequiredValidator

Package system.validators
Inheritance class CRequiredValidator » CValidator » CComponent
Since 1.0
Source Code framework/validators/CRequiredValidator.php
CRequiredValidator validates that the specified attribute does not have null or empty 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), CRequiredValidator allows for the following placeholders to be specified:

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
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
message string the user-defined error message. CValidator
on array list of scenarios that the validator should be applied. CValidator
requiredValue mixed the desired value that the attribute must have. CRequiredValidator
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
strict boolean whether the comparison to requiredValue is strict. CRequiredValidator
trim boolean whether the value should be trimmed with php trim() function when comparing strings. CRequiredValidator

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

Property Details

requiredValue property
public mixed $requiredValue;

the desired value that the attribute must have. If this is null, the validator will validate that the specified attribute does not have null or empty value. If this is set as a value that is not null, the validator will validate that the attribute has a value that is the same as this property value. Defaults to null.

strict property
public boolean $strict;

whether the comparison to requiredValue is strict. When this is true, the attribute value and type must both match those of requiredValue. Defaults to false, meaning only the value needs to be matched. This property is only used when requiredValue is not null.

trim property (available since v1.1.14)
public boolean $trim;

whether the value should be trimmed with php trim() function when comparing strings. When set to false, the attribute value is not considered empty when it contains spaces. Defaults to true, meaning the value will be trimmed.

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/CRequiredValidator.php#83 (show)
public function clientValidateAttribute($object,$attribute)
{
    $message=$this->message;
    if($this->requiredValue!==null)
    {
        if($message===null)
            $message=Yii::t('yii','{attribute} must be {value}.');
        $message=strtr($message, array(
            '{value}'=>$this->requiredValue,
            '{attribute}'=>$object->getAttributeLabel($attribute),
        ));
        return "
if(value!=" . CJSON::encode($this->requiredValue) . ") {
messages.push(".CJSON::encode($message).");
}
";
    }
    else
    {
        if($message===null)
            $message=Yii::t('yii','{attribute} cannot be blank.');
        $message=strtr($message, array(
            '{attribute}'=>$object->getAttributeLabel($attribute),
        ));
        if($this->trim)
            $emptyCondition = "jQuery.trim(value)==''";
        else
            $emptyCondition = "value==''";
        return "
if({$emptyCondition}) {
messages.push(".CJSON::encode($message).");
}
";
    }
}

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/CRequiredValidator.php#56 (show)
protected function validateAttribute($object,$attribute)
{
    $value=$object->$attribute;
    if($this->requiredValue!==null)
    {
        if(!$this->strict && $value!=$this->requiredValue || $this->strict && $value!==$this->requiredValue)
        {
            $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be {value}.',
                array('{value}'=>$this->requiredValue));
            $this->addError($object,$attribute,$message);
        }
    }
    elseif($this->isEmpty($value,$this->trim))
    {
        $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} cannot be blank.');
        $this->addError($object,$attribute,$message);
    }
}

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