yuandian/validation

Helpers for making PHP Attribute validation.

v1.1.0 2024-12-17 07:50 UTC

This package is auto-updated.

Last update: 2025-05-21 07:01:51 UTC


README

使用PHP原生属性进行参数校验

安装

composer require yuandian/validation

使用示例

  • 定义实体文件 UserRequest.php
use yuandian\rules\NotEmpty;
use yuandian\rules\Email;
use yuandian\rules\Scene;

// 用于配置场景验证
#[Scene("add",  ['name'])]
class UserRequest {
    #[NotEmpty(message: "Name cannot be empty.")]
    public string $name;

    #[Email(message: "Invalid email format.")]
    #[NotEmpty(message: "Email cannot be empty.")]
    public string $email;
}
  • 赋值与验证
require_once 'vendor/autoload.php';

use yuandian\Validation\Validator
use yuandian\Validation\Exception\ValidateException;

$request = new UserRequest();
$request->name = '张三';
$request->email = 'zhangsan@Validator'
// 验证实体
try {
    $validator = new Validator();
   
    $validator->validate($userRequest);
    // 批量验证
    // $validator->batch(true)->validate($userRequest);
    // 场景验证
    // $validator->validate($userRequest, 'add');
} catch (ValidateException $e) {
    echo "Validation errors: " . $e->getMessage() . "\n";
}

自动赋值&&自动验证

  • 定义实体文件 UserRequest.php
use yuandian\rules\NotEmpty;
use yuandian\rules\Email;
use yuandian\BaseValidatorEntity;

class UserRequest extends BaseValidatorEntity {
    #[NotEmpty(message: "Name cannot be empty.")]
    public string $name;

    #[Email(message: "Invalid email format.")]
    #[NotEmpty(message: "Email cannot be empty.")]
    public string $email;
}
  • 赋值与验证
require_once 'vendor/autoload.php';

use yuandian\Validation\Exception\ValidateException;

// 模拟请求数据
$requestData = [
    'name' => 'John Doe',
    'email' => 'invalid-email'
];

// 验证实体
try {
    $request = new UserRequest($requestData);
} catch (ValidateException $e) {
    echo "Validation errors: " . $e->getMessage() . "\n";
}

自定义验证规则

  • 实现 yuandian\Validation\Rule接口
  • 在自定义的类上增加#[Attribute(Attribute::TARGET_PROPERTY)]注解

捐献