free2one/hyperf-php-accessor

PHP Accessor SDK for Hyperf framework

0.5.3 2024-01-11 08:53 UTC

Requires

• php: >=8.0
• ext-pcntl: *
• free2one/php-accessor: ~0.5.0
• hyperf/command: *
• hyperf/di: *
• hyperf/event: *
• hyperf/framework: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• mockery/mockery: ^1.0
• phpstan/phpstan: ^1.0
• phpunit/phpunit: >=7.0
• swoole/ide-helper: ^4.5
• symfony/var-dumper: ^6.0

MIT

• php
• hyperf

README

安装

composer require free2one/hyperf-php-accessor

发布配置

php bin/hyperf.php vendor:publish free2one/hyperf-php-accessor

项目composer.json 文件中配置以下信息信息

{
    "scripts":{
        "php-accessor": "@php vendor/bin/php-accessor generate"
    }
}

通过#[Data]注解原始类

<?php
namespace App;

use PhpAccessor\Attribute\Data;

#[Data]
class Entity
{
    private int $id;

    private string $name;
}

更多注解使用说明详见PHP Accessor.

PHPStorm插件

建议配合 PHP Accessor IDEA Plugin 使用, 该插件支持访问器的跳转,代码提示,查找及类字段重构等.

配置项说明

is_dev_mode

• true: 每次启动时重新生成访问器代理类.
• false: 启动时检测代理目录是否存在,存在则不再重新生成.

proxy_root_directory

访问器代理类存放目录,默认为.php-accessor目录.

log_level

日志级别,默认为debug.

max_concurrent_processes

最大并行进程数,默认为2.

max_files_per_process

进程内最大处理文件数,默认为200.

注意事项

跳转 or 查找不生效

本地开发请务必打开is_dev_mode配置项, 否则PHP Accessor IDEA Plugin将无法正常使用.

<?php

declare(strict_types=1);

use Psr\Log\LogLevel;

return [
    'is_dev_mode' => true, // 是否开启开发模式,本地开发时建议开启,否则无法配合ide插件使用
    'proxy_root_directory' => '.php-accessor',
    'log_level' => LogLevel::DEBUG,
    'max_concurrent_processes' => 2,  
    'max_files_per_process' => 200,   
];

相关资源

PHP Accessor: 访问器生成器

PHP Accessor IDEA Plugin: Phpstorm插件,文件保存时自动生成访问器.支持访问器的跳转,代码提示,查找及类字段重构等.

Hyperf PHP Accessor: Hyperf框架SDK

Laravel PHP Accessor: Laravel框架SDK