0 关注者

类 yii\validators\CompareValidator

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

CompareValidator 用于比较指定属性值与另一个值。

要比较的值可以是另一个属性值(通过 $compareAttribute 指定)或一个常量(通过 $compareValue 指定)。当两者都指定时,后者优先。如果两者都没有指定,则该属性将与另一个属性进行比较,另一个属性的名称是在源属性名称后面追加 "_repeat"。

CompareValidator 支持不同的比较运算符,通过 $operator 属性指定。

默认比较函数基于字符串值,这意味着值是逐字节比较的。当比较数字时,请确保将 $type 设置为 TYPE_NUMBER 以启用数字比较。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$attributeNames array 属性名称。 yii\validators\Validator
$attributes array|string 由该验证器验证的属性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$builtInValidators array 内置验证器列表(名称 => 类或配置) yii\validators\Validator
$compareAttribute string 要比较的属性的名称。 yii\validators\CompareValidator
$compareValue mixed 要比较的常量值。 yii\validators\CompareValidator
$enableClientValidation boolean 是否为该验证器启用客户端验证。 yii\validators\Validator
$except array|string 不应应用验证器的场景。 yii\validators\Validator
$isEmpty callable|null 一个 PHP 可调用对象,它替换 isEmpty() 的默认实现。 yii\validators\Validator
$message string 用户定义的错误消息。 yii\validators\CompareValidator
$on array|string 可以应用验证器的场景。 yii\validators\Validator
$operator string 比较运算符。 yii\validators\CompareValidator
$skipOnEmpty boolean 如果属性值为 null 或空字符串,是否应跳过此验证规则。 yii\validators\Validator
$skipOnError boolean 如果根据某些先前规则,正在验证的属性已经存在一些验证错误,是否应跳过此验证规则。 yii\validators\Validator
$type string 正在比较的值的类型。 yii\validators\CompareValidator
$validationAttributes array|null 属性名称列表。 yii\validators\Validator
$when callable|null 一个 PHP 可调用对象,其返回值决定是否应应用此验证器。 yii\validators\Validator
$whenClient string|null 一个 JavaScript 函数名,其返回值决定是否应在客户端应用此验证器。 yii\validators\Validator

公共方法

隐藏继承的方法

方法 描述 定义于
__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\CompareValidator
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\CompareValidator
getValidationAttributes() 返回此验证器应用到的属性列表。 yii\validators\Validator
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化对象。 yii\validators\CompareValidator
isActive() 返回一个值,指示验证器对于给定的场景和属性是否处于活动状态。 yii\validators\Validator
isEmpty() 检查给定值是否为空。 yii\validators\Validator
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
trigger() 触发事件。 yii\base\Component
validate() 验证给定值。 yii\validators\Validator
validateAttribute() 验证单个属性。 yii\validators\CompareValidator
validateAttributes() 验证指定的对象。 yii\validators\Validator

受保护的方法

隐藏继承的方法

方法 描述 定义于
compareValues() 使用指定的运算符比较两个值。 yii\validators\CompareValidator
formatMessage() 使用 I18N 格式化消息,或者如果 \Yii::$app 不可用,则使用简单的 strtr。 yii\validators\Validator
validateValue() 验证值。 yii\validators\CompareValidator

常量

隐藏继承的常量

常量 描述 定义于
TYPE_NUMBER 'number' 用于通过数值指定比较 $type 的常量。 yii\validators\CompareValidator
TYPE_STRING 'string' 用于通过数值指定比较 $type 的常量。 yii\validators\CompareValidator

属性详情

隐藏继承的属性

$compareAttribute 公有属性

要比较的属性的名称。当此属性和 $compareValue 都设置时,后者优先。如果两者都没有设置,则假定与另一个属性进行比较,该属性的名称是在要验证的属性名称后面附加 '_repeat' 形成的。例如,如果正在验证 'password',则要比较的属性将是 'password_repeat'。

另请参阅 $compareValue

public string $compareAttribute null
$compareValue 公有属性

要比较的常量值。当此属性和 $compareAttribute 都设置时,此属性优先。

另请参阅 $compareAttribute

public mixed $compareValue null
$message 公有属性

用户定义的错误消息。它可能包含以下占位符,这些占位符将由验证器相应地替换

  • {attribute}: 正在验证的属性的标签
  • {value}: 正在验证的属性的值
  • {compareValue}: 要比较的值或属性标签
  • {compareAttribute}: 要比较的属性的标签
  • {compareValueOrAttribute}: 要比较的值或属性标签
public string $message null
$operator 公有属性

比较运算符。支持以下运算符

  • ==: 检查两个值是否相等。比较以非严格模式进行。
  • ===: 检查两个值是否相等。比较以严格模式进行。
  • !=: 检查两个值是否不相等。比较以非严格模式进行。
  • !==: 检查两个值是否不相等。比较以严格模式进行。
  • >: 检查正在验证的值是否大于要比较的值。
  • >=: 检查正在验证的值是否大于或等于要比较的值。
  • <: 检查正在验证的值是否小于要比较的值。
  • <=: 检查正在验证的值是否小于或等于要比较的值。

当您要比较数字时,请确保还将 $type 设置为 number

public string $operator '=='
$type 公有属性

正在比较的值的类型。支持以下类型

  • string: 值作为字符串进行比较。比较前不会进行任何转换。
  • number: 值作为数字进行比较。字符串值将在比较前转换为数字。
public string $type self::TYPE_STRING

方法详情

隐藏继承的方法

__call() 公有方法

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

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

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

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

public mixed __call ( $name, $params )
$name string

方法名称

$params array

方法参数

返回值 mixed

方法返回值

抛出 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 void __clone ( )

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

            
__construct() 公有方法

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

构造函数。

默认实现执行两件事

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

如果此方法在子类中被重写,建议

  • 构造函数的最后一个参数是一个配置数组,就像这里的 $config 一样。
  • 在构造函数的末尾调用父实现。
public void __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

属性名称

返回值 mixed

属性值或行为属性的值

抛出 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 mixed

属性值。

抛出 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 布尔型 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 字符串 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 字符串| clientValidateAttribute ( $model, $attribute, $view )
$model yii\base\Model

正在验证的数据模型。

$attribute string

要验证的属性的名称。

$view yii\web\View

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

返回值 string|null

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

                public function clientValidateAttribute($model, $attribute, $view)
{
    if ($this->compareValue != null && $this->compareValue instanceof \Closure) {
        $this->compareValue = call_user_func($this->compareValue);
    }
    ValidationAsset::register($view);
    $options = $this->getClientOptions($model, $attribute);
    return 'yii.validation.compare(value, messages, ' . Json::htmlEncode($options) . ', $form);';
}

            
compareValues() 受保护方法

使用指定的运算符比较两个值。

protected 布尔型 compareValues ( $operator, $type, $value, $compareValue )
$operator string

比较运算符

$type string

正在比较的值的类型

$value mixed

正在比较的值

$compareValue mixed

另一个正在比较的值

返回值 boolean

使用指定的运算符进行比较是否为真。

                protected function compareValues($operator, $type, $value, $compareValue)
{
    if ($type === self::TYPE_NUMBER) {
        $value = (float) $value;
        $compareValue = (float) $compareValue;
    } else {
        $value = (string) $value;
        $compareValue = (string) $compareValue;
    }
    switch ($operator) {
        case '==':
            return $value == $compareValue;
        case '===':
            return $value === $compareValue;
        case '!=':
            return $value != $compareValue;
        case '!==':
            return $value !== $compareValue;
        case '>':
            return $value > $compareValue;
        case '>=':
            return $value >= $compareValue;
        case '<':
            return $value < $compareValue;
        case '<=':
            return $value <= $compareValue;
        default:
            return false;
    }
}

            
createValidator() 公共静态方法

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

创建一个验证器对象。

public static yii\validators\Validator createValidator ( $type, $model, $attributes, $params = [] )
$type 字符串|闭包

验证器类型。这可以是

  • $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| detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|

分离的行为。如果行为不存在,则为 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 字符串 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 数组 getAttributeNames ( )
返回值 array

属性名称。

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

            
getBehavior() 公共方法

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

返回命名的行为对象。

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

行为名称

返回值 yii\base\Behavior|

行为对象,如果行为不存在则为 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)
{
    $options = [
        'operator' => $this->operator,
        'type' => $this->type,
    ];
    if ($this->compareValue !== null) {
        $options['compareValue'] = $this->compareValue;
        $compareLabel = $compareValue = $compareValueOrAttribute = $this->compareValue;
    } else {
        $compareAttribute = $this->compareAttribute === null ? $attribute . '_repeat' : $this->compareAttribute;
        $compareValue = $model->getAttributeLabel($compareAttribute);
        $options['compareAttribute'] = Html::getInputId($model, $compareAttribute);
        $options['compareAttributeName'] = Html::getInputName($model, $compareAttribute);
        $compareLabel = $compareValueOrAttribute = $model->getAttributeLabel($compareAttribute);
    }
    if ($this->skipOnEmpty) {
        $options['skipOnEmpty'] = 1;
    }
    $options['message'] = $this->formatMessage($this->message, [
        'attribute' => $model->getAttributeLabel($attribute),
        'compareAttribute' => $compareLabel,
        'compareValue' => $compareValue,
        'compareValueOrAttribute' => $compareValueOrAttribute,
    ]);
    return $options;
}

            
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->message === null) {
        switch ($this->operator) {
            case '==':
            case '===':
                $this->message = Yii::t('yii', '{attribute} must be equal to "{compareValueOrAttribute}".');
                break;
            case '!=':
            case '!==':
                $this->message = Yii::t('yii', '{attribute} must not be equal to "{compareValueOrAttribute}".');
                break;
            case '>':
                $this->message = Yii::t('yii', '{attribute} must be greater than "{compareValueOrAttribute}".');
                break;
            case '>=':
                $this->message = Yii::t('yii', '{attribute} must be greater than or equal to "{compareValueOrAttribute}".');
                break;
            case '<':
                $this->message = Yii::t('yii', '{attribute} must be less than "{compareValueOrAttribute}".');
                break;
            case '<=':
                $this->message = Yii::t('yii', '{attribute} must be less than or equal to "{compareValueOrAttribute}".');
                break;
            default:
                throw new InvalidConfigException("Unknown operator: {$this->operator}");
        }
    }
}

            
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 mixed

要检查的值

返回值 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 mixed

触发事件时传递给事件处理器的的数据。当调用事件处理器时,可以通过 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]);
    }
}

            
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 mixed

要验证的数据值。

$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;
    if (is_array($value)) {
        $this->addError($model, $attribute, Yii::t('yii', '{attribute} is invalid.'));
        return;
    }
    if ($this->compareValue !== null) {
        if ($this->compareValue instanceof \Closure) {
            $this->compareValue = call_user_func($this->compareValue);
        }
        $compareLabel = $compareValue = $compareValueOrAttribute = $this->compareValue;
    } else {
        $compareAttribute = $this->compareAttribute === null ? $attribute . '_repeat' : $this->compareAttribute;
        $compareValue = $model->$compareAttribute;
        $compareLabel = $compareValueOrAttribute = $model->getAttributeLabel($compareAttribute);
        if (!$this->skipOnError && $model->hasErrors($compareAttribute)) {
            $this->addError(
                $model,
                $attribute,
                Yii::t('yii', '{compareAttribute} is invalid.'),
                ['compareAttribute' => $compareLabel]
            );
            return;
        }
    }
    if (!$this->compareValues($this->operator, $this->type, $value, $compareValue)) {
        $this->addError($model, $attribute, $this->message, [
            'compareAttribute' => $compareLabel,
            'compareValue' => $compareValue,
            'compareValueOrAttribute' => $compareValueOrAttribute,
        ]);
    }
}

            
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);
            }
        }
    }
}

            
validateValue() 受保护的方法

验证值。

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

protected array|null validateValue ( $value )
$value mixed

要验证的数据值。

返回值 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)
{
    if ($this->compareValue === null) {
        throw new InvalidConfigException('CompareValidator::compareValue must be set.');
    }
    if ($this->compareValue instanceof \Closure) {
        $this->compareValue = call_user_func($this->compareValue);
    }
    if (!$this->compareValues($this->operator, $this->type, $value, $this->compareValue)) {
        return [$this->message, [
            'compareAttribute' => $this->compareValue,
            'compareValue' => $this->compareValue,
            'compareValueOrAttribute' => $this->compareValue,
        ]];
    }
    return null;
}