目录
Validation —— 一款 PHP 直观的数据验证器
Validation 用于对数据合法性的检查。
目标只有 10 个字 - 规则结构即是数据结构。
详细文档见：github 仓库
有任何意见或想法，我们可以一起交流探讨！
🙋 为什么写这个工具？
- 对于API的参数，理论上对每个参数都应该进行合法性检查，尤其是那些需要转发给其他API接口或者需要存储到数据库的参数。
比如，数据库基本上对数据长度类型等有限制，对于长度的验证可谓是简单繁琐，使用该工具可以大大简化代码。 - 如果API参数过多，验证的代码量势必很大，无法直观通过代码明白参数格式。
- 只需定制一个验证规则数组，规则数组长啥样，请求参数就长啥样。
- 方便地多样化地设置验证方法返回的错误信息
-
暂时想不到，想到了再给你们编。🐶
1. 简介
1.1 特点
- 一个字段对应一个验证规则，一个规则由多个验证方法（函数）组成。
- 验证方法支持用标志代替，易于理解，简化规则。采用
*,>,<,len>等方法标志，比如*表示必要的 - 支持正则表达式
- 支持方法传参。如
@this代表当前字段值 - 支持拓展方法
- 支持串联验证：一个参数多个方法必须全部满足
- 支持并联验证：一个参数多个规则满足其一即可
- 支持条件验证：条件满足则继续验证后续方法，不满足则表明该字段是可选的
- 支持无限嵌套的数据结构，包括关联数组，索引数组
- 支持特殊的验证规则
- 支持客制化配置。比如多个方法的分隔符号默认
|，可以改为其他字符，如; - 支持国际化。默认英语，支持自定义方法返回错误信息
- 支持一次性验证全部数据(默认)，也可设置参数验证失败后立即结束验证
- 支持自定义错误信息，支持多种格式的错误信息，无限嵌套或者一维数组的错误信息格式
-
暂时想不到，想到了再给你们编。🐶
1.2 一个例子
use githusband\Validation;
// 待验证参数的简单示例。实际上无论参数多么复杂，都支持一个验证规则数组完成验证
$data = [
"id" => 1,
"name" => "Devin",
"age" => 18,
"favorite_animation" => [
"name" => "A Record of A Mortal's Journey to Immortality",
"release_date" => "July 25, 2020 (China)"
]
];
// 验证规则数组。规则数组的格式与待验证参数的格式相同。
$rule = [
"id" => "required|/^\d+$/", // 必要的，且只能是数字
"name" => "required|len<=>[3,32]", // 必要的，且字符串长度必须大于3，小于等于32
"favorite_animation" => [
"name" => "required|len<=>[1,64]", // 必要的，且字符串长度必须大于1，小于等于64
"release_date" => "optional|len<=>[4,64]", // 可选的，如果不为空，那么字符串长度必须大于4，小于等于64
]
];
$config = [];
// 实例化类，接受一个自定义配置数组，但不必要
$validation = new Validation($config);
// 设置验证规则并验证数据，成功返回 true，失败返回 false
if ($validation->set_rules($rule)->validate($data)) {
// 这里获取验证结果，有被规则{$rule}验证到的参数，成功则修改其值为true，失败则修改其值为错误信息，
// 没有被验证到的参数，保持原值不变。比如 age 保持 18 不变。
return $validation->get_result();
} else {
// 一共有四种错误信息格式可供选择。默认 Validation::ERROR_FORMAT_DOTTED_GENERAL
return $validation->get_error();
}
理论上，该工具是用于验证复杂的数据结构的，但如果你想验证单一字符串，也可以，例如
$validation->set_rules("required|string")->validate("Hello World!");
- 以上仅展示简单示例，实际上无论请求参数多么复杂，都支持一个验证规则数组完成验证。
- 规则写的太丑了？我们支持客制化配置
2. 安装
$ composer require githusband/validation
详细文档见：github 仓库
