Class yii\validators\RegularExpressionValidator

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

RegularExpressionValidator 验证属性值是否与指定的 $pattern 匹配.

如果 $not 属性设置为true, 验证器将确保属性值与 $pattern 不匹配.

公共属性

隐藏继承的属性

属性类型描述定义在
$attributeNames array 属性名称. yii\validators\Validator
$attributes array|string 要由此验证器验证的属性. yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. yii\base\Component
$builtInValidators array 内置验证器列表(键值对(name => class)或配置). yii\validators\Validator
$enableClientValidation boolean 是否为此验证器启用客户端验证. yii\validators\Validator
$except array|string 验证器不应该应用的场景. yii\validators\Validator
$isEmpty callable PHP 回调函数, 它取代 isEmpty() 的默认实现. yii\validators\Validator
$message string 用户定义的错误消息. yii\validators\Validator
$not boolean 是否反转验证逻辑. yii\validators\RegularExpressionValidator
$on array|string 验证器可以应用的场景. yii\validators\Validator
$pattern string 要匹配的正则表达式. yii\validators\RegularExpressionValidator
$skipOnEmpty boolean 如果属性值为null或空字符串, 是否应跳过此验证规则. yii\validators\Validator
$skipOnError boolean 如果验证的属性已根据某些先前的规则已经存在某些验证错误, 是否应跳过此验证规则. yii\validators\Validator
$validationAttributes array 属性名称列表. yii\validators\Validator
$when callable PHP 回调函数, 其返回值确定是否应该应用此验证器. yii\validators\Validator
$whenClient string 一个 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\RegularExpressionValidator
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\RegularExpressionValidator
getValidationAttributes() 返回此验证器适用的属性列表. yii\validators\Validator
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\validators\RegularExpressionValidator
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\validators\RegularExpressionValidator

属性详情

$not public 属性

是否反转验证逻辑. 默认为false.

如果设置为true, 则通过 $pattern 定义的正则表达式不应与属性值匹配.

public boolean $not false
$pattern public 属性

要匹配的正则表达式.

public string $pattern null

方法详情

clientValidateAttribute() public 方法

返回执行客户端验证所需的 JavaScript.

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

如果验证器可以支持客户端验证, 则可以重写此方法以返回 JavaScript 验证代码.

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

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

attribute对象包含以下属性:

  • id: 在表单中标识该属性的唯一 ID(eg. loginform-username);
  • name: 属性名称或表达式(eg. [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.

getClientOptions() public 方法

返回客户端验证选项.

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

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

正在验证的模型.

$attribute string

正在验证的属性名称.

return array

客户端验证选项.

init() public 方法

初始化对象.

在使用给定的配置初始化对象之后, 在构造函数的末尾调用此方法.

public void init ( )
validateValue() protected 方法

验证一个值.

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

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

要验证的数据值.

return array|null

错误消息和要插入到错误消息中的参数数组.

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

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