PHP Class yii\validators\RequiredValidator

Since: 2.0
Author: Qiang Xue ([email protected])
Inheritance: extends Validator
Mostra file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property Type Description
$message 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]]
$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.
$skipOnEmpty whether to skip this validator if the value being validated is empty.
$strict 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 when [[requiredValue]] is null, if this property is true, the validator will check if the attribute value is null; If this property is false, the validator will call [[isEmpty]] to check if the attribute value is empty.

Public Methods

Method Description
clientValidateAttribute ( $model, $attribute, $view )
init ( )

Protected Methods

Method Description
validateValue ( $value )

Method Details

clientValidateAttribute() public method

public clientValidateAttribute ( $model, $attribute, $view )

init() public method

public init ( )

validateValue() protected method

protected validateValue ( $value )

Property Details

$message public_oe property

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]]
public $message

$requiredValue public_oe property

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
public $requiredValue

$skipOnEmpty public_oe property

whether to skip this validator if the value being validated is empty.
public $skipOnEmpty

$strict public_oe property

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 when [[requiredValue]] is null, if this property is true, the validator will check if the attribute value is null; If this property is false, the validator will call [[isEmpty]] to check if the attribute value is empty.
public $strict