README

Yii2 Settings

Is fork of Yii2 Database settings phemellc/yii2-settings with improved and experimental features.

Installation

The preferred way to install this extension is through composer.

Either run

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

or add

"shurik2k5/yii2-settings": "*"

to the require section of your composer.json file.

Subsequently, run

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

in order to create the settings table in your database.

Migrate from phemellc/yii2-settings

For use this package not need change you application configuration.
This package use same namespace as phemellc/yii2-settings that you can simply replace in composer.json

"pheme/yii2-settings": "*"

"shurik2k5/yii2-settings": "*"

and run composer install/update

php composer.phar install

And that's all.

Usage

There are 2 parts to this extension. A module and a component. The module provides a simple GUI to edit your settings. The component provides a way to retrieve and save settings programmatically.

Add this to your main configuration's modules array

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

Add this to your main configuration's components array

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

Typical component usage

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

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

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

$value = $this->setting->getOrSet('key', 'defaultValue', 'section', 'string');

$value = $this->setting->getOrSet('section.key', 'defaultValue');

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

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

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

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

SettingsAction

To use a custom settings form, you can use the included SettingsAction.

Create a model class with your validation rules.
Create an associated view with an ActiveForm containing all the settings you need.
Add pheme\settings\SettingsAction to the controller's actions.

The settings will be stored in section taken from the form name, with the key being the field name.

Model:

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'];
	}
}

Views:

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

<?= $form->field($model, 'siteName') ?>
<?= $form->field($model, 'siteDescription') ?>
<?= Html::submitButton('Save', ['class' => 'btn btn-success']) ?>

<?php ActiveForm::end(); ?>

Controller:

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

shurik2k5 / yii2-settings

Maintainers

Details