2 个关注者

类 yii\validators\ExistValidator

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

ExistValidator 验证属性值是否存在于表中。

ExistValidator 检查被验证的值是否可以在由 ActiveRecord 类 $targetClass 和属性 $targetAttribute 指定的表列中找到。从 2.0.14 版本开始,您可以使用更方便的属性 $targetRelation

此验证器通常用于验证外键是否包含可以在外键表中找到的值。

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

// a1 needs to exist
['a1', 'exist']
// a1 needs to exist, but its value will use a2 to check for the existence
['a1', 'exist', 'targetAttribute' => 'a2']
// a1 and a2 need to exist together, and they both will receive error message
[['a1', 'a2'], 'exist', 'targetAttribute' => ['a1', 'a2']]
// a1 and a2 need to exist together, only a1 will receive error message
['a1', 'exist', 'targetAttribute' => ['a1', 'a2']]
// a1 needs to exist by checking the existence of both a2 and a3 (using a1 value)
['a1', 'exist', 'targetAttribute' => ['a2', 'a1' => 'a3']]
// type_id needs to exist in the column "id" in the table defined in ProductType class
['type_id', 'exist', 'targetClass' => ProductType::class, 'targetAttribute' => ['type_id' => 'id']],
// the same as the previous, but using already defined relation "type"
['type_id', 'exist', 'targetRelation' => 'type'],

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$allowArray boolean 是否允许数组类型属性。 yii\validators\ExistValidator
$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
$filter string|array|Closure 要应用于用于检查属性值是否存在于数据库查询中的附加过滤器。 yii\validators\ExistValidator
$forceMasterDb boolean 此验证器是否强制始终使用主数据库 yii\validators\ExistValidator
$isEmpty callable|null 一个 PHP 可调用函数,它替换 isEmpty() 的默认实现。 yii\validators\Validator
$message string|null 用户定义的错误消息。 yii\validators\Validator
$on array|string 验证器可以应用于的场景。 yii\validators\Validator
$skipOnEmpty boolean 如果属性值为 null 或空字符串,是否应跳过此验证规则。 yii\validators\Validator
$skipOnError boolean 如果根据某些先前规则,要验证的属性已存在一些验证错误,是否应跳过此验证规则。 yii\validators\Validator
$targetAttribute string|array|null 应用于验证当前属性值是否存在于 ActiveRecord 属性的名称。 yii\validators\ExistValidator
$targetAttributeJunction string And|or 定义目标属性之间的关系 yii\validators\ExistValidator
$targetClass string|null 应用于验证当前属性值是否存在于 ActiveRecord 类的名称。 yii\validators\ExistValidator
$targetRelation string 应用于验证当前属性值是否存在于的关系的名称 此参数覆盖 $targetClass 和 $targetAttribute yii\validators\ExistValidator
$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() 检查属性是否已设置,即定义且不为空。 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\Validator
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\Validator
getValidationAttributes() 返回此验证器应用于的属性列表。 yii\validators\Validator
hasEventHandlers() 返回一个值,指示是否已将任何处理程序附加到命名事件。 yii\base\Component
hasMethod() 返回一个值,指示是否已定义方法。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化对象。 yii\validators\ExistValidator
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\ExistValidator
validateAttributes() 验证指定对象。 yii\validators\Validator

受保护方法

隐藏继承的方法

方法 描述 定义于
createQuery() 使用给定条件创建查询实例。 yii\validators\ExistValidator
formatMessage() 使用 I18N 格式化消息,或者如果 \Yii::$app 不可用,则使用简单的 strtr。 yii\validators\Validator
validateValue() 验证值。 yii\validators\ExistValidator

属性详细信息

隐藏继承的属性

$allowArray 公共属性

是否允许数组类型属性。

public boolean $allowArray false
$filter 公共属性

用于检查属性值是否存在时应用于 DB 查询的附加过滤器。这可以是字符串或数组,表示附加的查询条件(有关查询条件的格式,请参见 yii\db\Query::where()),也可以是具有签名 function ($query) 的匿名函数,其中 $queryQuery 对象,您可以在函数中修改该对象。

public string|array|Closure $filter null
$forceMasterDb 公共属性 (version 2.0.14 起可用)

此验证器是否强制始终使用主数据库

public boolean $forceMasterDb true
$targetAttribute 公共属性

要用于验证当前属性值是否存在 的 ActiveRecord 属性的名称。如果未设置,它将使用当前正在验证的属性的名称。您可以使用数组来同时验证多个列的存在。数组键是具有要验证的值的属性的名称,数组值是要搜索的数据库字段的名称。

$targetAttributeJunction 公共属性 (version 2.0.11 起可用)

And|or 定义目标属性之间的关系

$targetClass 公共属性

要用于验证当前属性值是否存在 的 ActiveRecord 类的名称。如果未设置,它将使用正在验证的属性的 ActiveRecord 类。

另请参见 $targetAttribute.

public string|null $targetClass null
$targetRelation 公共属性 (version 2.0.14 起可用)

应用于验证当前属性值是否存在于的关系的名称 此参数覆盖 $targetClass 和 $targetAttribute

public string $targetRelation null

方法详情

隐藏继承的方法

__call() 公共方法

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

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

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

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

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

方法名

$params array

方法参数

return mixed

方法返回值

throws 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

属性名

return mixed

属性值或行为属性的值

throws yii\base\UnknownPropertyException

如果属性未定义

throws 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()

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

此 方法将按以下顺序检查并相应地采取行动

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

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

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

public boolean __isset ( $name )
$name string

属性名称或事件名称

return 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

属性值

throws yii\base\UnknownPropertyException

如果属性未定义

throws 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

属性名

throws 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

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

return 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 ( )
return array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

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

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

如果可以读取属性

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

另请参阅 canSetProperty().

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

属性名

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

return 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 为真时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为真时)。

另请参阅 canGetProperty().

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

属性名

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

return 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() public static method
自 2.0.14 版本起已弃用。在 PHP >=5.5 中,请使用 ::class 代替。

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

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

public static string className ( )
return string

此类的完整限定名称。

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

            
clientValidateAttribute() public method

定义于: yii\validators\Validator::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

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

return string|null

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

                public function clientValidateAttribute($model, $attribute, $view)
{
    return null;
}

            
createQuery() protected method

使用给定条件创建查询实例。

protected yii\db\ActiveQueryInterface createQuery ( $targetClass, $condition )
$targetClass string

目标 AR 类

$condition mixed

查询条件

return yii\db\ActiveQueryInterface

查询实例

                protected function createQuery($targetClass, $condition)
{
    /* @var $targetClass \yii\db\ActiveRecordInterface */
    $query = $targetClass::find()->andWhere($condition);
    if ($this->filter instanceof \Closure) {
        call_user_func($this->filter, $query);
    } elseif ($this->filter !== null) {
        $query->andWhere($this->filter);
    }
    return $query;
}

            
createValidator() public static method

定义于: 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

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

return 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() public method

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

从组件中分离行为。

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

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

行为名称。

return 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() public method

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

从组件中分离所有行为。

public void detachBehaviors ( )

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

            
ensureBehaviors() public method

定义于: 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() protected method (available since version 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() public method (available since version 2.0.12)

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

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

public array getAttributeNames ( )
return array

属性名称。

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

            
getBehavior() public method

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

返回命名行为对象。

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

行为名称

return yii\base\Behavior|null

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

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

            
getBehaviors() public method

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

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

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此组件的行为列表

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

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

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

返回客户端验证选项。

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

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

正在验证的模型

$attribute string

正在验证的属性名称

return array

客户端验证选项

                public function getClientOptions($model, $attribute)
{
    return [];
}

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

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

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

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

要验证的属性列表。

return 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

事件名称

return 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 为真时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名

$checkBehaviors boolean

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

return 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 为真时);
  • 附加的行为具有给定名称的属性(当 $checkBehaviors 为真时)。

另请参阅

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

属性名

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

return 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) {
        $this->message = Yii::t('yii', '{attribute} is invalid.');
    }
}

            
isActive() 公共方法

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

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

如果验证器处于活动状态

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

场景名称

return 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

要检查的值

return 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,则将删除附加到命名事件的所有处理程序。

return 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 callable

事件处理程序

$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

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

return 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)
{
    if (!empty($this->targetRelation)) {
        $this->checkTargetRelationExistence($model, $attribute);
    } else {
        $this->checkTargetAttributeExistence($model, $attribute);
    }
}

            
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

要验证的数据值。

return 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。

throws yii\base\NotSupportedException

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

                protected function validateValue($value)
{
    if ($this->targetClass === null) {
        throw new InvalidConfigException('The "targetClass" property must be set.');
    }
    if (!is_string($this->targetAttribute)) {
        throw new InvalidConfigException('The "targetAttribute" property must be configured as a string.');
    }
    if (is_array($value) && !$this->allowArray) {
        return [$this->message, []];
    }
    $query = $this->createQuery($this->targetClass, [$this->targetAttribute => $value]);
    return $this->valueExists($this->targetClass, $query, $value) ? null : [$this->message, []];
}