Class yii\validators\RangeValidator

All Classes | Properties | Methods

Inheritance	yii\validators\RangeValidator » 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/RangeValidator.php

RangeValidator validates that the attribute value is among a list of values.

The range can be specified via the $range property. If the $not property is set true, the validator will ensure the attribute value is NOT among the specified range.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$allowArray	boolean	Whether to allow array type attribute.	yii\validators\RangeValidator
$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\Validator
$not	boolean	Whether to invert the validation logic.	yii\validators\RangeValidator
$on	array\|string	Scenarios that the validator can be applied to.	yii\validators\Validator
$range	array\|Traversable\|Closure	A list of valid values that the attribute value should be among or an anonymous function that returns such a list.	yii\validators\RangeValidator
$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
$strict	boolean	Whether the comparison is strict (both type and value must be the same)	yii\validators\RangeValidator
$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

Hide inherited 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\RangeValidator
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\RangeValidator
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\RangeValidator
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}	yii\validators\RangeValidator
validateAttributes()	Validates the specified object.	yii\validators\Validator

Protected Methods

Hide inherited 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\RangeValidator

Property Details

$allowArray public property

Whether to allow array type attribute.

public boolean $allowArray = false

$not public property

Whether to invert the validation logic. Defaults to false. If set to true, the attribute value should NOT be among the list of values defined via $range.

public boolean $not = false

$range public property

A list of valid values that the attribute value should be among or an anonymous function that returns such a list. The signature of the anonymous function should be as follows,

function($model, $attribute) {
    // compute range
    return $range;
}

public array|Traversable|Closure $range = null

$strict public property

Whether the comparison is strict (both type and value must be the same)

public boolean $strict = false

Method Details

clientValidateAttribute() public method

{@inheritdoc}

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

getClientOptions() public method

{@inheritdoc}

public void getClientOptions ( $model, $attribute )
$model
$attribute

init() public method

{@inheritdoc}

public void init ( )

validateAttribute() public method

{@inheritdoc}

public void validateAttribute ( $model, $attribute )
$model
$attribute

validateValue() protected method

{@inheritdoc}

protected void validateValue ( $value )
$value