0 follower

CExistValidator

Package system.validators
Inheritance class CExistValidator » CValidator » CComponent
Source Code framework/validators/CExistValidator.php
CExistValidator validates that the attribute value exists in a table.

This validator is often used to verify that a foreign key contains a value that can be found in the foreign table.

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), CExistValidator allows for the following placeholders to be specified:
  • {value}: replaced with value of the attribute.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
allowEmpty boolean whether the attribute value can be null or empty. CExistValidator
attributeName string the ActiveRecord class attribute name that should be used to look for the attribute value being validated. CExistValidator
attributes array list of attributes to be validated. CValidator
builtInValidators array list of built-in validators (name=>class) CValidator
caseSensitive boolean whether the comparison is case sensitive. CExistValidator
className string the ActiveRecord class name that should be used to look for the attribute value being validated. CExistValidator
criteria mixed additional query criteria. CExistValidator
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
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

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. CValidator
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
getModel() Given active record class name returns new model instance. CExistValidator
isEmpty() Checks if the given value is empty. CValidator
validateAttribute() Validates the attribute of the object. CExistValidator

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.

attributeName property
public string $attributeName;

the ActiveRecord class attribute name that should be used to look for the attribute value being validated. Defaults to null, meaning using the name of the attribute being validated.

See Also

caseSensitive property
public boolean $caseSensitive;

whether the comparison is case sensitive. Defaults to true. Note, by setting it to false, you are assuming the attribute type is string.

className property
public string $className;

the ActiveRecord class name that should be used to look for the attribute value being validated. Defaults to null, meaning using the ActiveRecord class of the attribute being validated. You may use path alias to reference a class name here.

See Also

criteria property
public mixed $criteria;

additional query criteria. Either an array or CDbCriteria. This will be combined with the condition that checks if the attribute value exists in the corresponding table column. This array will be used to instantiate a CDbCriteria object.

Method Details

getModel() method (available since v1.1.14)
protected CActiveRecord getModel(string $className)
$className string active record class name.
{return} CActiveRecord active record model instance.
Source Code: framework/validators/CExistValidator.php#115 (show)
protected function getModel($className)
{
    return CActiveRecord::model($className);
}

Given active record class name returns new model instance.

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/CExistValidator.php#70 (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;
    }

    $className=$this->className===null?get_class($object):Yii::import($this->className);
    $attributeName=$this->attributeName===null?$attribute:$this->attributeName;
    $finder=$this->getModel($className);
    $table=$finder->getTableSchema();
    if(($column=$table->getColumn($attributeName))===null)
        throw new CException(Yii::t('yii','Table "{table}" does not have a column named "{column}".',
            array('{column}'=>$attributeName,'{table}'=>$table->name)));

    $columnName=$column->rawName;
    $criteria=new CDbCriteria();
    if($this->criteria!==array())
        $criteria->mergeWith($this->criteria);
    $tableAlias = empty($criteria->alias) ? $finder->getTableAlias(true) : $criteria->alias;
    $valueParamName = CDbCriteria::PARAM_PREFIX.CDbCriteria::$paramCount++;
    $criteria->addCondition($this->caseSensitive ? "{$tableAlias}.{$columnName}={$valueParamName}" : "LOWER({$tableAlias}.{$columnName})=LOWER({$valueParamName})");
    $criteria->params[$valueParamName] = $value;

    if(!$finder->exists($criteria))
    {
        $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} "{value}" is invalid.');
        $this->addError($object,$attribute,$message,array('{value}'=>$value));
    }
}

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