UniqueValidator
- Type
- Class
- Namespace
- craft\validators
- Inherits
- craft\validators\UniqueValidator » yii\validators\UniqueValidator (opens new window) » yii\validators\Validator (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.0.0
Class UniqueValidator.
View source (opens new window)
# Public Properties
# caseInsensitive
- Type
- boolean (opens new window)
- Default value
false
Whether a case-insensitive check should be performed.
View source (opens new window)
# pk
- Type
- string (opens new window), string (opens new window)[]
- Default value
null
If targetClass (opens new window) 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.
View source (opens new window)
# Protected Properties
| Property | Description |
|---|---|
| originalModel | yii\base\Model (opens new window), null (opens new window) – The model that is being validated |
# originalModel
- Type
- yii\base\Model (opens new window), null (opens new window)
- Default value
null
The model that is being validated
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| addError() | Adds an error about the specified attribute to the model object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| clientValidateAttribute() (opens new window) | Returns the JavaScript needed for performing client-side validation. |
| createValidator() (opens new window) | Creates a validator object. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| getAttributeNames() (opens new window) | Returns cleaned attribute names without the ! character at the beginning. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getClientOptions() (opens new window) | Returns the client-side validation options. |
| getValidationAttributes() (opens new window) | Returns a list of attributes this validator applies to. |
| hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| init() (opens new window) | Initializes the object. |
| isActive() (opens new window) | Returns a value indicating whether the validator is active for the given scenario and attribute. |
| isEmpty() (opens new window) | Checks if the given value is empty. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| trigger() (opens new window) | Triggers an event. |
| validate() (opens new window) | Validates a given value. |
| validateAttribute() | Validates a single attribute. |
| validateAttributes() (opens new window) | Validates the specified object. |
# addError()
Adds an error about the specified attribute to the model object.
This is a helper method that performs message selection and internationalization.
View source (opens new window)
Arguments
$model(yii\base\Model (opens new window)) – The data model being validated$attribute(string (opens new window)) – The attribute being validated$message(string (opens new window)) – The error message$params(array (opens new window)) – Values for the placeholders in the error message
# validateAttribute()
Validates a single attribute.
Child classes must implement this method to provide the actual validation logic.
View source (opens new window)
Arguments
$model(yii\base\Model (opens new window)) – The data model to be validated$attribute(string (opens new window)) – The name of the attribute to be validated.
# Protected Methods
| Method | Description |
|---|---|
| formatMessage() (opens new window) | Formats a mesage using the I18N, or simple strtr if \Yii::$app is not available. |
| validateValue() (opens new window) | Validates a value. |