README

本包解决的问题是，参数通过map传递导致参数无法被编辑器识别的问题。

良好的代码，从能被编辑器识别开始。

注意，本包在hyperf框架下使用，其它框架下，需要实现Arg\AbstractArg 抽象类，实现方式非常简单，可参考Arg\BaseArgForHyperf。

安装命令：composer require buexplain/arg

使用示例

以注册接口为例子，做个简单的示例。

第一步：构造一个注册接口需要的参数描述。

<?php

namespace App\Arg;

use Arg\Attr\ValidationAttr;
use Arg\BaseArgForHyperf;

/**
 * 注册一个用户
 */
class RegisterArg extends BaseArgForHyperf
{
    /**
     * @var string 账号
     */
    #[ValidationAttr('required')]
    public string $account;

    /**
     * @var string 密码
     */
    #[ValidationAttr('required')]
    public string $password;

    /**
     * @var string 验证码
     */
    #[ValidationAttr('required')]
    public string $verification_code;
}

第二步：编写注册接口的控制器

<?php

declare(strict_types=1);

namespace App\Controller;

use App\Arg\RegisterArg;
use App\Services\RegisterService;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;

class IndexController extends AbstractController
{
    /**
     * 注册用户
     * @return array
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    public function index(): array
    {
        //初始化参数类
        $registerArg = new RegisterArg($this->request->all());
        //校验数据
        $msgBag = $registerArg->validate();
        if ($msgBag->isNotEmpty()) {
            //校验失败，返回错误信息
            return [
                'code' => 1,
                'message' => $msgBag->first(),
            ];
        }
        //调用service层的注册逻辑，执行注册动作，并返回注册结果
        return [
            'code' => 0,
            'data' => RegisterService::create($registerArg),
            'message' => '注册成功',
        ];
    }
}

第三步：实现注册逻辑

<?php

declare(strict_types=1);

namespace App\Services;

use App\Arg\RegisterArg;

class RegisterService
{
    /**
     * 注册用户
     * @param RegisterArg $arg
     * @return array
     */
    public static function create(RegisterArg $arg): array
    {
        //$arg因为是一个类，所以里面有什么属性，编辑器可以识别的一清二楚。
        //开始注册逻辑，这里假设注册成功后返回账号信息
        return ['account' => $arg->account];
    }
}

注意事项

在php8.2中，支持：null、false 和 true 作为独立的类型。如果将一个类的属性设置为纯null、false 或 true类型，或者三者任意联合的类型，那么在注入外部参数的时候将无法正确转换为null、false 或 true，因为在反射类属性阶段，无法识别出该属性的类型，从而无法正确转换。

运行测试用例

Windows下：

swoole-cli.exe /cygdrive/c/buexplain/arg/vendor/bin/co-phpunit --prepend tests/bootstrap.php --configuration phpunit.xml --log-events-verbose-text phpunit.log

Linux： composer test

buexplain / arg

Maintainers

Details

README

使用示例

注意事项

运行测试用例