README

Yii2 数据库设置

安装

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

运行以下命令

php composer.phar require --prefer-dist xti/yii2-settings "*"

或者添加以下内容到你的 composer.json 文件的 require 部分：

"xti/yii2-settings": "*"

随后运行

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

来在你的数据库中创建设置表。

使用方法

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

将以下内容添加到主配置的 modules 数组中

'modules' => [
    'settings' => [
        'class' => 'xti\settings\Module',
        'sourceLanguage' => 'en'
    ],
    ...
],

将以下内容添加到主配置的 components 数组中

'components' => [
    'settings' => [
        'class' => 'xti\settings\components\Settings'
    ],
    ...
]

典型组件使用方法

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

$value = $settings->get('section.key');

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

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

$settings->set('section.key', 'value', null, null, 'string');

$settings->set('key', 'value', 'section', 'description', 'integer');

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

SettingsAction

要使用自定义设置表单，可以使用包含的 SettingsAction。

1. 创建一个包含你的验证规则的模型类。
2. 创建一个关联视图，包含 ActiveForm 和你需要的所有设置。
3. 将 xti\settings\SettingsAction 添加到控制器的 actions 中。

设置将存储在表单名称中提取的分区，键为字段名称。

模型:

class Site extends Model {
	public $siteName, $siteDescription;
	public function rules()
	{
		return [
			[['siteName', 'siteDescription'], 'string'],
		];
	}
	
	public function fields()
	{
	        return ['siteName', 'siteDescription'];
	}
	
	public function attributes()
	{
	        return ['siteName', 'siteDescription'];
	}
}

视图:

<?php $form = ActiveForm::begin(['id' => 'site-settings-form']); ?>
<?= $form->field($model, 'siteName') ?>
<?= $form->field($model, 'siteDescription') ?>

控制器:

function actions(){
   return [
   		//....
            'site-settings' => [
                'class' => 'xti\settings\SettingsAction',
                'modelClass' => 'app\models\Site',
                //'scenario' => 'site',	// Change if you want to re-use the model for multiple setting form.
                'viewName' => 'site-settings'	// The form we need to render
            ],
        //....
    ];
}