Yii2如何创建独立自定义参数验证器

浅静小哥_2328

浅静小哥_2328

2026-08-19

421人浏览

原创

yii2自定义验证器需继承yii\validators\validator,声明public属性作为可配置参数,在validateattribute()中实现校验逻辑,类名以validator结尾,rules()中传参需与属性名完全一致。

yii2如何创建独立自定义参数验证器

Yii2 创建独立自定义参数验证器,核心是定义一个继承 yii\validators\Validator 的类,通过 public 属性暴露可配置参数,并在 validateAttribute() 中使用这些参数完成校验逻辑。

定义验证器类并声明参数

参数必须声明为 public 属性,不能藏在 $params 里解析。框架会自动把 rules() 中传入的键值对赋给同名属性。

  • 类名必须以 Validator 结尾(如 PhoneValidator),否则自动加载失败
  • 必须重写 validateAttribute($model, $attribute),不是 validate()
  • 构造函数中记得调用 parent::__construct($config) 或在 init() 中调用 parent::init(),否则 $this->message 等基础属性为空

示例:带区号校验的手机号验证器

Yii Framework 2.0.51
Yii Framework 2.0.51

Yii Framework 2.0.51 官方 Basic 应用模板,适合旧项目兼容、升级验证和开发测试。

下载
namespace app\validators;

use yii\validators\Validator;

class PhoneValidator extends Validator
{
  public $countryCode = '86'; // 可配置参数,默认中国
  public $strict = false;     // 是否启用严格格式(如11位+前缀)

  public function init()
  {
    parent::init();
    if ($this->message === null) {
      $this->message = '{attribute} 不是有效的手机号。';
    }
  }

  public function validateAttribute($model, $attribute)
  {
    $value = $model->$attribute;
    if (!is_string($value)) {
      $this->addError($model, $attribute, $this->message);
      return;
    }
    $value = trim($value);
    if (empty($value)) return;

    $pattern = $this->strict
      ? '/^' . preg_quote($this->countryCode, '/') . '\d{11}$/'
      : '/^' . preg_quote($this->countryCode, '/') . '\d{10,12}$/';

    if (!preg_match($pattern, $value)) {
      $this->addError($model, $attribute, $this->message);
    }
  }
}

在模型 rules() 中使用并传参

直接写类的完整命名空间路径,然后以键值对形式传入参数:

public function rules()
{
  return [
    ['mobile', 'app\validators\PhoneValidator', 'countryCode' => '1', 'strict' => true],
    ['backup_phone', 'app\validators\PhoneValidator', 'countryCode' => '44'],
  ];
}
  • 参数名必须与验证器类中的 public 属性名完全一致(大小写敏感)
  • 未传的参数将使用类中定义的默认值
  • 不支持在 rules() 中动态计算参数值(如 'countryCode' => $this->regionCode),只能是静态值或常量

支持客户端验证(可选)

若需表单失去焦点时实时校验,必须实现 clientValidateAttribute() 方法,返回合法 JavaScript 字符串:

public function clientValidateAttribute($model, $attribute, $view)
{
  $options = json_encode([
    'countryCode' => $this->countryCode,
    'strict' => $this->strict,
    'message' => $this->formatMessage($this->message, [
      'attribute' => $model->getAttributeLabel($attribute),
    ]),
  ], JSON_UNESCAPED_UNICODE);

  return if (value !== '' && !/^\$countryCode\d{10,12}$/.test(value)) {
  messages.push($options.message);
}
JS;
}
  • 注意 JS 中要正确转义变量,推荐用 json_encode() 构造配置对象
  • 实际正则需根据 PHP 端逻辑同步调整,避免前后端校验不一致
  • 若不实现该方法,此验证器仅在服务端生效

注意事项与常见陷阱

几个高频出错点务必避开:

  • 忘记在 init() 中调用 parent::init() → 导致 $this->message$this->on$this->when 等全为空
  • 误写 validate() 而非 validateAttribute() → 验证永远不会触发
  • 参数名拼写错误或大小写不符 → 传参失效,始终用默认值
  • 类文件未按 PSR-4 规范放置,或命名空间与路径不匹配 → 类找不到
  • 没设 'skipOnEmpty' => false 却期望校验空字符串 → 空值被跳过,不执行 validateAttribute()

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

8984

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5461

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

1995

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3388

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4054

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3171

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4497

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3522

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11562

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2中文手册
Yii2中文手册

共0课时 | 0.6万人学习

thinkphp基础介绍和yii2基础介绍
thinkphp基础介绍和yii2基础介绍

共10课时 | 2.5万人学习

Yii2框架基础视频教程
Yii2框架基础视频教程

共22课时 | 2.8万人学习