Versions
Look up a class, method, property or event

CModel

Package system.base
Inheritance abstract class CModel » CComponent
Implements IteratorAggregate, Traversable, ArrayAccess
Subclasses CActiveRecord, CFormModel
Since 1.0
Source Code framework/base/CModel.php
CModel is the base class providing the common features needed by data model objects.

CModel defines the basic framework for data models that need to be validated.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
attributes array Returns all attribute values. CModel
errors array Returns the errors for all attribute or a single attribute. CModel
iterator CMapIterator Returns an iterator for traversing the attributes in the model. CModel
safeAttributeNames array Returns the attribute names that are safe to be massively assigned. CModel
scenario string Returns the scenario that this model is used in. CModel
validatorList CList Returns all the validators declared in the model. CModel
validators array Returns the validators applicable to the current scenario. CModel

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
addError() Adds a new error to the specified attribute. CModel
addErrors() Adds a list of errors. CModel
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
attributeLabels() Returns the attribute labels. CModel
attributeNames() Returns the list of attribute names of the model. CModel
behaviors() Returns a list of behaviors that this model should behave as. CModel
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
clearErrors() Removes errors for all attributes or a single attribute. CModel
createValidators() Creates validator objects based on the specification in rules. CModel
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
generateAttributeLabel() Generates a user friendly attribute label. CModel
getAttributeLabel() Returns the text label for the specified attribute. CModel
getAttributes() Returns all attribute values. CModel
getError() Returns the first error of the specified attribute. CModel
getErrors() Returns the errors for all attribute or a single attribute. CModel
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getIterator() Returns an iterator for traversing the attributes in the model. CModel
getSafeAttributeNames() Returns the attribute names that are safe to be massively assigned. CModel
getScenario() Returns the scenario that this model is used in. CModel
getValidatorList() Returns all the validators declared in the model. CModel
getValidators() Returns the validators applicable to the current scenario. CModel
hasErrors() Returns a value indicating whether there is any validation error. CModel
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
isAttributeRequired() Returns a value indicating whether the attribute is required. CModel
isAttributeSafe() Returns a value indicating whether the attribute is safe for massive assignments. CModel
offsetExists() Returns whether there is an element at the specified offset. CModel
offsetGet() Returns the element at the specified offset. CModel
offsetSet() Sets the element at the specified offset. CModel
offsetUnset() Unsets the element at the specified offset. CModel
onAfterConstruct() This event is raised after the model instance is created by new operator. CModel
onAfterValidate() This event is raised after the validation is performed. CModel
onBeforeValidate() This event is raised before the validation is performed. CModel
onUnsafeAttribute() This method is invoked when an unsafe attribute is being massively assigned. CModel
raiseEvent() Raises an event. CComponent
rules() Returns the validation rules for attributes. CModel
setAttributes() Sets the attribute values in a massive way. CModel
setScenario() Sets the scenario for the model. CModel
unsetAttributes() Sets the attributes to be null. CModel
validate() Performs the validation. CModel

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
afterConstruct() This method is invoked after a model instance is created by new operator. CModel
afterValidate() This method is invoked after validation ends. CModel
beforeValidate() This method is invoked before validation starts. CModel

Events

Hide inherited events

EventDescriptionDefined By
onAfterConstruct This event is raised after the model instance is created by new operator. CModel
onBeforeValidate This event is raised before the validation is performed. CModel
onAfterValidate This event is raised after the validation is performed. CModel
onUnsafeAttribute This method is invoked when an unsafe attribute is being massively assigned. CModel

Property Details

attributes property
public array getAttributes(array $names=NULL)
public void setAttributes(array $values, boolean $safeOnly=true)

Returns all attribute values.

errors property read-only
public array getErrors(string $attribute=NULL)

Returns the errors for all attribute or a single attribute.

iterator property read-only

Returns an iterator for traversing the attributes in the model. This method is required by the interface IteratorAggregate.

safeAttributeNames property read-only
public array getSafeAttributeNames()

Returns the attribute names that are safe to be massively assigned. A safe attribute is one that is associated with a validation rule in the current scenario.

scenario property
public string getScenario()
public void setScenario(string $value)

Returns the scenario that this model is used in.

Scenario affects how validation is performed and which attributes can be massively assigned.

A validation rule will be performed when calling validate() if its 'except' value does not contain current scenario value while 'on' option is not set or contains the current scenario value.

And an attribute can be massively assigned if it is associated with a validation rule for the current scenario. Note that an exception is the unsafe validator which marks the associated attributes as unsafe and not allowed to be massively assigned.

validatorList property read-only (available since v1.1.2)

Returns all the validators declared in the model. This method differs from getValidators in that the latter would only return the validators applicable to the current scenario. Also, since this method return a CList object, you may manipulate it by inserting or removing validators (useful in behaviors). For example, $model->validatorList->add($newValidator). The change made to the CList object will persist and reflect in the result of the next call of getValidators.

validators property read-only
public array getValidators(string $attribute=NULL)

Returns the validators applicable to the current scenario.

Method Details

addError() method
public void addError(string $attribute, string $error)
$attribute string attribute name
$error string new error message
Source Code: framework/base/CModel.php#381 (show)
public function addError($attribute,$error)
{
    
$this->_errors[$attribute][]=$error;
}

Adds a new error to the specified attribute.

addErrors() method
public void addErrors(array $errors)
$errors array a list of errors. The array keys must be attribute names. The array values should be error messages. If an attribute has multiple errors, these errors must be given in terms of an array. You may use the result of getErrors as the value for this parameter.
Source Code: framework/base/CModel.php#393 (show)
public function addErrors($errors)
{
    foreach(
$errors as $attribute=>$error)
    {
        if(
is_array($error))
        {
            foreach(
$error as $e)
                
$this->addError($attribute$e);
        }
        else
            
$this->addError($attribute$error);
    }
}

Adds a list of errors.

afterConstruct() method
protected void afterConstruct()
Source Code: framework/base/CModel.php#173 (show)
protected function afterConstruct()
{
    if(
$this->hasEventHandler('onAfterConstruct'))
        
$this->onAfterConstruct(new CEvent($this));
}

This method is invoked after a model instance is created by new operator. The default implementation raises the onAfterConstruct event. You may override this method to do postprocessing after model creation. Make sure you call the parent implementation so that the event is raised properly.

afterValidate() method
protected void afterValidate()
Source Code: framework/base/CModel.php#200 (show)
protected function afterValidate()
{
    
$this->onAfterValidate(new CEvent($this));
}

This method is invoked after validation ends. The default implementation calls onAfterValidate to raise an event. You may override this method to do postprocessing after validation. Make sure the parent implementation is invoked so that the event can be raised.

attributeLabels() method
public array attributeLabels()
{return} array attribute labels (name=>label)
Source Code: framework/base/CModel.php#128 (show)
public function attributeLabels()
{
    return array();
}

Returns the attribute labels. Attribute labels are mainly used in error messages of validation. By default an attribute label is generated using generateAttributeLabel. This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions like array_merge().

attributeNames() method
abstract public array attributeNames()
{return} array list of attribute names.
Source Code: framework/base/CModel.php#39 (show)
abstract public function attributeNames();

Returns the list of attribute names of the model.

beforeValidate() method
protected boolean beforeValidate()
{return} boolean whether validation should be executed. Defaults to true. If false is returned, the validation will stop and the model is considered invalid.
Source Code: framework/base/CModel.php#187 (show)
protected function beforeValidate()
{
    
$event=new CModelEvent($this);
    
$this->onBeforeValidate($event);
    return 
$event->isValid;
}

This method is invoked before validation starts. The default implementation calls onBeforeValidate to raise an event. You may override this method to do preliminary checks before validation. Make sure the parent implementation is invoked so that the event can be raised.

behaviors() method
public array behaviors()
{return} array the behavior configurations (behavior name=>behavior configuration)
Source Code: framework/base/CModel.php#111 (show)
public function behaviors()
{
    return array();
}

Returns a list of behaviors that this model should behave as. The return value should be an array of behavior configurations indexed by behavior names. Each behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName'=>array(
    'class'=>'path.to.BehaviorClass',
    'property1'=>'value1',
    'property2'=>'value2',
)


Note, the behavior classes must implement IBehavior or extend from CBehavior. Behaviors declared in this method will be attached to the model when it is instantiated.

For more details about behaviors, see CComponent.

clearErrors() method
public void clearErrors(string $attribute=NULL)
$attribute string attribute name. Use null to remove errors for all attribute.
Source Code: framework/base/CModel.php#411 (show)
public function clearErrors($attribute=null)
{
    if(
$attribute===null)
        
$this->_errors=array();
    else
        unset(
$this->_errors[$attribute]);
}

Removes errors for all attributes or a single attribute.

createValidators() method
public CList createValidators()
{return} CList validators built based on rules().
Source Code: framework/base/CModel.php#281 (show)
public function createValidators()
{
    
$validators=new CList;
    foreach(
$this->rules() as $rule)
    {
        if(isset(
$rule[0],$rule[1]))  // attributes, validator name
            
$validators->add(CValidator::createValidator($rule[1],$this,$rule[0],array_slice($rule,2)));
        else
            throw new 
CException(Yii::t('yii','{class} has an invalid validation rule. The rule must specify attributes to be validated and the validator name.',
                array(
'{class}'=>get_class($this))));
    }
    return 
$validators;
}

Creates validator objects based on the specification in rules. This method is mainly used internally.

generateAttributeLabel() method
public string generateAttributeLabel(string $name)
$name string the column name
{return} string the attribute label
Source Code: framework/base/CModel.php#427 (show)
public function generateAttributeLabel($name)
{
    return 
ucwords(trim(strtolower(str_replace(array('-','_','.'),' ',preg_replace('/(?<![A-Z])[A-Z]/'' \0'$name)))));
}

Generates a user friendly attribute label. This is done by replacing underscores or dashes with blanks and changing the first letter of each word to upper case. For example, 'department_name' or 'DepartmentName' becomes 'Department Name'.

getAttributeLabel() method
public string getAttributeLabel(string $attribute)
$attribute string the attribute name
{return} string the attribute label
Source Code: framework/base/CModel.php#331 (show)
public function getAttributeLabel($attribute)
{
    
$labels=$this->attributeLabels();
    if(isset(
$labels[$attribute]))
        return 
$labels[$attribute];
    else
        return 
$this->generateAttributeLabel($attribute);
}

Returns the text label for the specified attribute.

getAttributes() method
public array getAttributes(array $names=NULL)
$names array list of attributes whose value needs to be returned. Defaults to null, meaning all attributes as listed in attributeNames will be returned. If it is an array, only the attributes in the array will be returned.
{return} array attribute values (name=>value).
Source Code: framework/base/CModel.php#439 (show)
public function getAttributes($names=null)
{
    
$values=array();
    foreach(
$this->attributeNames() as $name)
        
$values[$name]=$this->$name;

    if(
is_array($names))
    {
        
$values2=array();
        foreach(
$names as $name)
            
$values2[$name]=isset($values[$name]) ? $values[$name] : null;
        return 
$values2;
    }
    else
        return 
$values;
}

Returns all attribute values.

getError() method
public string getError(string $attribute)
$attribute string attribute name.
{return} string the error message. Null is returned if no error.
Source Code: framework/base/CModel.php#371 (show)
public function getError($attribute)
{
    return isset(
$this->_errors[$attribute]) ? reset($this->_errors[$attribute]) : null;
}

Returns the first error of the specified attribute.

getErrors() method
public array getErrors(string $attribute=NULL)
$attribute string attribute name. Use null to retrieve errors for all attributes.
{return} array errors for all attributes or the specified attribute. Empty array is returned if no error.
Source Code: framework/base/CModel.php#358 (show)
public function getErrors($attribute=null)
{
    if(
$attribute===null)
        return 
$this->_errors;
    else
        return isset(
$this->_errors[$attribute]) ? $this->_errors[$attribute] : array();
}

Returns the errors for all attribute or a single attribute.

getIterator() method
public CMapIterator getIterator()
{return} CMapIterator an iterator for traversing the items in the list.
Source Code: framework/base/CModel.php#571 (show)
public function getIterator()
{
    
$attributes=$this->getAttributes();
    return new 
CMapIterator($attributes);
}

Returns an iterator for traversing the attributes in the model. This method is required by the interface IteratorAggregate.

getSafeAttributeNames() method
public array getSafeAttributeNames()
{return} array safe attribute names
Source Code: framework/base/CModel.php#543 (show)
public function getSafeAttributeNames()
{
    
$attributes=array();
    
$unsafe=array();
    foreach(
$this->getValidators() as $validator)
    {
        if(!
$validator->safe)
        {
            foreach(
$validator->attributes as $name)
                
$unsafe[]=$name;
        }
        else
        {
            foreach(
$validator->attributes as $name)
                
$attributes[$name]=true;
        }
    }

    foreach(
$unsafe as $name)
        unset(
$attributes[$name]);
    return 
array_keys($attributes);
}

Returns the attribute names that are safe to be massively assigned. A safe attribute is one that is associated with a validation rule in the current scenario.

getScenario() method
public string getScenario()
{return} string the scenario that this model is in.
Source Code: framework/base/CModel.php#523 (show)
public function getScenario()
{
    return 
$this->_scenario;
}

Returns the scenario that this model is used in.

Scenario affects how validation is performed and which attributes can be massively assigned.

A validation rule will be performed when calling validate() if its 'except' value does not contain current scenario value while 'on' option is not set or contains the current scenario value.

And an attribute can be massively assigned if it is associated with a validation rule for the current scenario. Note that an exception is the unsafe validator which marks the associated attributes as unsafe and not allowed to be massively assigned.

getValidatorList() method (available since v1.1.2)
public CList getValidatorList()
{return} CList all the validators declared in the model.
Source Code: framework/base/CModel.php#244 (show)
public function getValidatorList()
{
    if(
$this->_validators===null)
        
$this->_validators=$this->createValidators();
    return 
$this->_validators;
}

Returns all the validators declared in the model. This method differs from getValidators in that the latter would only return the validators applicable to the current scenario. Also, since this method return a CList object, you may manipulate it by inserting or removing validators (useful in behaviors). For example, $model->validatorList->add($newValidator). The change made to the CList object will persist and reflect in the result of the next call of getValidators.

getValidators() method
public array getValidators(string $attribute=NULL)
$attribute string the name of the attribute whose validators should be returned. If this is null, the validators for ALL attributes in the model will be returned.
{return} array the validators applicable to the current scenario.
Source Code: framework/base/CModel.php#257 (show)
public function getValidators($attribute=null)
{
    if(
$this->_validators===null)
        
$this->_validators=$this->createValidators();

    
$validators=array();
    
$scenario=$this->getScenario();
    foreach(
$this->_validators as $validator)
    {
        if(
$validator->applyTo($scenario))
        {
            if(
$attribute===null || in_array($attribute,$validator->attributes,true))
                
$validators[]=$validator;
        }
    }
    return 
$validators;
}

Returns the validators applicable to the current scenario.

hasErrors() method
public boolean hasErrors(string $attribute=NULL)
$attribute string attribute name. Use null to check all attributes.
{return} boolean whether there is any error.
Source Code: framework/base/CModel.php#345 (show)
public function hasErrors($attribute=null)
{
    if(
$attribute===null)
        return 
$this->_errors!==array();
    else
        return isset(
$this->_errors[$attribute]);
}

Returns a value indicating whether there is any validation error.

isAttributeRequired() method
public boolean isAttributeRequired(string $attribute)
$attribute string attribute name
{return} boolean whether the attribute is required
Source Code: framework/base/CModel.php#302 (show)
public function isAttributeRequired($attribute)
{
    foreach(
$this->getValidators($attribute) as $validator)
    {
        if(
$validator instanceof CRequiredValidator)
            return 
true;
    }
    return 
false;
}

Returns a value indicating whether the attribute is required. This is determined by checking if the attribute is associated with a CRequiredValidator validation rule in the current scenario.

isAttributeSafe() method (available since v1.1)
public boolean isAttributeSafe(string $attribute)
$attribute string attribute name
{return} boolean whether the attribute is safe for massive assignments
Source Code: framework/base/CModel.php#318 (show)
public function isAttributeSafe($attribute)
{
    
$attributes=$this->getSafeAttributeNames();
    return 
in_array($attribute,$attributes);
}

Returns a value indicating whether the attribute is safe for massive assignments.

offsetExists() method
public boolean offsetExists(mixed $offset)
$offset mixed the offset to check on
{return} boolean
Source Code: framework/base/CModel.php#583 (show)
public function offsetExists($offset)
{
    return 
property_exists($this,$offset);
}

Returns whether there is an element at the specified offset. This method is required by the interface ArrayAccess.

offsetGet() method
public mixed offsetGet(integer $offset)
$offset integer the offset to retrieve element.
{return} mixed the element at the offset, null if no element is found at the offset
Source Code: framework/base/CModel.php#594 (show)
public function offsetGet($offset)
{
    return 
$this->$offset;
}

Returns the element at the specified offset. This method is required by the interface ArrayAccess.

offsetSet() method
public void offsetSet(integer $offset, mixed $item)
$offset integer the offset to set element
$item mixed the element value
Source Code: framework/base/CModel.php#605 (show)
public function offsetSet($offset,$item)
{
    
$this->$offset=$item;
}

Sets the element at the specified offset. This method is required by the interface ArrayAccess.

offsetUnset() method
public void offsetUnset(mixed $offset)
$offset mixed the offset to unset element
Source Code: framework/base/CModel.php#615 (show)
public function offsetUnset($offset)
{
    unset(
$this->$offset);
}

Unsets the element at the specified offset. This method is required by the interface ArrayAccess.

onAfterConstruct() method
public void onAfterConstruct(CEvent $event)
$event CEvent the event parameter
Source Code: framework/base/CModel.php#209 (show)
public function onAfterConstruct($event)
{
    
$this->raiseEvent('onAfterConstruct',$event);
}

This event is raised after the model instance is created by new operator.

onAfterValidate() method
public void onAfterValidate(CEvent $event)
$event CEvent the event parameter
Source Code: framework/base/CModel.php#227 (show)
public function onAfterValidate($event)
{
    
$this->raiseEvent('onAfterValidate',$event);
}

This event is raised after the validation is performed.

onBeforeValidate() method
public void onBeforeValidate(CModelEvent $event)
$event CModelEvent the event parameter
Source Code: framework/base/CModel.php#218 (show)
public function onBeforeValidate($event)
{
    
$this->raiseEvent('onBeforeValidate',$event);
}

This event is raised before the validation is performed.

onUnsafeAttribute() method (available since v1.1.1)
public void onUnsafeAttribute(string $name, mixed $value)
$name string the unsafe attribute name
$value mixed the attribute value
Source Code: framework/base/CModel.php#500 (show)
public function onUnsafeAttribute($name,$value)
{
    if(
YII_DEBUG)
        
Yii::log(Yii::t('yii','Failed to set unsafe attribute "{attribute}" of "{class}".',array('{attribute}'=>$name'{class}'=>get_class($this))),CLogger::LEVEL_WARNING);
}

This method is invoked when an unsafe attribute is being massively assigned. The default implementation will log a warning message if YII_DEBUG is on. It does nothing otherwise.

rules() method
public array rules()
{return} array validation rules to be applied when validate() is called.
Source Code: framework/base/CModel.php#86 (show)
public function rules()
{
    return array();
}

Returns the validation rules for attributes.

This method should be overridden to declare validation rules. Each rule is an array with the following structure:

array('attribute list', 'validator name', 'on'=>'scenario name', ...validation parameters...)
where
  • attribute list: specifies the attributes (separated by commas) to be validated;
  • validator name: specifies the validator to be used. It can be the name of a model class method, the name of a built-in validator, or a validator class (or its path alias). A validation method must have the following signature:
    // $params refers to validation parameters given in the rule
    function validatorName($attribute,$params)
    
    A built-in validator refers to one of the validators declared in CValidator::builtInValidators. And a validator class is a class extending CValidator.
  • on: this specifies the scenarios when the validation rule should be performed. Separate different scenarios with commas. If this option is not set, the rule will be applied in any scenario that is not listed in "except". Please see scenario for more details about this option.
  • except: this specifies the scenarios when the validation rule should not be performed. Separate different scenarios with commas. Please see scenario for more details about this option.
  • additional parameters are used to initialize the corresponding validator properties. Please refer to individal validator class API for possible properties.


The following are some examples:
array(
    array('username', 'required'),
    array('username', 'length', 'min'=>3, 'max'=>12),
    array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'),
    array('password', 'authenticate', 'on'=>'login'),
);


Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions like array_merge().

See Also

setAttributes() method
public void setAttributes(array $values, boolean $safeOnly=true)
$values array attribute values (name=>value) to be set.
$safeOnly boolean whether the assignments should only be done to the safe attributes. A safe attribute is one that is associated with a validation rule in the current scenario.
Source Code: framework/base/CModel.php#464 (show)
public function setAttributes($values,$safeOnly=true)
{
    if(!
is_array($values))
        return;
    
$attributes=array_flip($safeOnly $this->getSafeAttributeNames() : $this->attributeNames());
    foreach(
$values as $name=>$value)
    {
        if(isset(
$attributes[$name]))
            
$this->$name=$value;
        elseif(
$safeOnly)
            
$this->onUnsafeAttribute($name,$value);
    }
}

Sets the attribute values in a massive way.

setScenario() method
public void setScenario(string $value)
$value string the scenario that this model is in.
Source Code: framework/base/CModel.php#533 (show)
public function setScenario($value)
{
    
$this->_scenario=$value;
}

Sets the scenario for the model.

See Also

unsetAttributes() method (available since v1.1.3)
public void unsetAttributes(array $names=NULL)
$names array list of attributes to be set null. If this parameter is not given, all attributes as specified by attributeNames will have their values unset.
Source Code: framework/base/CModel.php#484 (show)
public function unsetAttributes($names=null)
{
    if(
$names===null)
        
$names=$this->attributeNames();
    foreach(
$names as $name)
        
$this->$name=null;
}

Sets the attributes to be null.

validate() method
public boolean validate(array $attributes=NULL, boolean $clearErrors=true)
$attributes array list of attributes that should be validated. Defaults to null, meaning any attribute listed in the applicable validation rules should be validated. If this parameter is given as a list of attributes, only the listed attributes will be validated.
$clearErrors boolean whether to call clearErrors before performing validation
{return} boolean whether the validation is successful without any error.
Source Code: framework/base/CModel.php#152 (show)
public function validate($attributes=null$clearErrors=true)
{
    if(
$clearErrors)
        
$this->clearErrors();
    if(
$this->beforeValidate())
    {
        foreach(
$this->getValidators() as $validator)
            
$validator->validate($this,$attributes);
        
$this->afterValidate();
        return !
$this->hasErrors();
    }
    else
        return 
false;
}

Performs the validation.

This method executes the validation rules as declared in rules. Only the rules applicable to the current scenario will be executed. A rule is considered applicable to a scenario if its 'on' option is not set or contains the scenario.

Errors found during the validation can be retrieved via getErrors.

Total 4 comments

#8319 report it
marcovtwout at 2012/05/25 08:42am
Rules: setting validator for mulitple scenario's

When using the 'on' attribute when supplying validation rules to your model, both these approaches are valid:

array('phoneNr', 'required', 'on'=>'insert, update'),
array('phoneNr', 'required', 'on'=>array('insert','update')),
#4914 report it
pligor at 2011/08/28 10:27am
Ok this was a little tricky

In the example web app you may have read the code inside LoginForm.php. Inside LoginForm.php there is a custom validator called 'authenticate'.

Notice the

if(!$this->hasErrors())

I was wondering how can it check for errors WHILE inside the validation process. Shouldn't the validation process to finish in order for $this->hasErrors() to work?

Well in fact, must be CLARIFIED inside documentation, that hasErrors() method is simpler than it sounds. It is just testing to see if there are any errors mentioned from the validators which ALREADY ran.

This has an impact if you try to place the custom validator 'authenticate' on higher order inside

public function rules()

Because if you indeed place authenticate on top of the 'required' rule then the $this->hasErrors() stops to have any importance, it will always be false

Could you please embed this clarification inside the documentation above so other users won't get confused in the future? Thank you!

#3402 report it
Francis.TM at 2011/04/10 07:50am
CModel::getErrors() return format:

it will return an array like

array(
   'attr1' => array(
        'errorMessage 1',
        'errorMessage 2',
    ),
    'attr2' => array(
        'errorMessage 3',
        'errorMessage 4',
    ),
);
#3238 report it
zaccaria at 2011/03/28 05:51am
An example of custom validation:

Validate if a number is even, in 2 steps:

The rule:

array('number', 'even'),

And the function:

public function even($attribute,$params)
    {       
        $message=strtr('{attribute} should be even.', array('{attribute}'=>$this->getAttributeLabel($attribute),));
        if ($this->$attribute%2)
            $this->addError($attribute, $message);
    }

Leave a comment

Please to leave your comment.