HumHub Documentation (unofficial)

IpValidator extends Validator
in package

Application

The validator checks if the attribute value is a valid IPv4/IPv6 address or subnet.

It also may change attribute's value if normalization of IPv6 expansion is enabled.

The following are examples of validation rules using this validator:

['ip_address', 'ip'], // IPv4 or IPv6 address
['ip_address', 'ip', 'ipv6' => false], // IPv4 address (IPv6 is disabled)
['ip_address', 'ip', 'subnet' => true], // requires a CIDR prefix (like 10.0.0.1/24) for the IP address
['ip_address', 'ip', 'subnet' => null], // CIDR prefix is optional
['ip_address', 'ip', 'subnet' => null, 'normalize' => true], // CIDR prefix is optional and will be added when missing
['ip_address', 'ip', 'ranges' => ['192.168.0.0/24']], // only IP addresses from the specified subnet are allowed
['ip_address', 'ip', 'ranges' => ['!192.168.0.0/24', 'any']], // any IP is allowed except IP in the specified subnet
['ip_address', 'ip', 'expandIPv6' => true], // expands IPv6 address to a full notation format

Constants

NEGATION_CHAR = '!': Negation char.

Properties

$attributeNames : array<string|int, mixed>
$attributes : array<string|int, mixed>|string
$behaviors : array<string|int, Behavior>
$builtInValidators : array<string|int, mixed>
$enableClientValidation : bool
$except : array<string|int, mixed>|string
$expandIPv6 : bool
$hasSubnet : string
$ipv4 : bool
$ipv4NotAllowed : string
$ipv4Pattern : string
$ipv6 : bool
$ipv6NotAllowed : string
$ipv6Pattern : string
$isEmpty : callable|null
$message : string
$negation : bool
$networks : array<string|int, mixed>
$normalize : bool
$noSubnet : string|null
$notInRange : string
$on : array<string|int, mixed>|string
$ranges : array<string|int, mixed>
$skipOnEmpty : bool
$skipOnError : bool
$subnet : bool|null
$validationAttributes : array<string|int, mixed>|null
$when : callable|null
$whenClient : string|null
$wrongCidr : string
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_ranges : array<string|int, mixed>

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
addError() : mixed: Adds an error about the specified attribute to the model object.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
clientValidateAttribute() : string|null: Returns the JavaScript needed for performing client-side validation.
createValidator() : Validator: Creates a validator object.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getAttributeNames() : array<string|int, mixed>: Returns cleaned attribute names without the `!` character at the beginning.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getClientOptions() : array<string|int, mixed>: Returns the client-side validation options.
getRanges() : array<string|int, mixed>
getValidationAttributes() : array<string|int, mixed>|null: Returns a list of attributes this validator applies to.
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
isActive() : bool: Returns a value indicating whether the validator is active for the given scenario and attribute.
isEmpty() : bool: Checks if the given value is empty.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
setRanges() : mixed: Set the IPv4 or IPv6 ranges that are allowed or forbidden.
trigger() : mixed: Triggers an event.
validate() : bool: Validates a given value.
validateAttribute() : mixed: Validates a single attribute.
validateAttributes() : mixed: Validates the specified object.
formatMessage() : string: Formats a mesage using the I18N, or simple strtr if `\Yii::$app` is not available.
validateIPv4() : bool: Validates IPv4 address.
validateIPv6() : bool: Validates IPv6 address.
validateValue() : array<string|int, mixed>|null: Validates a value.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.
expandIPv6() : string: Expands an IPv6 address to it's full notation.
getIpParsePattern() : string: Used to get the Regexp pattern for initial IP address parsing.
getIpVersion() : int: Gets the IP version.
inRange() : bool: Checks whether the IP is in subnet range.
isAllowed() : bool: The method checks whether the IP address with specified CIDR is allowed according to the [[ranges]] list.
parseNegatedRange() : array<string|int, mixed>: Parses IP address/range for the negation with [[NEGATION_CHAR]].
prepareRanges() : array<string|int, mixed>: Prepares array to fill in [[ranges]].
validateSubnet() : string|array<string|int, mixed>: Validates an IPv4/IPv6 address or subnet.

NEGATION_CHAR

Negation char.


    public
        mixed
    NEGATION_CHAR
    = '!'

Used to negate [[ranges]] or [[networks]] or to negate validating value when [[negation]] is set to true.

$attributeNames read-only


    public
        array<string|int, mixed>
    $attributeNames

Attribute names.

$attributes


    public
        array<string|int, mixed>|string
    $attributes
     = []

attributes to be validated by this validator. For multiple attributes, please specify them as an array; for single attribute, you may use either a string or an array.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$builtInValidators


    public
    static    array<string|int, mixed>
    $builtInValidators
     = ['boolean' => 'yii\validators\BooleanValidator', 'captcha' => 'yii\captcha\CaptchaValidator', 'compare' => 'yii\validators\CompareValidator', 'date' => 'yii\validators\DateValidator', 'datetime' => ['class' => 'yii\validators\DateValidator', 'type' => \yii\validators\DateValidator::TYPE_DATETIME], 'time' => ['class' => 'yii\validators\DateValidator', 'type' => \yii\validators\DateValidator::TYPE_TIME], 'default' => 'yii\validators\DefaultValueValidator', 'double' => 'yii\validators\NumberValidator', 'each' => 'yii\validators\EachValidator', 'email' => 'yii\validators\EmailValidator', 'exist' => 'yii\validators\ExistValidator', 'file' => 'yii\validators\FileValidator', 'filter' => 'yii\validators\FilterValidator', 'image' => 'yii\validators\ImageValidator', 'in' => 'yii\validators\RangeValidator', 'integer' => ['class' => 'yii\validators\NumberValidator', 'integerOnly' => true], 'match' => 'yii\validators\RegularExpressionValidator', 'number' => 'yii\validators\NumberValidator', 'required' => 'yii\validators\RequiredValidator', 'safe' => 'yii\validators\SafeValidator', 'string' => 'yii\validators\StringValidator', 'trim' => ['class' => 'yii\validators\TrimValidator', 'skipOnArray' => true], 'unique' => 'yii\validators\UniqueValidator', 'url' => 'yii\validators\UrlValidator', 'ip' => 'yii\validators\IpValidator']

list of built-in validators (name => class or configuration)

$enableClientValidation


    public
        bool
    $enableClientValidation
     = true

whether to enable client-side validation for this validator. The actual client-side validation is done via the JavaScript code returned by [[clientValidateAttribute()]]. If that method returns null, even if this property is true, no client-side validation will be done by this validator.

$except


    public
        array<string|int, mixed>|string
    $except
     = []

scenarios that the validator should not be applied to. For multiple scenarios, please specify them as an array; for single scenario, you may use either a string or an array.

$expandIPv6


    public
        bool
    $expandIPv6
     = false

whether to expand an IPv6 address to the full notation format. Defaults to false.

$hasSubnet


    public
        string
    $hasSubnet

user-defined error message is used when validation fails due to [[subnet]] is false, but CIDR prefix is present.

You may use the following placeholders in the message:

{attribute}: the label of the attribute being validated
{value}: the value of the attribute being validated

$ipv4


    public
        bool
    $ipv4
     = true

whether the validating value can be an IPv4 address. Defaults to true.

$ipv4NotAllowed


    public
        string
    $ipv4NotAllowed

user-defined error message is used when validation fails due to the disabled IPv4 validation.

You may use the following placeholders in the message:

{attribute}: the label of the attribute being validated
{value}: the value of the attribute being validated

$ipv4Pattern


    public
        string
    $ipv4Pattern
     = '/^(?:(?:2(?:[0-4]\d|5[0-5])|[0-1]?\d?\d)\.){3}(?:(?:2([0-4]\d|5[0-5])|[0-1]?\d?\d))$/'

Regexp-pattern to validate IPv4 address

$ipv6


    public
        bool
    $ipv6
     = true

whether the validating value can be an IPv6 address. Defaults to true.

$ipv6NotAllowed


    public
        string
    $ipv6NotAllowed

user-defined error message is used when validation fails due to the disabled IPv6 validation.

You may use the following placeholders in the message:

{attribute}: the label of the attribute being validated
{value}: the value of the attribute being validated

$ipv6Pattern


    public
        string
    $ipv6Pattern
     = '/^(([\da-fA-F]{1,4}:){7}[\da-fA-F]{1,4}|([\da-fA-F]{1,4}:){1,7}:|([\da-fA-F]{1,4}:){1,6}:[\da-fA-F]{1,4}|([\da-fA-F]{1,4}:){1,5}(:[\da-fA-F]{1,4}){1,2}|([\da-fA-F]{1,4}:){1,4}(:[\da-fA-F]{1,4}){1,3}|([\da-fA-F]{1,4}:){1,3}(:[\da-fA-F]{1,4}){1,4}|([\da-fA-F]{1,4}:){1,2}(:[\da-fA-F]{1,4}){1,5}|[\da-fA-F]{1,4}:((:[\da-fA-F]{1,4}){1,6})|:((:[\da-fA-F]{1,4}){1,7}|:)|fe80:(:[\da-fA-F]{0,4}){0,4}%[\da-zA-Z]+|::(ffff(:0{1,4})?:)?((25[0-5]|(2[0-4]|1?\d)?\d)\.){3}(25[0-5]|(2[0-4]|1?\d)?\d)|([\da-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1?[\d])?\d)\.){3}(25[0-5]|(2[0-4]|1?\d)?\d))$/'

Regexp-pattern to validate IPv6 address

$isEmpty


    public
        callable|null
    $isEmpty

a PHP callable that replaces the default implementation of [[isEmpty()]]. If not set, [[isEmpty()]] will be used to check if a value is empty. The signature of the callable should be function ($value) which returns a boolean indicating whether the value is empty.

$message


    public
        string
    $message

user-defined error message is used when validation fails due to the wrong IP address format.

You may use the following placeholders in the message:

{attribute}: the label of the attribute being validated
{value}: the value of the attribute being validated

$negation


    public
        bool
    $negation
     = false

whether address may have a [[NEGATION_CHAR]] character at the beginning. Defaults to false.

$networks


    public
        array<string|int, mixed>
    $networks
     = ['*' => ['any'], 'any' => ['0.0.0.0/0', '::/0'], 'private' => ['10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16', 'fd00::/8'], 'multicast' => ['224.0.0.0/4', 'ff00::/8'], 'linklocal' => ['169.254.0.0/16', 'fe80::/10'], 'localhost' => ['127.0.0.0/8', '::1'], 'documentation' => ['192.0.2.0/24', '198.51.100.0/24', '203.0.113.0/24', '2001:db8::/32'], 'system' => ['multicast', 'linklocal', 'localhost', 'documentation']]

The network aliases, that can be used in [[ranges]].

key - alias name
value - array of strings. String can be an IP range, IP address or another alias. String can be negated with [[NEGATION_CHAR]] (independent of negation option).

The following aliases are defined by default:

*: any
any: 0.0.0.0/0, ::/0
private: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fd00::/8
multicast: 224.0.0.0/4, ff00::/8
linklocal: 169.254.0.0/16, fe80::/10
localhost: 127.0.0.0/8', ::1
documentation: 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24, 2001:db8::/32
system: multicast, linklocal, localhost, documentation

$normalize


    public
        bool
    $normalize
     = false

whether to add the CIDR prefix with the smallest length (32 for IPv4 and 128 for IPv6) to an address without it. Works only when subnet is not false. For example:

10.0.1.5 will normalized to 10.0.1.5/32
2008:db0::1 will be normalized to 2008:db0::1/128 Defaults to false.

$noSubnet


    public
        string|null
    $noSubnet

user-defined error message is used when validation fails due to subnet [[subnet]] set to 'only', but the CIDR prefix is not set.

You may use the following placeholders in the message:

{attribute}: the label of the attribute being validated
{value}: the value of the attribute being validated

$notInRange


    public
        string
    $notInRange

user-defined error message is used when validation fails due to IP address is not not allowed by [[ranges]] check.

You may use the following placeholders in the message:

{attribute}: the label of the attribute being validated
{value}: the value of the attribute being validated

$on


    public
        array<string|int, mixed>|string
    $on
     = []

scenarios that the validator can be applied to. For multiple scenarios, please specify them as an array; for single scenario, you may use either a string or an array.

$ranges


    public
        array<string|int, mixed>
    $ranges

The IPv4 or IPv6 ranges that are allowed or forbidden. Note that the type of this property differs in getter and setter. See [[getRanges()]] and [[setRanges()]] for details.

$skipOnEmpty


    public
        bool
    $skipOnEmpty
     = true

whether this validation rule should be skipped if the attribute value is null or an empty string. This property is used only when validating [[yii\base\Model]].

$skipOnError


    public
        bool
    $skipOnError
     = true

whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules. Defaults to true.

$subnet


    public
        bool|null
    $subnet
     = false

whether the address can be an IP with CIDR subnet, like 192.168.10.0/24. The following values are possible:

false - the address must not have a subnet (default).
true - specifying a subnet is required.
null - specifying a subnet is optional.

$validationAttributes read-only


    public
        array<string|int, mixed>|null
    $validationAttributes

List of attribute names.

$when


    public
        callable|null
    $when

a PHP callable whose return value determines whether this validator should be applied. The signature of the callable should be function ($model, $attribute), where $model and $attribute refer to the model and the attribute currently being validated. The callable should return a boolean value.

This property is mainly provided to support conditional validation on the server-side. If this property is not set, this validator will be always applied on the server-side.

The following example will enable the validator only when the country currently selected is USA:

function ($model) {
    return $model->country == Country::USA;
}

$whenClient


    public
        string|null
    $whenClient

a JavaScript function name whose return value determines whether this validator should be applied on the client-side. The signature of the function should be function (attribute, value), where attribute is an object describing the attribute being validated (see [[clientValidateAttribute()]]) and value the current value of the attribute.

This property is mainly provided to support conditional validation on the client-side. If this property is not set, this validator will be always applied on the client-side.

The following example will enable the validator only when the country currently selected is USA:

function (attribute, value) {
    return $('#country').val() === 'USA';
}

$wrongCidr


    public
        string
    $wrongCidr

user-defined error message is used when validation fails due to the wrong CIDR.

You may use the following placeholders in the message:

{attribute}: the label of the attribute being validated
{value}: the value of the attribute being validated

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_ranges


    private
        array<string|int, mixed>
    $_ranges
     = []

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

$name : string: the property name

addError()

Adds an error about the specified attribute to the model object.


    public
                    addError(Model $model, string $attribute, string $message[, array<string|int, mixed> $params = [] ]) : mixed

This is a helper method that performs message selection and internationalization.

Parameters

$model : Model: the data model being validated
$attribute : string: the attribute being validated
$message : string: the error message
$params : array<string|int, mixed> = []: values for the placeholders in the error message

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

clientValidateAttribute()

Returns the JavaScript needed for performing client-side validation.


    public
                    clientValidateAttribute(mixed $model, mixed $attribute, mixed $view) : string|null

Parameters

$model : mixed: the data model being validated
$attribute : mixed: the name of the attribute to be validated.
$view : mixed: the view object that is going to be used to render views or view files containing a model form with this validator applied.

Return values

string|null —

the client-side validation script. Null if the validator does not support client-side validation.

createValidator()

Creates a validator object.


    public
            static        createValidator(string|Closure $type, Model $model, array<string|int, mixed>|string $attributes[, array<string|int, mixed> $params = [] ]) : Validator

Parameters

$type : string|Closure

the validator type. This can be either:

a built-in validator name listed in [[builtInValidators]];
a method name of the model class;
an anonymous function;
a validator class name.

$model : Model

the data model to be validated.

$attributes : array<string|int, mixed>|string

list of attributes to be validated. This can be either an array of the attribute names or a string of comma-separated attribute names.

$params : array<string|int, mixed> = []

initial values to be applied to the validator properties.

Return values

Validator —

the validator

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

getAttributeNames()

Returns cleaned attribute names without the `!` character at the beginning.


    public
                    getAttributeNames() : array<string|int, mixed>

Return values

array<string|int, mixed> —

attribute names.

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getClientOptions()

Returns the client-side validation options.


    public
                    getClientOptions(mixed $model, mixed $attribute) : array<string|int, mixed>

Parameters

$model : mixed: the model being validated
$attribute : mixed: the attribute name being validated

Return values

array<string|int, mixed> —

the client-side validation options

getRanges()


    public
                    getRanges() : array<string|int, mixed>

Return values

array<string|int, mixed> —

The IPv4 or IPv6 ranges that are allowed or forbidden.

getValidationAttributes()

Returns a list of attributes this validator applies to.


    public
                    getValidationAttributes([array<string|int, mixed>|string|null $attributes = null ]) : array<string|int, mixed>|null

Parameters

$attributes : array<string|int, mixed>|string|null = null

the list of attributes to be validated.

If this is null, the result will be equal to [[getAttributeNames()]].
If this is a string or an array, the intersection of [[getAttributeNames()]] and the specified attributes will be returned.

Return values

array<string|int, mixed>|null —

list of attribute names.

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

isActive()

Returns a value indicating whether the validator is active for the given scenario and attribute.


    public
                    isActive(string $scenario) : bool

A validator is active if

the validator's on property is empty, or
the validator's on property contains the specified scenario

Parameters

$scenario : string: scenario name

Return values

bool —

whether the validator applies to the specified scenario.

isEmpty()

Checks if the given value is empty.


    public
                    isEmpty(mixed $value) : bool

A value is considered empty if it is null, an empty array, or an empty string. Note that this method is different from PHP empty(). It will return false when the value is 0.

Parameters

$value : mixed: the value to be checked

Return values

bool —

whether the value is empty

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

setRanges()

Set the IPv4 or IPv6 ranges that are allowed or forbidden.


    public
                    setRanges(array<string|int, mixed>|string|null $ranges) : mixed

The following preparation tasks are performed:

Recursively substitutes aliases (described in [[networks]]) with their values.
Removes duplicates

Parameters

$ranges : array<string|int, mixed>|string|null

the IPv4 or IPv6 ranges that are allowed or forbidden.

When the array is empty, or the option not set, all IP addresses are allowed.

Otherwise, the rules are checked sequentially until the first match is found. An IP address is forbidden, when it has not matched any of the rules.

Example:

[
     'ranges' => [
         '192.168.10.128'
         '!192.168.10.0/24',
         'any' // allows any other IP addresses
     ]
]

In this example, access is allowed for all the IPv4 and IPv6 addresses excluding the 192.168.10.0/24 subnet. IPv4 address 192.168.10.128 is also allowed, because it is listed before the restriction.

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

validate()

Validates a given value.


    public
                    validate(mixed $value[, string|null &$error = null ]) : bool

You may use this method to validate a value out of the context of a data model.

Parameters

$value : mixed: the data value to be validated.
$error : string|null = null: the error message to be returned, if the validation fails.

Return values

bool —

whether the data is valid.

validateAttribute()

Validates a single attribute.


    public
                    validateAttribute(mixed $model, mixed $attribute) : mixed

Parameters

$model : mixed: the data model to be validated
$attribute : mixed: the name of the attribute to be validated.

validateAttributes()

Validates the specified object.


    public
                    validateAttributes(Model $model[, array<string|int, mixed>|string|null $attributes = null ]) : mixed

Parameters

$model : Model: the data model being validated
$attributes : array<string|int, mixed>|string|null = null: the list of attributes to be validated. Note that if an attribute is not associated with the validator - it will be ignored. If this parameter is null, every attribute listed in [[attributes]] will be validated.

formatMessage()

Formats a mesage using the I18N, or simple strtr if `\Yii::$app` is not available.


    protected
                    formatMessage(string $message, array<string|int, mixed> $params) : string

Parameters

$message : string
$params : array<string|int, mixed>

Return values

string

validateIPv4()

Validates IPv4 address.


    protected
                    validateIPv4(string $value) : bool

Parameters

$value : string

Return values

bool

validateIPv6()

Validates IPv6 address.


    protected
                    validateIPv6(string $value) : bool

Parameters

$value : string

Return values

bool

validateValue()

Validates a value.


    protected
                    validateValue(mixed $value) : array<string|int, mixed>|null

Parameters

$value : mixed: the data value to be validated.

Return values

array<string|int, mixed>|null —

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.

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

expandIPv6()

Expands an IPv6 address to it's full notation.


    private
                    expandIPv6(string $ip) : string

For example 2001:db8::1 will be expanded to 2001:0db8:0000:0000:0000:0000:0000:0001.

Parameters

$ip : string: the original IPv6

Return values

string —

the expanded IPv6

getIpParsePattern()

Used to get the Regexp pattern for initial IP address parsing.


    private
                    getIpParsePattern() : string

Return values

string

getIpVersion()

Gets the IP version.


    private
                    getIpVersion(string $ip) : int

Parameters

$ip : string

Return values

int

inRange()

Checks whether the IP is in subnet range.


    private
                    inRange(string $ip, int $cidr, string $range) : bool

Parameters

$ip : string: an IPv4 or IPv6 address
$cidr : int
$range : string: subnet in CIDR format e.g. 10.0.0.0/8 or 2001:af::/64

Return values

bool

isAllowed()

The method checks whether the IP address with specified CIDR is allowed according to the [[ranges]] list.


    private
                    isAllowed(string $ip, int $cidr) : bool

Parameters

$ip : string
$cidr : int

Return values

bool

parseNegatedRange()

Parses IP address/range for the negation with [[NEGATION_CHAR]].


    private
                    parseNegatedRange(mixed $string) : array<string|int, mixed>

Parameters

$string : mixed

Return values

array<string|int, mixed> —

[0 => bool, 1 => string]

boolean: whether the string is negated
string: the string without negation (when the negation were present)

prepareRanges()

Prepares array to fill in [[ranges]].


    private
                    prepareRanges(mixed $ranges) : array<string|int, mixed>

Recursively substitutes aliases, described in [[networks]] with their values,
Removes duplicates.

Parameters

$ranges : mixed

Return values

array<string|int, mixed>

validateSubnet()

Validates an IPv4/IPv6 address or subnet.


    private
                    validateSubnet(mixed $ip) : string|array<string|int, mixed>

Parameters

$ip : mixed: string

Return values

string|array<string|int, mixed> —

string - the validation was successful; array - an error occurred during the validation. Array[0] contains the text of an error, array[1] contains values for the placeholders in the error message

IpValidator extends Validator in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

NEGATION_CHAR

Tags

Properties

$attributeNames read-only

$attributes

$behaviors read-only

$builtInValidators

$enableClientValidation

$except

$expandIPv6

$hasSubnet

Tags

$ipv4

$ipv4NotAllowed

Tags

$ipv4Pattern

$ipv6

$ipv6NotAllowed

Tags

$ipv6Pattern

$isEmpty

$message

$negation

$networks

$normalize

Tags

$noSubnet

Tags

$notInRange

Tags

$on

$ranges

$skipOnEmpty

$skipOnError

$subnet

$validationAttributes read-only

$when

Tags

$whenClient

Tags

$wrongCidr

Tags

$_behaviors

$_events

$_eventWildcards

Tags

$_ranges

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

IpValidator extends Validator
in package

Application