README

具有数据库模块和GUI管理器支持的Yii2设置。

安装

安装此扩展的首选方式是通过composer。

可以运行

$ composer require zakharov-andrew/yii2-settings

或者添加

"zakharov-andrew/yii2-settings": "*"

到你的composer.json文件的require部分。

随后运行

./yii migrate/up --migrationPath=@vendor/zakharov-andrew/yii2-settings/migrations

以在您的数据库中创建设置表。

使用方法

此扩展包括两部分：一个模块和一个组件。模块提供了一个简单的GUI来编辑设置。组件提供了以编程方式检索和保存设置的方法。

将此添加到主配置的modules数组中

    'modules' => [
        'settings' => [
            'class' => 'ZakharovAndrew\settings\Module',
            'bootstrapVersion' => 5, // if use bootstrap 5
        ],
        // ...
    ],

将此添加到主配置的components数组中

    'components' => [
        'settings' => [
            'class' => 'ZakharovAndrew\settings\Settings',
        ],
    ],

在你的应用程序配置文件的urlManager中添加一个新规则，例如

'urlManager' => [
    'rules' => [
        'settings' => 'settings/default/index',
        'settings/create' => 'settings/default/create',
        'settings/update' => 'settings/default/update',
        'settings/delete' => 'settings/default/delete',
        'setting-groups/create' => 'settings/setting-groups/create',
        'setting-groups/update' => 'settings/setting-groups/update',
        'setting-groups/delete' => 'settings/setting-groups/delete',
    ],
],

典型组件使用

$settings = Yii::$app->settings;

$valueList = $settings->get('group1');

$value = $settings->get('group1', 'key');

$settings->set('group1', 'key', 'value');

// Automatically called on set();
$settings->clearCache();

许可证

yii2-settings在BSD 3-Clause许可证下可用。详细信息请参阅LICENSE.md。