Class craft\validators\UniqueValidator

Inheritance: craft\validators\UniqueValidator » yii\validators\UniqueValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/validators/UniqueValidator.php

Class UniqueValidator.

Public Properties
Property	Type	Description	Defined By
`$attributes`	array, string	Attributes to be validated by this validator.	yii\validators\Validator
`$builtInValidators`	array	List of built-in validators (name => class or configuration)	yii\validators\Validator
`$comboNotUnique`	string		yii\validators\UniqueValidator
`$enableClientValidation`	boolean	Whether to enable client-side validation for this validator.	yii\validators\Validator
`$except`	array, string	Scenarios that the validator should not be applied to.	yii\validators\Validator
`$filter`	string, array, Closure	Additional filter to be applied to the DB query used to check the uniqueness of the attribute value.	yii\validators\UniqueValidator
`$forceMasterDb`	boolean	Whether this validator is forced to always use master DB	yii\validators\UniqueValidator
`$isEmpty`	callable	A PHP callable that replaces the default implementation of isEmpty().	yii\validators\Validator
`$message`	string	The user-defined error message.	yii\validators\UniqueValidator
`$on`	array, string	Scenarios that the validator can be applied to.	yii\validators\Validator
`$pk`	string, string[]	If $targetClass is set, this defines the model attributes that represent the record's primary key(s).	craft\validators\UniqueValidator
`$skipOnEmpty`	boolean	Whether this validation rule should be skipped if the attribute value is null or an empty string.	yii\validators\Validator
`$skipOnError`	boolean	Whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules.	yii\validators\Validator
`$targetAttribute`	string, array	The name of the ActiveRecord attribute that should be used to validate the uniqueness of the current attribute value.	yii\validators\UniqueValidator
`$targetAttributeJunction`	string	And\|or define how target attributes are related	yii\validators\UniqueValidator
`$targetClass`	string	The name of the ActiveRecord class that should be used to validate the uniqueness of the current attribute value.	yii\validators\UniqueValidator
`$when`	callable	A PHP callable whose return value determines whether this validator should be applied.	yii\validators\Validator
`$whenClient`	string	A JavaScript function name whose return value determines whether this validator should be applied on the client-side.	yii\validators\Validator

Protected Properties
Property	Type	Description	Defined By
`$originalModel`	yii\base\Model, null	The model that is being validated	craft\validators\UniqueValidator

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`addError()`	Adds an error about the specified attribute to the model object.	craft\validators\UniqueValidator
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`behaviors()`	Returns a list of behaviors that this component should behave as.	yii\base\Component
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`clientValidateAttribute()`	Returns the JavaScript needed for performing client-side validation.	yii\validators\Validator
`createValidator()`	Creates a validator object.	yii\validators\Validator
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`getAttributeNames()`	Returns cleaned attribute names without the `!` character at the beginning.	yii\validators\Validator
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getClientOptions()`	Returns the client-side validation options.	yii\validators\Validator
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	yii\base\BaseObject
`isActive()`	Returns a value indicating whether the validator is active for the given scenario and attribute.	yii\validators\Validator
`isEmpty()`	Checks if the given value is empty.	yii\validators\Validator
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`on()`	Attaches an event handler to an event.	yii\base\Component
`trigger()`	Triggers an event.	yii\base\Component
`validate()`	Validates a given value.	yii\validators\Validator
`validateAttribute()`	{@inheritdoc}	craft\validators\UniqueValidator
`validateAttributes()`	Validates the specified object.	yii\validators\Validator

Protected Methods
Method	Description	Defined By
`formatMessage()`	Formats a mesage using the I18N, or simple strtr if `\Yii::$app` is not available.	yii\validators\Validator
`validateValue()`	Validates a value.	yii\validators\Validator

Property Details

`$originalModel` protected property #

The model that is being validated

protected yii\base\Model, null $originalModel = null

`$pk` public property #

If $targetClass is set, this defines the model attributes that represent the record's primary key(s). Can be set to a string or array of strings of model attributes in the same respective order as the primary keys defined by the record's primaryKey() method, or can be set to an array of attribute/PK pairs, which explicitly maps model attributes to record primary keys. Defaults to whatever the record's primaryKey() method returns.

public string, string[] $pk = null

Method Details

`addError()` public method #

Adds an error about the specified attribute to the model object.

This is a helper method that performs message selection and internationalization.

public void addError ( $model, $attribute, $message, $params = [] )

`$model`	yii\base\Model	The data model being validated
`$attribute`	string	The attribute being validated
`$message`	string	The error message
`$params`	array	Values for the placeholders in the error message

`validateAttribute()` public method #

{@inheritdoc}

public void validateAttribute ( $model, $attribute )

`$model`
`$attribute`

Property Details

$originalModel protected property #

$pk public property #

Method Details

addError() public method #

validateAttribute() public method #

`$originalModel` protected property #

`$pk` public property #

`addError()` public method #

`validateAttribute()` public method #