https://github.com/mix-php/validator
Validator based on PSR-7 standard / 基于 PSR-7 标准的验证器
https://github.com/mix-php/validator
mix validate validator
Last synced: 5 months ago
JSON representation
Validator based on PSR-7 standard / 基于 PSR-7 标准的验证器
- Host: GitHub
- URL: https://github.com/mix-php/validator
- Owner: mix-php
- Created: 2018-12-21T08:06:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-04T07:53:25.000Z (over 4 years ago)
- Last Synced: 2025-08-27T05:11:20.987Z (7 months ago)
- Topics: mix, validate, validator
- Language: PHP
- Homepage: https://openmix.org/mix-php
- Size: 49.8 KB
- Stars: 1
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> OpenMix 出品：[https://openmix.org](https://openmix.org/mix-php)
# Mix Validator
Validator based on PSR-7 standard
基于 PSR-7 标准的验证器
## Installation
```
composer require mix/validator
```
## 创建表单
继承 `Mix\Validator\Validator` 并定义：
- `public $name` 字段名
- `rules()` 验证规则
- `scenarios()` 验证场景
- `messages()` 错误消息
```php
['string', 'maxLength' => 25, 'filter' => ['trim']],
'age' => ['integer', 'unsigned' => true, 'min' => 1, 'max' => 120],
'email' => ['email'],
];
}
/**
* @return array
*/
public function scenarios(): array
{
return [
'create' => ['required' => ['name'], 'optional' => ['email', 'age']],
];
}
/**
* @return array
*/
public function messages(): array
{
return [
'name.required' => '名称不能为空.',
'name.maxLength' => '名称最多不能超过25个字符.',
'age.integer' => '年龄必须是数字.',
'age.unsigned' => '年龄不能为负数.',
'age.min' => '年龄不能小于1.',
'age.max' => '年龄不能大于120.',
'email' => '邮箱格式错误.',
];
}
}
```
## 在控制器中验证
```php
// 使用表单验证
$form = new UserForm($request->getAttributes());
if (!$form->scenario('create')->validate()) {
$data = ['code' => 1, 'message' => $form->error()];
$ctx->JSON(200, $data);
return;
}
// 将表单对象直接传递到模型中保存数据
(new UserModel())->add($form);
```
- `$form->error() : string` 获取单条错误信息
- `$form->errors() : array` 获取全部错误信息
## 验证规则
全部的验证类型与对应的验证选项如下
```php
public function rules(): array
{
return [
'a' => ['integer', 'unsigned' => true, 'min' => 1, 'max' => 1000000, 'length' => 10, 'minLength' => 3, 'maxLength' => 5],
'b' => ['double', 'unsigned' => true, 'min' => 1, 'max' => 1000000, 'length' => 10, 'minLength' => 3, 'maxLength' => 5],
'c' => ['alpha', 'length' => 10, 'minLength' => 3, 'maxLength' => 5],
'd' => ['alphaNumeric', 'length' => 10, 'minLength' => 3, 'maxLength' => 5],
'e' => ['string', 'length' => 10, 'minLength' => 3, 'maxLength' => 5, 'filter' => ['trim', 'strip_tags', 'htmlspecialchars']],
'f' => ['email', 'length' => 10, 'minLength' => 3, 'maxLength' => 5],
'g' => ['phone'],
'h' => ['url', 'length' => 10, 'minLength' => 3, 'maxLength' => 5],
'i' => ['in', 'range' => ['A', 'B'], 'strict' => true],
'j' => ['date', 'format' => 'Y-m-d'],
'k' => ['compare', 'compareAttribute' => 'a'],
'l' => ['match', 'pattern' => '/^[\w]{1,30}$/'],
'm' => ['call', 'callback' => [$this, 'check']],
'n' => ['file', 'mimes' => ['audio/mp3', 'video/mp4'], 'maxSize' => 1024 * 1],
'r' => ['image', 'mimes' => ['image/gif', 'image/jpeg', 'image/png'], 'maxSize' => 1024 * 1],
];
}
```
### call 验证类型
该类型为用户自定义验证规则，callback 内指定一个用户自定义的方法来验证
```php
public function check($fieldValue): bool
{
// 验证代码
// ...
return true;
}
```
### file / image 验证类型
该类型用来验证文件，包含的两个验证选项如下：
- mimes：输入你想要限制的文件mime类型，[MIME参考手册](http://www.w3school.com.cn/media/media_mimeref.asp)
- maxSize：允许的文件最大尺寸，单位 KB
验证成功后模型类会增加一个同名属性，该属性为 Psr\Http\Message\UploadedFileInterface 类的实例化对象，可直接调用 $this->[attributeName]->moveTo($targetPath) 移动到你需要存放的位置
## 静态调用
```php
// 验证是否为字母与数字
Mix\Validator\Validate::isAlphaNumeric($value);
// 验证是否为字母
Mix\Validator\Validate::isAlpha($value);
// 验证是否为日期
Mix\Validator\Validate::isDate($value, $format);
// 验证是否为浮点数
Mix\Validator\Validate::isDouble($value);
// 验证是否为邮箱
Mix\Validator\Validate::isEmail($value);
// 验证是否为整数
Mix\Validator\Validate::isInteger($value);
// 验证是否在某个范围
Mix\Validator\Validate::in($value, $range, $strict = false);
// 正则验证
Mix\Validator\Validate::match($value, $pattern);
// 验证是否为手机
Mix\Validator\Validate::isPhone($value);
// 验证是否为网址
Mix\Validator\Validate::isUrl($value);
```
## License
Apache License Version 2.0, http://www.apache.org/licenses/