Class yii\validators\RequiredValidator
| Inheritance | yii\validators\RequiredValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/validators/RequiredValidator.php |
RequiredValidator validates that the specified attribute does not have null or empty value.
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 |
| $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 |
| $isEmpty | callable | A PHP callable that replaces the default implementation of isEmpty(). | yii\validators\Validator |
| $message | string | The user-defined error message. | yii\validators\RequiredValidator |
| $on | array|string | Scenarios that the validator can be applied to. | yii\validators\Validator |
| $requiredValue | mixed | The desired value that the attribute must have. | yii\validators\RequiredValidator |
| $skipOnEmpty | boolean | Whether to skip this validator if the value being validated is empty. | yii\validators\RequiredValidator |
| $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 |
| $strict | boolean | Whether the comparison between the attribute value and $requiredValue is strict. | yii\validators\RequiredValidator |
| $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 |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __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 a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| addError() | Adds an error about the specified attribute to the model object. | yii\validators\Validator |
| 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\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| clientValidateAttribute() | {@inheritdoc} | yii\validators\RequiredValidator |
| 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() | {@inheritdoc} | yii\validators\RequiredValidator |
| getValidationAttributes() | Returns a list of attributes this validator applies to. | 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\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | {@inheritdoc} | yii\validators\RequiredValidator |
| 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() | Validates a single attribute. | yii\validators\Validator |
| 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() | {@inheritdoc} | yii\validators\RequiredValidator |
Property Details
The user-defined error message. It may contain the following placeholders which will be replaced accordingly by the validator:
{attribute}: the label of the attribute being validated{value}: the value of the attribute being validated{requiredValue}: the value of $requiredValue
The desired value that the attribute must have. If this is null, the validator will validate that the specified attribute is not empty. If this is set as a value that is not null, the validator will validate that the attribute has a value that is the same as this property value. Defaults to null.
See also $strict.
Whether to skip this validator if the value being validated is empty.
Whether the comparison between the attribute value and $requiredValue is strict. When this is true, both the values and types must match. Defaults to false, meaning only the values need to match.
Note that behavior for when $requiredValue is null is the following:
- In strict mode, the validator will check if the attribute value is null
- In non-strict mode validation will fail
Method Details
{@inheritdoc}
| public void clientValidateAttribute ( $model, $attribute, $view ) | ||
| $model | ||
| $attribute | ||
| $view | ||
{@inheritdoc}
| public void getClientOptions ( $model, $attribute ) | ||
| $model | ||
| $attribute | ||
{@inheritdoc}
| public void init ( ) |
{@inheritdoc}
| protected void validateValue ( $value ) | ||
| $value | ||