CraueConfigBundle 技术文档

1. 安装指南

获取Bundle

使用Composer下载并安装Bundle，运行以下命令：

composer require craue/config-bundle

启用Bundle

如果不使用Symfony Flex，请手动注册Bundle：

// 在 config/bundles.php
return [
    // ...
    Craue\ConfigBundle\CraueConfigBundle::class => ['all' => true],
];

创建数据表

推荐使用以下命令：

# 在命令行
php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

或者：

# 在命令行
php bin/console doctrine:schema:update

添加管理设置的路由（可选）

可以选择导入默认的路由配置：

# 在 app/config/routing.yml
craue_config_settings:
  resource: "@CraueConfigBundle/Resources/config/routing/settings.xml"
  prefix: /settings

或者添加自己的路由以完全控制URL模式：

# 在 app/config/routing.yml
craue_config_settings_modify:
  path: /settings/modify
  defaults:
    _controller: Craue\ConfigBundle\Controller\SettingsController::modifyAction

安装CSS以正确渲染表单：

# 在命令行
php bin/console assets:install --symlink web

2. 使用说明

定义设置

该Bundle不提供在运行时创建新设置的功能，因为这没有意义。这些设置将用于您的应用程序，因此需要为它们编写代码。这意味着您需要自己在数据库表craue_config_setting中创建新的设置，例如通过迁移。

管理设置的值

如果添加了上述路由，可以通过简单的表单管理所有已定义设置的值。默认情况下，可以通过访问/settings/modify来访问该表单。但您可能希望在安全配置中限制对此表单的访问。

读取和写入设置

Bundle提供了服务Craue\ConfigBundle\Util\Config用于访问设置。要在控制器中直接使用它，可以添加自动注入的类型提示参数到动作中：

// 在 src/Controller/MyController.php
use Craue\ConfigBundle\Util\Config;

public function indexAction(Config $config) {
    // 使用 $config
}

或者在控制器中扩展Symfony\Bundle\FrameworkBundle\Controller\AbstractController并定义getSubscribedServices使服务别名craue_config可用：

// 在 src/Controller/MyController.php
use Craue\ConfigBundle\Util\Config;

public function indexAction() {
    // 使用 $this->get('craue_config')
}

public static function getSubscribedServices() {
    return array_merge(parent::getSubscribedServices(), [
        'craue_config' => Config::class,
    ]);
}

该服务定义了以下方法：

• all() - 获取所有定义的设置及其值的关联数组
• get($name) - 获取指定设置的值
• getBySection($section) - 类似all()，但仅获取指定节内的设置
• set($name, $value) - 设置指定设置的值
• setMultiple([$name1 => $value1, $name2 => $value2]) - 一次性设置多个设置的值

请记住，每个设置都必须存在，否则会抛出异常。

在Twig模板中的使用

该Bundle的Twig扩展支持在模板中直接读取设置：

{{ craue_setting('name-of-a-setting') }}

3. 项目API使用文档

API文档暂时无从提供，需要进一步开发或查阅官方文档。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明。主要是通过Composer获取Bundle，并在项目中启用相应的配置和路由。