Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/china-wangyu/lin-cms-tp-validate-core
LinCms TP 的反射验证器核心类，含参数中间件封装，路由参数验证中间件，方法注释参数提取器，基于wangyu/reflex-core扩展
https://github.com/china-wangyu/lin-cms-tp-validate-core
Last synced: about 2 months ago
JSON representation
LinCms TP 的反射验证器核心类，含参数中间件封装，路由参数验证中间件，方法注释参数提取器，基于wangyu/reflex-core扩展
- Host: GitHub
- URL: https://github.com/china-wangyu/lin-cms-tp-validate-core
- Owner: china-wangyu
- License: mit
- Created: 2019-05-07T03:17:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-18T07:42:31.000Z (about 5 years ago)
- Last Synced: 2024-08-08T17:17:57.161Z (5 months ago)
- Language: PHP
- Homepage: https://github.com/china-wangyu/lin-cms-tp-validate-core
- Size: 30.3 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lin-cms-tp-validate-core
LinCms TP 的反射验证器核心类，含参数中间件封装，路由参数验证中间件，方法注释参数提取器，基于`wangyu/reflex-core`扩展
# `composer`安装
```bash
composer require lin-cms-tp/validate-core
```
# 默认参数
| 名称 | 注释 | 默认值 |
| :-: |:-:|:-:|
| **config('lin.validate_root_path')** | 验证器根目录 | **api/validate** |
# 反射参数验证
- 需要在系统`config`配置`middleware.php`
```php
'app\\http\\middleware\\',
'linRouteParam' => LinCmsTp\Param::Class
];
```
- 需要在接口类`注释`设置`@middleware`
```php
/**
* Class Book
* @route('v1/book')
* @middleware('linRouteParam')
* @package app\api\controller\v1
*/
class Book
{}
```
# 配置方法注释参数验证，有两种方式
## 使用 @validate 模型验证器
| 名称 | 注释 | 参数1 |
| :-: |:-:|:-:|
| validate | 验证器类验证定义 | 验证器类名：例如**"application/api/validate/user/LoginForm"**,就写 **LoginForm** |
- 例如：`@validate('LoginForm') `相当于调用的`\app\api\validate\user\LoginForm`去验证
```php
/**
* 账户登陆
* @route('cms/user/login','post')
* @param Request $request
* @validate('LoginForm')
* @return array
* @throws \think\Exception
*/
public function login(Request $request)
{
(new LoginForm())->goCheck();
$params = $request->post();
$user = LinUser::verify($params['nickname'], $params['password']);
$result = Token::getToken($user);
logger('登陆领取了令牌', $user['id'], $user['nickname']);
return $result;
}
```
- 例如：`@validate('\app\api\validate\user\LoginForm') `相当于调用的`\app\api\validate\user\LoginForm`去验证
> 这种方式只是为了完成某种特定的验证模型路径开发的，以`/`开头或者`\\`，都会当作验证器类的完整命名空间，不会再去目录下检测类是否存在
```php
/**
* 账户登陆
* @route('cms/user/login','post')
* @param Request $request
* @validate('\app\api\validate\user\LoginForm')
* @return array
* @throws \think\Exception
*/
public function login(Request $request)
{
(new LoginForm())->goCheck();
$params = $request->post();
$user = LinUser::verify($params['nickname'], $params['password']);
$result = Token::getToken($user);
logger('登陆领取了令牌', $user['id'], $user['nickname']);
return $result;
}
```
## 使用 @param 参数验证器
| 名称 | 注释 | 参数1 | 参数2 | 参数3 |
| :-: |:-:|:-:|:-:|:-:|
| param | 参数验证器定义 | 参数名称 | 参数注释 | 参数规则 |
> '参数规则' 对应TP的验证规则，例如：@param('id','ID','require|max:1000|min:1')
```php
/**
* 查询指定bid的图书
* @route('v1/book/:bid','get')
* @param Request $bid
* @param('bid','bid的图书','require')
* @return mixed
*/
public function getBook($bid)
{
$result = BookModel::get($bid);
return $result;
}
```
# 联系我们
- QQ: `354007048`
- Email: `[email protected]`