PHPackages                             mmarouf/yii2-settings - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. mmarouf/yii2-settings

ActiveYii2-extension[Database & ORM](/categories/database)

mmarouf/yii2-settings
=====================

Yii2 Database settings

03PHP

Since May 29Pushed 8y ago1 watchersCompare

[ Source](https://github.com/eng-mmarouf/yii2-settings)[ Packagist](https://packagist.org/packages/mmarouf/yii2-settings)[ RSS](/packages/mmarouf-yii2-settings/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Yii2 Settings
=============

[](#yii2-settings)

Yii2 Database settings

Installation
------------

[](#installation)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

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

```

or add

```
"mmarouf/yii2-settings": "*"

```

to the require section of your `composer.json` file.

Subsequently, run

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

in order to create the settings table in your database.

Usage
-----

[](#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' => 'mmarouf\settings\Module',
        'sourceLanguage' => 'en'
    ],
    ...
],
```

Add this to your main configuration's components array

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

Typical component usage

```
$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, 'string');

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

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

SettingsAction
--------------

[](#settingsaction)

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

1. Create a model class with your validation rules.
2. Create an associated view with an `ActiveForm` containing all the settings you need.
3. Add `mmarouf\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**:

```