README

提供一个统一的接口来展示配置模块的章节。此包为“后端/工具”添加了一个名为“设置”的章节。

查看Modera\BackendToolsSettingsBundle\ModeraBackendToolsSettingsBundle以获取公开的扩展点列表。

安装

步骤 1: 下载包

composer require modera/backend-tools-settings-bundle:4.x-dev

此命令要求您全局安装了Composer，具体请参阅Composer文档中的安装章节。

步骤 2: 启用包

此包应该由Flex自动启用。如果您不使用Flex，您需要在项目的config/bundles.php文件中手动启用该包，添加以下行：

<?php
// config/bundles.php

return [
    // ...
    Modera\BackendToolsSettingsBundle\ModeraBackendToolsSettingsBundle::class => ['all' => true],
];

如何贡献自己的设置章节

为了仅向设置章节贡献一个章节（活动），您需要创建一个提供器类，该类将返回Modera\BackendToolsSettingsBundle\Section\SectionInterface的实例。以下是一个贡献类可能的样子：

<?php

namespace MyCompany\BlogBundle\Contributions;

use Modera\BackendToolsSettingsBundle\Section\StandardSection;
use Modera\MjrIntegrationBundle\Model\FontAwesome;
use Sli\ExpanderBundle\Ext\ContributorInterface;

class SettingsSectionsProvider implements ContributorInterface
{
    /**
     * @inheritDoc
     */
    public function getItems()
    {
        return array(
            new StandardSection(
                'blog',
                'Blog',
                'Modera.backend.configutils.runtime.SettingsListActivity',
                FontAwesome::resolve('cog', 'fas'),
                array('category' => 'blog')
            )
        );
    }
}

一旦创建了类，您需要使用标签modera_backend_tools_settings.contributions.sections_provider将其注册到服务容器中。

<services>
    <service id="mycompany_blog.contributions.settings_sections_provider"
             class="MyCompany\BlogBundle\Contributions\SettingsSectionsProvider">

        <tag name="modera_backend_tools_settings.contributions.sections_provider" />
    </service>
</services>

现在，如果您转到“后端/工具/设置”，您应该在那里看到一个名为“博客”的章节，其URL将命名为“blog”，图标为“gear”（见FontAwesome库），并使用Modera.backend.dcab.runtime.SettingsListActivity JavaScript活动来创建其UI。

许可

此包受MIT许可证的约束。请参阅包中的完整许可证：Resources/meta/LICENSE