navalex/config-bundle

Symfony NavalexConfigBundle

安装: 6

依赖: 0

建议者: 0

安全: 0

星标: 1

关注者: 3

分支: 0

公开问题: 0

类型:symfony-bundle

dev-master 2018-08-10 14:32 UTC

This package is not auto-updated.

Last update: 2024-09-25 16:34:45 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License composer.lock available

允许你在项目中创建可用的配置(Twig 和 Controller 服务),并通过分为两部分的行政面板进行管理

  • 配置表单按类别和字段集划分,以便编辑配置的值
  • 为你的表单创建类别、字段集和配置字段

安装

使用 Symfony Flex 的应用程序

打开命令行,进入你的项目目录,执行

$ composer require navalex/config-bundle

不使用 Symfony Flex 的应用程序

步骤 1:下载包

打开命令行,进入你的项目目录,并执行以下命令以下载此包的最新稳定版本

$ composer require navalex/config-bundle

此命令要求你全局安装了 Composer,如 Composer 文档中的安装章节所述。

步骤 2:启用包

然后,通过将其添加到项目中 app/AppKernel.php 文件中注册的包列表中启用包

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Knp\Bundle\PaginatorBundle\KnpPaginatorBundle(),
            new Navalex\ConfigBundle\NavalexConfigBundle(),
        );

        // ...
    }

    // ...
}

步骤 3:更新数据库

为了让插件工作,你需要通过输入以下命令更新数据库表

$ php bin/console doctrine:schema:update --force

配置

步骤 1:启用路由

打开 app/config/routing.yml 并添加

# app/config/routing.yml

navalex.config_bundle:
    resource: '@NavalexConfigBundle/Resources/config/routing.yml'

(可选)步骤 2:保护行政面板

如果你想要将面板的访问权限限制为特定的角色,你可以在 app/config/security.yml 中进行如下操作(仅允许 ROLE_ADMIN 访问)

# app/config/security.yml

security:
    
    # ...

    role_hierarchy:
         # ...
        ROLE_ADMIN:       ROLE_USER
        ROLE_SUPER_ADMIN: ROLE_ADMIN

    access_control:
         # ...
        - { path: ^/admin/, role: ROLE_ADMIN }

步骤 3:更新缓存

完成所有操作后,更新 symfony 缓存以访问面板

$ php bin/console cache:clear
or
$ php bin/console cache:clear --env=prod

使用方法

步骤 1:创建配置

访问 http://<your_website>/admin/config/admin/config/conf

在这里你可以创建表单类别,然后为其添加字段集以组织表单,最后创建配置。这里是一个配置字段的详细信息

  • 名称:此配置的行政表单标签
  • 代码:在 Twig 和 Controller 中调用配置的唯一代码
  • 类别/字段:为此配置选择表单和字段集
  • 类型:配置将是什么类型的字段。默认情况下,包为每个新配置提供值 "data"。

步骤 2:编辑配置值

现在你将看到配置类别表单出现在面板的导航栏上。只需点击它并享受吧!

步骤 3:在项目中调用配置

在控制器中

$configs = $this->get('navalex_config.config');
$configs->get('<your_configuration_code>');

在 Twig 中

{{ getConfig('<your_configuration_code>') }}

即将推出功能

  • 配置标签的翻译域
  • 新的复杂字段类型
    • 数组(通过 AJAX 按钮添加文本输入)
    • 图片(自动上传和命名)
  • 完整的 Navapanel 仪表板
  • 在面板中排序表单类别
  • 通过 API URL(如 http://<your_website>/config/<code>)获取配置,并返回 JSON
  • 在 symfony 配置中自定义字段类型
  • ...

许可

此包位于 MIT 许可下。请参阅完整许可