0 关注者

类 yii\captcha\CaptchaValidator

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

CaptchaValidator 用于验证属性值是否与 CAPTCHA 中显示的验证码相同。

CaptchaValidator 应该与 yii\captcha\CaptchaAction 结合使用。

请注意,一旦 CAPTCHA 验证成功,新的 CAPTCHA 将会自动生成。因此,CAPTCHA 验证不应该在 AJAX 验证模式下使用,因为它可能会导致验证失败,即使用户输入与 CAPTCHA 图像中显示的相同代码,但实际上与最新的 CAPTCHA 代码不同。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$attributeNames array 属性名称。 yii\validators\Validator
$attributes array|string 要由此验证器验证的属性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$builtInValidators array 内置验证器列表(名称 => 类或配置) yii\validators\Validator
$captchaAction string 渲染 CAPTCHA 图像的控制器操作的路由。 yii\captcha\CaptchaValidator
$caseSensitive boolean 比较是否区分大小写。 yii\captcha\CaptchaValidator
$enableClientValidation boolean 是否为该验证器启用客户端验证。 yii\validators\Validator
$except array|string 验证器不应该应用于的场景。 yii\validators\Validator
$isEmpty callable|null 一个 PHP 可调用函数,它替换 isEmpty() 的默认实现。 yii\validators\Validator
$message string|null 用户定义的错误消息。 yii\validators\Validator
$on array|string 验证器可以应用于的场景。 yii\validators\Validator
$skipOnEmpty boolean 如果输入为空,是否跳过此验证器。 yii\captcha\CaptchaValidator
$skipOnError boolean 如果正在验证的属性根据之前规则已存在一些验证错误,是否应该跳过此验证规则。 yii\validators\Validator
$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\captcha\CaptchaValidator
createCaptchaAction() 根据 $captchaAction 指定的路由创建 CAPTCHA 操作对象。 yii\captcha\CaptchaValidator
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\captcha\CaptchaValidator
getValidationAttributes() 返回此验证器应用于的属性列表。 yii\validators\Validator
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名事件。 yii\base\Component
hasMethod() 返回一个值,指示是否定义了方法。 yii\base\Component
hasProperty() 返回一个值,指示是否为该组件定义了属性。 yii\base\Component
init() 初始化对象。 yii\captcha\CaptchaValidator
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\Validator
validateAttributes() 验证指定的对象。 yii\validators\Validator

受保护的方法

隐藏继承的方法

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

属性详情

隐藏继承的属性

$captchaAction 公共属性

渲染 CAPTCHA 图像的控制器操作的路由。

public string $captchaAction 'site/captcha'
$caseSensitive 公共属性

比较是否区分大小写。 默认值为 false。

public boolean $caseSensitive false
$skipOnEmpty 公共属性

如果输入为空,是否跳过此验证器。

public boolean $skipOnEmpty false

方法详情

隐藏继承的方法

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

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

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

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

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

另请参阅 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.captcha(value, messages, ' . Json::htmlEncode($options) . ');';
}

            
createCaptchaAction() 公共方法

根据 $captchaAction 指定的路由创建 CAPTCHA 操作对象。

public yii\captcha\CaptchaAction createCaptchaAction ( )
返回 yii\captcha\CaptchaAction

操作对象

抛出 yii\base\InvalidConfigException

                public function createCaptchaAction()
{
    $ca = Yii::$app->createController($this->captchaAction);
    if ($ca !== false) {
        /* @var $controller \yii\base\Controller */
        list($controller, $actionID) = $ca;
        $action = $controller->createAction($actionID);
        if ($action !== null) {
            return $action;
        }
    }
    throw new InvalidConfigException('Invalid CAPTCHA action ID: ' . $this->captchaAction);
}

            
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)
{
    $captcha = $this->createCaptchaAction();
    $code = $captcha->getVerifyCode(false);
    $hash = $captcha->generateValidationHash($this->caseSensitive ? $code : strtolower($code));
    $options = [
        'hash' => $hash,
        'hashKey' => 'yiiCaptcha/' . $captcha->getUniqueId(),
        'caseSensitive' => $this->caseSensitive,
        'message' => Yii::$app->getI18n()->format($this->message, [
            'attribute' => $model->getAttributeLabel($attribute),
        ], Yii::$app->language),
    ];
    if ($this->skipOnEmpty) {
        $options['skipOnEmpty'] = 1;
    }
    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 为真时);
  • 附加的行为具有给定名称的属性(当 $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) {
        $this->message = Yii::t('yii', 'The verification code is incorrect.');
    }
}

            
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() 公共方法

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

验证单个属性。

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

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

要验证的数据模型

$attribute string

要验证的属性的名称。

                public function validateAttribute($model, $attribute)
{
    $result = $this->validateValue($model->$attribute);
    if (!empty($result)) {
        $this->addError($model, $attribute, $result[0], $result[1]);
    }
}

            
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() 受保护方法

验证值。

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

受保护 数组| 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)
{
    $captcha = $this->createCaptchaAction();
    $valid = !is_array($value) && $captcha->validate($value, $this->caseSensitive);
    return $valid ? null : [$this->message, []];
}