0 follower

CValidator

Package system.validators
Inheritance abstract class CValidator » CComponent
Subclasses CBooleanValidator, CCaptchaValidator, CCompareValidator, CDefaultValueValidator, CEmailValidator, CExistValidator, CFileValidator, CFilterValidator, CInlineValidator, CNumberValidator, CRangeValidator, CRegularExpressionValidator, CRequiredValidator, CStringValidator, CTypeValidator, CUniqueValidator, CUrlValidator
Since 1.0
Version $Id$
Source Code framework/validators/CValidator.php
CValidator is the base class for all validators.

Child classes must implement the validateAttribute method.

The following properties are defined in CValidator:
  • attributes: array, list of attributes to be validated;
  • message: string, the customized error message. The message may contain placeholders that will be replaced with the actual content. For example, the "{attribute}" placeholder will be replaced with the label of the problematic attribute. Different validators may define additional placeholders.
  • on: string, in which scenario should the validator be in effect. This is used to match the 'on' parameter supplied when calling CModel::validate.


When using createValidator to create a validator, the following aliases are recognized as the corresponding built-in validator classes:

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
message string the user-defined error message. CValidator
on array list of scenarios that the validator should be applied. CValidator

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 a single attribute. CValidator

Property Details

attributes property
public array $attributes;

list of attributes to be validated.

builtInValidators property
public static array $builtInValidators;

list of built-in validators (name=>class)

message property
public string $message;

the user-defined error message. Different validators may define various placeholders in the message that are to be replaced with actual values. All validators recognize "{attribute}" placeholder, which will be replaced with the label of the attribute.

on property
public array $on;

list of scenarios that the validator should be applied. Each array value refers to a scenario name with the same name as its array key.

Method Details

addError() method
protected void addError(CModel $object, string $attribute, string $message, array $params=array ( ))
$object CModel the data object being validated
$attribute string the attribute being validated
$message string the error message
$params array values for the placeholders in the error message
Source Code: framework/validators/CValidator.php#190 (show)
protected function addError($object,$attribute,$message,$params=array())
{
    $params['{attribute}']=$object->getAttributeLabel($attribute);
    $object->addError($attribute,strtr($message,$params));
}

Adds an error about the specified attribute to the active record. This is a helper method that performs message selection and internationalization.

applyTo() method (available since v1.0.2)
public boolean applyTo(string $scenario)
$scenario string scenario name
{return} boolean whether the validator applies to the specified scenario.
Source Code: framework/validators/CValidator.php#177 (show)
public function applyTo($scenario)
{
    return empty($this->on) || isset($this->on[$scenario]);
}

Returns a value indicating whether the validator applies to the specified scenario. A validator applies to a scenario as long as any of the following conditions is met:

  • the validator's "on" property is empty
  • the validator's "on" property contains the specified scenario
createValidator() method
public static void createValidator(string $name, CModel $object, mixed $attributes, array $params)
$name string the name or class of the validator
$object CModel the data object being validated that may contain the inline validation method
$attributes mixed list of attributes to be validated. This can be either an array of the attribute names or a string of comma-separated attribute names.
$params array initial values to be applied to the validator properties
Source Code: framework/validators/CValidator.php#111 (show)
public static function createValidator($name,$object,$attributes,$params)
{
    if(is_string($attributes))
        $attributes=preg_split('/[\s,]+/',$attributes,-1,PREG_SPLIT_NO_EMPTY);

    if(isset($params['on']))
    {
        if(is_array($params['on']))
            $on=$params['on'];
        else
            $on=preg_split('/[\s,]+/',$params['on'],-1,PREG_SPLIT_NO_EMPTY);
    }
    else
        $on=array();

    if(method_exists($object,$name))
    {
        $validator=new CInlineValidator;
        $validator->attributes=$attributes;
        $validator->method=$name;
        $validator->params=$params;
    }
    else
    {
        $params['attributes']=$attributes;
        if(isset(self::$builtInValidators[$name]))
            $className=Yii::import(self::$builtInValidators[$name],true);
        else
            $className=Yii::import($name,true);
        $validator=new $className;
        foreach($params as $name=>$value)
            $validator->$name=$value;
    }

    $validator->on=empty($on) ? array() : array_combine($on,$on);

    return $validator;
}

Creates a validator object.

isEmpty() method (available since v1.0.9)
protected boolean isEmpty(mixed $value, boolean $trim=false)
$value mixed the value to be checked
$trim boolean whether to perform trimming before checking if the string is empty. Defaults to false.
{return} boolean whether the value is empty
Source Code: framework/validators/CValidator.php#205 (show)
protected function isEmpty($value,$trim=false)
{
    return $value===null || $value===array() || $value==='' || $trim && is_scalar($value) && trim($value)==='';
}

Checks if the given value is empty. A value is considered empty if it is null, an empty array, or the trimmed result is an empty string. Note that this method is different from PHP empty(). It will return false when the value is 0.

validate() method
public void validate(CModel $object, array $attributes=NULL)
$object CModel the data object being validated
$attributes array the list of attributes to be validated. Defaults to null, meaning every attribute listed in attributes will be validated.
Source Code: framework/validators/CValidator.php#156 (show)
public function validate($object,$attributes=null)
{
    if(is_array($attributes))
        $attributes=array_intersect($this->attributes,$attributes);
    else
        $attributes=$this->attributes;
    foreach($attributes as $attribute)
        $this->validateAttribute($object,$attribute);
}

Validates the specified object.

validateAttribute() method
abstract protected void validateAttribute(CModel $object, string $attribute)
$object CModel the data object being validated
$attribute string the name of the attribute to be validated.
Source Code: framework/validators/CValidator.php#100 (show)
abstract protected function validateAttribute($object,$attribute);

Validates a single attribute. This method should be overriden by child classes.