rich-id/autoconfigure-bundle

使用注解创建简单的自动配置,为服务添加标签、注入服务和参数或装饰其他服务

安装次数: 42,033

依赖项: 0

建议者: 0

安全: 0

星标: 3

关注者: 2

分支: 1

开放性问题: 0

类型:symfony-bundle

v1.1.0 2021-12-24 14:49 UTC

This package is auto-updated.

Last update: 2024-09-11 17:10:14 UTC


README

autoconfigure bundle badge badge maintainability contributions welcome brightgreen license MIT blue PHP 7 PHP 8 Symfony 4%2B black Symfony 5%2B black

简化Symfony的服务声明和标记。

目录

1. 快速展示

导入注解/注解,并按以下方式配置您的服务

use RichId\AutoconfigureBundle\Annotation as Service;

/**
 * @Service\Argument("$service", DecorationEventListener::class)
 * @Service\Decoration("any_service")
 * @Service\Tag(name="special_tag")
 */
final class DummyClass
{
    public function __construct($service)
    {
        ...
    }
}

2. 安装

本版本包需要Symfony 4.4+和PHP 7.3+。

composer require rich-id/autoconfigure-bundle

3. 文档

3.1. 注入服务或参数

3.2. 添加事件监听器

3.3. 装饰服务

3.4. 标记服务

4. 版本控制

autoconfigure-bundle遵循语义版本控制。简而言之,该方案是MAJOR.MINOR.PATCH,其中1. MAJOR在发生重大更改时增加,2. MINOR在以向后兼容的方式添加新功能时增加,3. PATCH在以向后兼容的方式修复错误时增加。

1.0.0以下的版本被视为实验性版本,任何时间都可能发生破坏性更改。

5. 贡献

欢迎贡献!有许多贡献方式,我们感激所有贡献。以下是一些主要的贡献方式:

  • 错误报告:虽然我们努力提供高质量的软件,但错误可能会发生,我们无法修复我们不知道的问题。所以,即使您不确定或者只是想提问,也请报告问题。无论如何,问题可能表明文档还可以进一步改进!

  • 功能请求:当前API没有涵盖您的用例?想要建议更改或添加某些内容?我们将很高兴阅读有关内容并开始讨论,以尝试找到最佳可能的解决方案。

  • 拉取请求:想要贡献代码或文档?我们将非常乐意!如果您需要帮助开始,GitHub有关于拉取请求的文档。我们使用"分支和拉取请求模型",贡献者将更改推送到他们的个人分支,然后创建拉取请求到主仓库。请确保您的拉取请求针对master分支。

提醒一下,所有贡献者都应遵守我们的行为准则

6. 许可证

autoconfigure-bundle在MIT许可证的条款下分发。

请参阅许可协议获取详细信息。

7. 开发

您可以使用Docker和docker-compose来修改该项目。以下是一些相关命令。

# Start the project
docker-compose up -d

# Install dependencies
docker-compose exec application composer install

# Run tests
docker-compose exec application bin/phpunit

# Run a bash within the container
docker-compose exec application bash