0 关注者

类 yii\validators\IpValidator

继承关系yii\validators\IpValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable
可用版本2.0.7
源代码 https://github.com/yiisoft/yii2/blob/master/framework/validators/IpValidator.php

该验证器检查属性值是否为有效的 IPv4/IPv6 地址或子网。

如果启用了 IPv6 扩展的规范化,它也可能会更改属性的值。

以下是使用此验证器的验证规则示例

['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

公有属性

隐藏继承的属性

属性 类型 描述 定义于
$attributeNames array 属性名称。 yii\validators\Validator
$attributes array|string 将由此验证器验证的属性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$builtInValidators array 内置验证器列表(名称 => 类或配置) yii\validators\Validator
$enableClientValidation boolean 是否为该验证器启用客户端验证。 yii\validators\Validator
$except array|string 不应应用验证器的场景。 yii\validators\Validator
$expandIPv6 boolean 是否将 IPv6 地址扩展为完整的表示法格式。 yii\validators\IpValidator
$hasSubnet string 当验证由于 $subnet 为 false 但存在 CIDR 前缀而失败时,使用用户定义的错误消息。 yii\validators\IpValidator
$ipv4 boolean 被验证的值是否可以是 IPv4 地址。 yii\validators\IpValidator
$ipv4NotAllowed string 当验证由于禁用 IPv4 验证而失败时,使用用户定义的错误消息。 yii\validators\IpValidator
$ipv4Pattern string 验证 IPv4 地址的正则表达式模式 yii\validators\IpValidator
$ipv6 boolean 被验证的值是否可以是 IPv6 地址。 yii\validators\IpValidator
$ipv6NotAllowed string 当验证由于禁用 IPv6 验证而失败时,使用用户定义的错误消息。 yii\validators\IpValidator
$ipv6Pattern string 验证 IPv6 地址的正则表达式模式 yii\validators\IpValidator
$isEmpty callable|null 一个 PHP 可调用函数,用于替换 isEmpty() 的默认实现。 yii\validators\Validator
$message string 当验证由于错误的 IP 地址格式而失败时,使用用户定义的错误消息。 yii\validators\IpValidator
$negation boolean 地址开头是否可以有 NEGATION_CHAR 字符。 yii\validators\IpValidator
$networks array 可以在 $ranges 中使用的网络别名。 yii\validators\IpValidator
$noSubnet string|null 当验证由于子网 $subnet 设置为 'only' 但未设置 CIDR 前缀而失败时,使用用户定义的错误消息。 yii\validators\IpValidator
$normalize boolean 是否为没有 CIDR 前缀的地址添加最短长度的 CIDR 前缀(IPv4 为 32,IPv6 为 128)。 yii\validators\IpValidator
$notInRange string 当验证由于 IP 地址未被 $ranges 检查允许而失败时,使用用户定义的错误消息。 yii\validators\IpValidator
$on array|string 可以应用验证器的场景。 yii\validators\Validator
$ranges array 允许或禁止的 IPv4 或 IPv6 范围。 yii\validators\IpValidator
$skipOnEmpty boolean 如果属性值为 null 或空字符串,是否应跳过此验证规则。 yii\validators\Validator
$skipOnError boolean 如果根据某些先前规则,正在验证的属性已存在某些验证错误,是否应跳过此验证规则。 yii\validators\Validator
$subnet boolean|null 地址是否可以是带 CIDR 子网的 IP,例如 192.168.10.0/24 yii\validators\IpValidator
$validationAttributes array|null 属性名称列表。 yii\validators\Validator
$when callable|null 一个 PHP 可调用函数,其返回值决定是否应应用此验证器。 yii\validators\Validator
$whenClient string|null 一个 JavaScript 函数名称,其返回值决定是否应在客户端应用此验证器。 yii\validators\Validator
$wrongCidr string 当验证由于错误的 CIDR 而失败时,使用用户定义的错误消息。 yii\validators\IpValidator

公有方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后被调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
addError() 向模型对象添加有关指定属性的错误。 yii\validators\Validator
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
clientValidateAttribute() 返回执行客户端验证所需的 JavaScript 代码。 yii\validators\IpValidator
createValidator() 创建一个验证器对象。 yii\validators\Validator
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getAttributeNames() 返回清理后的属性名称,开头没有 ! 字符。 yii\validators\Validator
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getClientOptions() 返回客户端验证选项。 yii\validators\IpValidator
getRanges() yii\validators\IpValidator
getValidationAttributes() 返回此验证器应用到的属性列表。 yii\validators\Validator
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化对象。 yii\validators\IpValidator
isActive() 返回一个值,指示验证器对于给定的场景和属性是否处于活动状态。 yii\validators\Validator
isEmpty() 检查给定值是否为空。 yii\validators\Validator
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
setRanges() 设置允许或禁止的 IPv4 或 IPv6 范围。 yii\validators\IpValidator
trigger() 触发事件。 yii\base\Component
validate() 验证给定值。 yii\validators\Validator
validateAttribute() 验证单个属性。 yii\validators\IpValidator
validateAttributes() 验证指定的对象。 yii\validators\Validator

受保护方法

隐藏继承的方法

方法 描述 定义于
formatMessage() 使用 I18N 格式化消息,或者如果 \Yii::$app 不可用则使用简单的 strtr。 yii\validators\Validator
validateIPv4() 验证 IPv4 地址。 yii\validators\IpValidator
validateIPv6() 验证 IPv6 地址。 yii\validators\IpValidator
validateValue() 验证值。 yii\validators\IpValidator

常量

隐藏继承的常量

常量 描述 定义于
NEGATION_CHAR '!' 否定字符。用于否定 $ranges$networks,或者当 $negation 设置为 true 时否定验证值。 yii\validators\IpValidator

属性详情

隐藏继承的属性

$expandIPv6 公共属性

是否将 IPv6 地址扩展为完整表示法格式。默认为 false

public boolean $expandIPv6 false
$hasSubnet 公共属性

当验证由于 $subnet 为 false 但存在 CIDR 前缀而失败时,使用用户定义的错误消息。

您可以在消息中使用以下占位符

  • {attribute}: 正在验证的属性的标签
  • {value}: 正在验证的属性的值

另请参阅 $subnet

public string $hasSubnet null
$ipv4 公共属性

验证值是否可以是 IPv4 地址。默认为 true

public boolean $ipv4 true
$ipv4NotAllowed 公共属性

当验证由于禁用 IPv4 验证而失败时,使用用户定义的错误消息。

您可以在消息中使用以下占位符

  • {attribute}: 正在验证的属性的标签
  • {value}: 正在验证的属性的值

另请参阅 $ipv4

public string $ipv4NotAllowed null
$ipv4Pattern 公共属性

验证 IPv4 地址的正则表达式模式

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))$/'
$ipv6 公共属性

验证值是否可以是 IPv6 地址。默认为 true

public boolean $ipv6 true
$ipv6NotAllowed 公共属性

当验证由于禁用 IPv6 验证而失败时,使用用户定义的错误消息。

您可以在消息中使用以下占位符

  • {attribute}: 正在验证的属性的标签
  • {value}: 正在验证的属性的值

另请参阅 $ipv6

public string $ipv6NotAllowed null
$ipv6Pattern 公共属性

验证 IPv6 地址的正则表达式模式

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))$/'
$message 公共属性

当验证由于错误的 IP 地址格式而失败时,使用用户定义的错误消息。

您可以在消息中使用以下占位符

  • {attribute}: 正在验证的属性的标签
  • {value}: 正在验证的属性的值
public string $message null
$negation 公共属性

地址开头是否可以有 NEGATION_CHAR 字符。默认为 false

public boolean $negation false
$networks 公共属性

可以在 $ranges 中使用的网络别名。

  • 键 - 别名
  • 值 - 字符串数组。字符串可以是 IP 范围、IP 地址或其他别名。字符串可以用 NEGATION_CHAR 否定(独立于 negation 选项)。

默认情况下定义了以下别名

  • *: 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
public 数组 $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',
    ],
]
$noSubnet 公共属性

当验证由于子网 $subnet 设置为 'only' 但未设置 CIDR 前缀而失败时,使用用户定义的错误消息。

您可以在消息中使用以下占位符

  • {attribute}: 正在验证的属性的标签
  • {value}: 正在验证的属性的值

另请参阅 $subnet

public 字符串| $noSubnet null
$normalize 公共属性

是否为没有 CIDR 前缀的地址添加最短长度的前缀(IPv4 为 32,IPv6 为 128)。仅当 subnet 不为 false 时有效。例如

  • 10.0.1.5 将被规范化为 10.0.1.5/32
  • 2008:db0::1 将被规范化为 2008:db0::1/128 默认值为 false

另请参阅 $subnet

public 布尔值 $normalize false
$notInRange 公共属性

当验证由于 IP 地址未被 $ranges 检查允许而失败时,使用用户定义的错误消息。

您可以在消息中使用以下占位符

  • {attribute}: 正在验证的属性的标签
  • {value}: 正在验证的属性的值

另请参阅 $ranges

public 字符串 $notInRange null
$ranges 公共属性

允许或禁止的 IPv4 或 IPv6 范围。请注意,此属性在 getter 和 setter 中的类型不同。有关详细信息,请参阅 getRanges()setRanges()

public 数组 $ranges null
$subnet 公共属性

地址是否可以是带有 CIDR 子网的 IP,例如 192.168.10.0/24。可能的值如下

  • false - 地址不能有子网(默认值)。
  • true - 必须指定子网。
  • null - 可以选择指定子网。
public 布尔值| $subnet false
$wrongCidr 公共属性

当验证由于错误的 CIDR 而失败时,使用用户定义的错误消息。

您可以在消息中使用以下占位符

  • {attribute}: 正在验证的属性的标签
  • {value}: 正在验证的属性的值

另请参阅 $subnet

public 字符串 $wrongCidr null

方法详情

隐藏继承的方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有命名方法,如果可用则执行它。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用它。

public 混合类型 __call ( $name, $params )
$name string

方法名称

$params array

方法参数

返回值 混合类型

方法返回值

抛出 yii\base\UnknownMethodException

调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后被调用。

它删除所有行为,因为它们附加到旧对象。

public __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()

如果此方法在子类中被覆盖,建议

  • 构造函数的最后一个参数是一个配置数组,就像这里的 $config 一样。
  • 在构造函数的末尾调用父实现。
public __construct ( $config = [] )
$config array

用于初始化对象属性的键值对

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地执行操作

  • 由 getter 定义的属性:返回 getter 的结果
  • 行为的属性:返回行为属性的值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $component->property; 时将隐式调用。

另请参阅 __set()

public mixed __get ( $name )
$name string

属性名称

返回值 混合类型

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性为只写。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

定义于: yii\base\Component::__isset()

检查属性是否已设置,即定义且不为 null。

此方法将按以下顺序检查并相应地执行操作

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性,返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($component->property) 时将隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

指定的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地执行操作

  • 由 setter 定义的属性:设置属性值
  • 格式为“on xyz”的事件:将处理程序附加到事件“xyz”
  • 格式为“as xyz”的行为:附加名为“xyz”的行为
  • 行为的属性:设置行为属性的值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->property = $value; 时将隐式调用。

另请参阅 __get()

public void __set ( $name, $value )
$name string

属性名称或事件名称

$value 混合类型

属性值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性为只读。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地执行操作

  • 由 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($component->property) 时将隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.unset.php

public void __unset ( $name )
$name string

属性名称

抛出 yii\base\InvalidCallException

如果属性为只读。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
addError() 公共方法

定义于: yii\validators\Validator::addError()

向模型对象添加有关指定属性的错误。

这是一个执行消息选择和国际化的辅助方法。

public void addError ( $model, $attribute, $message, $params = [] )
$model yii\base\Model

正在验证的数据模型

$attribute string

正在验证的属性

$message string

错误消息

$params array

错误消息中占位符的值

                public function addError($model, $attribute, $message, $params = [])
{
    $params['attribute'] = $model->getAttributeLabel($attribute);
    if (!isset($params['value'])) {
        $value = $model->$attribute;
        if (is_array($value)) {
            $params['value'] = 'array()';
        } elseif (is_object($value) && !method_exists($value, '__toString')) {
            $params['value'] = '(object)';
        } else {
            $params['value'] = $value;
        }
    }
    $model->addError($attribute, $this->formatMessage($message, $params));
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参阅 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。可以是以下之一:

返回值 yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都按其名称索引,并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串或一个用于创建行为的配置数组。

另请参阅 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以重写此方法以指定它们希望表现为的行为。

此方法的返回值应该是一个行为对象或配置数组,这些对象或配置数组按行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

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

请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当数组键使用名称时,可以使用此名称,稍后可以使用 getBehavior() 检索行为,或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。

在此方法中声明的行为将自动(按需)附加到组件。

public array behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

定义于: yii\base\Component::canGetProperty()

返回一个值,指示是否可以读取属性。

如果满足以下条件,则可以读取属性:

  • 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

定义于: yii\base\Component::canSetProperty()

返回一个值,指示是否可以设置属性。

如果属性可以写入,则

  • 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >=5.5 上,请改用 ::class

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
clientValidateAttribute() 公共方法

返回执行客户端验证所需的 JavaScript 代码。

调用 getClientOptions() 为客户端验证生成选项数组。

如果验证器可以支持客户端验证,您可以覆盖此方法以返回 JavaScript 验证代码。

以下 JavaScript 变量已预定义,可以在验证代码中使用

  • attribute:描述正在验证的属性的对象。
  • value:正在验证的值。
  • messages:用于保存属性验证错误消息的数组。
  • deferred:用于保存异步验证的延迟对象的数组
  • $form:包含表单元素的 jQuery 对象

attribute 对象包含以下属性

  • id:表单中唯一标识属性的唯一 ID(例如“loginform-username”)
  • name:属性名称或表达式(例如表格输入的“[0]content”)
  • container:输入字段容器的 jQuery 选择器
  • input:表单上下文中输入字段的 jQuery 选择器
  • error:容器上下文中错误标签的 jQuery 选择器
  • status:输入字段的状态,0:空,之前未输入,1:已验证,2:等待验证,3:正在验证
public string|null clientValidateAttribute ( $model, $attribute, $view )
$model yii\base\Model

正在验证的数据模型

$attribute string

要验证的属性的名称。

$view yii\web\View

将用于呈现视图或包含应用此验证器的模型表单的视图文件的视图对象。

返回值 string|null

客户端验证脚本。如果验证器不支持客户端验证,则为 Null。

                public function clientValidateAttribute($model, $attribute, $view)
{
    ValidationAsset::register($view);
    $options = $this->getClientOptions($model, $attribute);
    return 'yii.validation.ip(value, messages, ' . Json::htmlEncode($options) . ');';
}

            
createValidator() 公共静态方法

定义于: yii\validators\Validator::createValidator()

创建一个验证器对象。

public static yii\validators\Validator createValidator ( $type, $model, $attributes, $params = [] )
$type string|Closure

验证器类型。这可以是

  • $builtInValidators 中列出的内置验证器名称;
  • 模型类的的方法名称;
  • 匿名函数;
  • 验证器类名。
$model yii\base\Model

要验证的数据模型。

$attributes array|string

要验证的属性列表。这可以是属性名称的数组或以逗号分隔的属性名称的字符串。

$params array

要应用于验证器属性的初始值。

返回值 yii\validators\Validator

验证器

                public static function createValidator($type, $model, $attributes, $params = [])
{
    $params['attributes'] = $attributes;
    if ($type instanceof \Closure) {
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = $type;
    } elseif (!isset(static::$builtInValidators[$type]) && $model->hasMethod($type)) {
        // method-based validator
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = [$model, $type];
    } else {
        unset($params['current']);
        if (isset(static::$builtInValidators[$type])) {
            $type = static::$builtInValidators[$type];
        }
        if (is_array($type)) {
            $params = array_merge($type, $params);
        } else {
            $params['class'] = $type;
        }
    }
    return Yii::createObject($params);
}

            
detachBehavior() 公共方法

定义于: yii\base\Component::detachBehavior()

从组件中分离行为。

行为的 yii\base\Behavior::detach() 方法将被调用。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|null

分离的行为。如果行为不存在,则为 Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义于: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() 公共方法

定义于: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
formatMessage() 受保护方法 (自 2.0.12 版本起可用)

定义于: yii\validators\Validator::formatMessage()

使用 I18N 格式化消息,或者如果 \Yii::$app 不可用则使用简单的 strtr。

protected string formatMessage ( $message, $params )
$message string
$params array

                protected function formatMessage($message, $params)
{
    if (Yii::$app !== null) {
        return \Yii::$app->getI18n()->format($message, $params, Yii::$app->language);
    }
    $placeholders = [];
    foreach ((array) $params as $name => $value) {
        $placeholders['{' . $name . '}'] = $value;
    }
    return ($placeholders === []) ? $message : strtr($message, $placeholders);
}

            
getAttributeNames() 公共方法 (自 2.0.12 版本起可用)

定义于: yii\validators\Validator::getAttributeNames()

返回清理后的属性名称,开头没有 ! 字符。

public array getAttributeNames ( )
返回值 array

属性名称。

                public function getAttributeNames()
{
    return array_map(function ($attribute) {
        return ltrim($attribute, '!');
    }, $this->attributes);
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公共方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getClientOptions() 公共方法 (自版本 2.0.11 起可用)

返回客户端验证选项。

此方法通常从 clientValidateAttribute() 调用。您可以重写此方法以修改将传递给客户端验证的选项。

public array getClientOptions ( $model, $attribute )
$model yii\base\Model

正在验证的模型

$attribute string

正在验证的属性名称

返回值 array

客户端验证选项

                public function getClientOptions($model, $attribute)
{
    $messages = [
        'ipv6NotAllowed' => $this->ipv6NotAllowed,
        'ipv4NotAllowed' => $this->ipv4NotAllowed,
        'message' => $this->message,
        'noSubnet' => $this->noSubnet,
        'hasSubnet' => $this->hasSubnet,
    ];
    foreach ($messages as &$message) {
        $message = $this->formatMessage($message, [
            'attribute' => $model->getAttributeLabel($attribute),
        ]);
    }
    $options = [
        'ipv4Pattern' => new JsExpression(Html::escapeJsRegularExpression($this->ipv4Pattern)),
        'ipv6Pattern' => new JsExpression(Html::escapeJsRegularExpression($this->ipv6Pattern)),
        'messages' => $messages,
        'ipv4' => (bool) $this->ipv4,
        'ipv6' => (bool) $this->ipv6,
        'ipParsePattern' => new JsExpression(Html::escapeJsRegularExpression($this->getIpParsePattern())),
        'negation' => $this->negation,
        'subnet' => $this->subnet,
    ];
    if ($this->skipOnEmpty) {
        $options['skipOnEmpty'] = 1;
    }
    return $options;
}

            
getRanges() 公共方法

public array getRanges ( )
返回值 array

允许或禁止的 IPv4 或 IPv6 范围。

                public function getRanges()
{
    return $this->_ranges;
}

            
getValidationAttributes() 公共方法 (自版本 2.0.16 起可用)

定义于: yii\validators\Validator::getValidationAttributes()

返回此验证器应用到的属性列表。

public array|null getValidationAttributes ( $attributes null )
$attributes array|string|null

要验证的属性列表。

返回值 array|null

属性名称列表。

                public function getValidationAttributes($attributes = null)
{
    if ($attributes === null) {
        return $this->getAttributeNames();
    }
    if (is_scalar($attributes)) {
        $attributes = [$attributes];
    }
    $newAttributes = [];
    $attributeNames = $this->getAttributeNames();
    foreach ($attributes as $attribute) {
        // do not strict compare, otherwise int attributes would fail due to to string conversion in getAttributeNames() using ltrim().
        if (in_array($attribute, $attributeNames, false)) {
            $newAttributes[] = $attribute;
        }
    }
    return $newAttributes;
}

            
hasEventHandlers() 公共方法

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名称

返回值 boolean

是否存在任何附加到事件的处理程序。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() 公共方法

定义于: yii\base\Component::hasMethod()

返回一个值,指示方法是否已定义。

如果定义了方法

  • 类具有指定名称的方法
  • 附加的行为具有给定名称的方法(当 $checkBehaviors 为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors boolean

是否将行为的方法视为此组件的方法

返回值 boolean

方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() 公共方法

定义于: yii\base\Component::hasProperty()

返回一个值,指示是否为此组件定义了属性。

如果定义了属性

  • 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当 $checkBehaviors 为 true 时)。

另请参阅

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() 公共方法

初始化对象。

此方法在构造函数结束时调用,在对象使用给定配置初始化之后。

public void init ( )

                public function init()
{
    parent::init();
    if (!$this->ipv4 && !$this->ipv6) {
        throw new InvalidConfigException('Both IPv4 and IPv6 checks can not be disabled at the same time');
    }
    if ($this->message === null) {
        $this->message = Yii::t('yii', '{attribute} must be a valid IP address.');
    }
    if ($this->ipv6NotAllowed === null) {
        $this->ipv6NotAllowed = Yii::t('yii', '{attribute} must not be an IPv6 address.');
    }
    if ($this->ipv4NotAllowed === null) {
        $this->ipv4NotAllowed = Yii::t('yii', '{attribute} must not be an IPv4 address.');
    }
    if ($this->wrongCidr === null) {
        $this->wrongCidr = Yii::t('yii', '{attribute} contains wrong subnet mask.');
    }
    if ($this->noSubnet === null) {
        $this->noSubnet = Yii::t('yii', '{attribute} must be an IP address with specified subnet.');
    }
    if ($this->hasSubnet === null) {
        $this->hasSubnet = Yii::t('yii', '{attribute} must not be a subnet.');
    }
    if ($this->notInRange === null) {
        $this->notInRange = Yii::t('yii', '{attribute} is not in the allowed range.');
    }
}

            
isActive() 公共方法

定义于: yii\validators\Validator::isActive()

返回一个值,指示验证器对于给定的场景和属性是否处于活动状态。

如果验证器处于活动状态

  • 验证器的 on 属性为空,或者
  • 验证器的 on 属性包含指定的场景
public boolean isActive ( $scenario )
$scenario string

场景名称

返回值 boolean

验证器是否适用于指定的场景。

                public function isActive($scenario)
{
    return !in_array($scenario, $this->except, true) && (empty($this->on) || in_array($scenario, $this->on, true));
}

            
isEmpty() 公共方法

定义于: yii\validators\Validator::isEmpty()

检查给定值是否为空。

如果值为 null、空数组或空字符串,则认为该值为空。请注意,此方法与 PHP empty() 不同。当值为 0 时,它将返回 false。

public boolean isEmpty ( $value )
$value 混合类型

要检查的值

返回值 boolean

该值是否为空

                public function isEmpty($value)
{
    if ($this->isEmpty !== null) {
        return call_user_func($this->isEmpty, $value);
    }
    return $value === null || $value === [] || $value === '';
}

            
off() 公共方法

定义于: yii\base\Component::off()

从此组件中分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

要删除的事件处理程序。如果为 null,则将删除附加到命名事件的所有处理程序。

返回值 boolean

如果找到并分离处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公共方法

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

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

事件处理程序必须使用以下签名定义,

function ($event)

其中 $event 是一个 yii\base\Event 对象,其中包含与事件关联的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

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

另请参阅 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler 可调用

事件处理程序

$data 混合类型

触发事件时传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
setRanges() 公共方法

设置允许或禁止的 IPv4 或 IPv6 范围。

执行以下准备任务

  • 递归地用其值替换别名(在 $networks 中描述)。
  • 删除重复项
public void setRanges ( $ranges )
$ranges array|string|null

允许或禁止的 IPv4 或 IPv6 范围。

当数组为空或未设置选项时,允许所有 IP 地址。

否则,将按顺序检查规则,直到找到第一个匹配项。当 IP 地址与任何规则都不匹配时,它将被禁止。

示例

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

在此示例中,允许访问所有 IPv4 和 IPv6 地址,但不包括 192.168.10.0/24 子网。IPv4 地址 192.168.10.128 也允许,因为它列在限制之前。

                public function setRanges($ranges)
{
    $this->_ranges = $this->prepareRanges((array) $ranges);
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
validate() 公共方法

定义于: yii\validators\Validator::validate()

验证给定值。

您可以使用此方法在数据模型的上下文之外验证值。

public boolean validate ( $value, &$error null )
$value 混合类型

要验证的数据值。

$error string|null

如果验证失败,要返回的错误消息。

返回值 boolean

数据是否有效。

                public function validate($value, &$error = null)
{
    $result = $this->validateValue($value);
    if (empty($result)) {
        return true;
    }
    list($message, $params) = $result;
    $params['attribute'] = Yii::t('yii', 'the input value');
    if (is_array($value)) {
        $params['value'] = 'array()';
    } elseif (is_object($value)) {
        $params['value'] = 'object';
    } else {
        $params['value'] = $value;
    }
    $error = $this->formatMessage($message, $params);
    return false;
}

            
validateAttribute() 公共方法

验证单个属性。

子类必须实现此方法以提供实际的验证逻辑。

public void validateAttribute ( $model, $attribute )
$model yii\base\Model

要验证的数据模型

$attribute string

要验证的属性的名称。

                public function validateAttribute($model, $attribute)
{
    $value = $model->$attribute;
    $result = $this->validateSubnet($value);
    if (is_array($result)) {
        $result[1] = array_merge(['ip' => is_array($value) ? 'array()' : $value], $result[1]);
        $this->addError($model, $attribute, $result[0], $result[1]);
    } else {
        $model->$attribute = $result;
    }
}

            
validateAttributes() 公共方法

定义于: yii\validators\Validator::validateAttributes()

验证指定的对象。

public void validateAttributes ( $model, $attributes null )
$model yii\base\Model

正在验证的数据模型

$attributes array|string|null

要验证的属性列表。请注意,如果属性未与验证器关联,则将被忽略。如果此参数为 null,则将验证 $attributes 中列出的每个属性。

                public function validateAttributes($model, $attributes = null)
{
    $attributes = $this->getValidationAttributes($attributes);
    foreach ($attributes as $attribute) {
        $skip = $this->skipOnError && $model->hasErrors($attribute)
            || $this->skipOnEmpty && $this->isEmpty($model->$attribute);
        if (!$skip) {
            if ($this->when === null || call_user_func($this->when, $model, $attribute)) {
                $this->validateAttribute($model, $attribute);
            }
        }
    }
}

            
validateIPv4() 受保护方法

验证 IPv4 地址。

protected boolean validateIPv4 ( $value )
$value string

                protected function validateIPv4($value)
{
    return preg_match($this->ipv4Pattern, $value) !== 0;
}

            
validateIPv6() 受保护方法

验证 IPv6 地址。

protected boolean validateIPv6 ( $value )
$value string

                protected function validateIPv6($value)
{
    return preg_match($this->ipv6Pattern, $value) !== 0;
}

            
validateValue() 受保护方法

验证值。

验证器类可以实现此方法以支持在数据模型的上下文之外进行数据验证。

protected array|null validateValue ( $value )
$value 混合类型

要验证的数据值。

返回值 array|null

错误消息和要插入错误消息的参数数组。`php if (!$valid) {

return [$this->message, [
    'param1' => $this->param1,
    'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
    'mimeTypes' => implode(', ', $this->mimeTypes),
    'param4' => 'etc...',
]];

}

return null; ` 对于此示例,message 模板可以包含 {param1}{formattedLimit}{mimeTypes}{param4}

如果数据有效,则应返回 Null。

抛出 yii\base\NotSupportedException

如果验证器不支持没有模型的数据验证

                protected function validateValue($value)
{
    $result = $this->validateSubnet($value);
    if (is_array($result)) {
        $result[1] = array_merge(['ip' => is_array($value) ? 'array()' : $value], $result[1]);
        return $result;
    }
    return null;
}