ArrayValidator
- Type
- Class
- Namespace
- craft\validators
- Inherits
- craft\validators\ArrayValidator » 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 ArrayValidator.
View source (opens new window)
# Public Properties
# count
- Type
- integer (opens new window), array (opens new window), null (opens new window)
- Default value
null
Specifies the count limit of the value to be validated.
This can be specified in one of the following forms:
- an int: the exact count that the value should be of;
- an array of one element: the minimum count that the value should be of. For example,
[8]
. This will overwrite min. - an array of two elements: the minimum and maximum counts that the value should be of.
For example,
[8, 128]
. This will overwrite both min and max.
See also:
- tooFew – for the customized message for a too short array
- tooMany – for the customized message for a too long array
- notEqual – for the customized message for an array that does not match desired count
View source (opens new window)
# max
- Type
- integer (opens new window), null (opens new window)
- Default value
null
Maximum count. If not set, it means no maximum count limit.
See also tooMany – for the customized message for a too long array
View source (opens new window)
# min
- Type
- integer (opens new window), null (opens new window)
- Default value
null
Minimum count. If not set, it means no minimum count limit.
See also tooFew – for the customized message for a too short array
View source (opens new window)
# notEqual
- Type
- string (opens new window), null (opens new window)
- Default value
null
User-defined error message used when the count of the value is not equal to count.
View source (opens new window)
# tooFew
- Type
- string (opens new window), null (opens new window)
- Default value
null
User-defined error message used when the count of the value is smaller than min.
View source (opens new window)
# tooMany
- Type
- string (opens new window), null (opens new window)
- Default value
null
User-defined error message used when the count of the value is greater than max.
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() (opens new window) | 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() | 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() (opens new window) | Validates a single attribute. |
validateAttributes() (opens new window) | Validates the specified object. |
# init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
View source (opens new window)
# Protected Methods
Method | Description |
---|---|
formatMessage() (opens new window) | Formats a mesage using the I18N, or simple strtr if \Yii::$app is not available. |
validateValue() | Validates a value. |
# validateValue()
Validates a value.
A validator class can implement this method to support data validation out of the context of a data model.
View source (opens new window)
Arguments
$value
(mixed
) – The data value to be validated.
Returns
array (opens new window), null (opens new window) – The error message and the array of parameters to be inserted into the error message.
if (!$valid) {
return [$this->message, [
'param1' => $this->param1,
'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
'mimeTypes' => implode(', ', $this->mimeTypes),
'param4' => 'etc...',
]];
}
return null;
for this example message
template can contain {param1}
, {formattedLimit}
, {mimeTypes}
, {param4}
Null should be returned if the data is valid.
Throws
- yii\base\NotSupportedException (opens new window)
if the validator does not supporting data validation without a model