xiidea / easy-config
一个用于简化配置管理的Symfony Bundle
Requires
- php: >=8.0
- doctrine/dbal: ^3.2|^4.0
- doctrine/orm: ^2.4|^3.0
- symfony/form: >=5.0 <7.0.0
- symfony/framework-bundle: >=5.0 <7.0.0
- symfony/http-foundation: >=5.0 <7.0.0
- symfony/security-bundle: >=5.0 <7.0.0
- symfony/security-core: >=5.0 <7.0.0
- symfony/twig-bundle: >=5.0 <7.0.0
Requires (Dev)
- symfony/test-pack: ^1.1
- dev-main
- 0.0.1
- dev-bugfix/configuration-group-not-inject
- dev-bugfix/exception-identifier-null-value
- dev-feature/orm-dependency
- dev-bugfix/twig-bundle-not-found
- dev-bugfix/deprecations-sf6
- dev-bugfix/constructor-param-missing
- dev-feature/change-github-actions
- dev-feature/unit-test-case
- dev-bugfix/patch-1
- dev-saifulferoz-patch-1-1
- dev-saifulferoz-patch-1
This package is auto-updated.
Last update: 2024-09-25 09:04:35 UTC
README
一个用于简化配置管理的Symfony Bundle。
功能包括
- 按组动态创建表单的能力
- 存储全局配置
- 存储用户配置
- 通过REST API获取配置
安装
- 下载并启用EasyConfigBundle
- 创建配置实体类
- 配置yaml文件
- 更新数据库模式
- 创建你的第一个表单
- 注册Bundle的路线
- 覆盖默认EasyConfigBundle模板(可选)
1. 下载并启用EasyConfigBundle
通过composer下载
打开命令行,进入项目目录并执行以下命令以下载此Bundle的最新稳定版本
$ composer require xiidea/easy-config
启用Bundle(当Flex可用时不需要)
Bundle应自动由Symfony Flex启用。如果您不使用Flex,您需要在项目的config/bundles.php文件中手动添加以下行以启用Bundle
<?php // src/Kernel.php return [ // ... Xiidea\EasyConfigBundle\XiideaEasyConfigBundle::class => ['all' => true], ];
2. 创建配置实体类
默认情况下,EasyConfigBundle支持Doctrine ORM。但是,您必须提供一个实体类,并且该类必须扩展类\Xiidea\EasyConfigBundle\Model\BaseConfig。为了正确配置实体类,请按照以下详细说明操作。
3. 配置yaml文件
在以下目录中创建一个名为config/packages的文件,名称为xiidea_easy_config.yaml。示例配置文件位于此路径Resources/config/config-sample.yml中。复制此示例文件的内容并将其粘贴到刚刚创建的文件中。不要忘记更改在第3步中提到的实体类名称。
# Xiidea Easy Config Configuration Sample xiidea_easy_config: config_class: App\Entity\Configuration
4. 更新数据库模式
是时候设置数据库模式了,打开您的命令行,转到项目根路径并执行以下命令。
$ php bin/console doctrine:schema:update --force
5. 创建表单组和类型
创建一个表单组类和表单类型,包含必要的字段。请按照以下说明创建表单组和类型。
6. 注册Bundle的路线
现在可以访问您刚刚创建的表单了,为此您需要通过以下方式将Bundle的路线包含到应用程序中。
xiidea_config_route: resource: "@XiideaEasyConfigBundle/Resources/config/routes.yaml" prefix: '/config'
注意:您可以根据需要更改前缀
此Bundle中可用的以下路由
- 索引路由(前缀/):所有表单列表
- 表单组路由(前缀/group_key):特定组键的表单
7. 覆盖默认EasyConfigBundle模板(可选)
模板覆盖对使用EasyConfigBundle Bundle不是很重要,但如果您想使UI与您的应用程序尽可能相似,则可以覆盖模板,为此请按照以下说明操作。
恭喜!
您的应用程序已准备好存储配置,只需浏览这些路由即可。
许可证
Easy Config Bundle根据MIT许可证授权。有关详细信息,请参阅LICENSE文件。