Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yii2mod/yii2-settings
Persistent settings in Yii2
https://github.com/yii2mod/yii2-settings
yii2 yii2-extension yii2-settings yii2-settings-module
Last synced: about 12 hours ago
JSON representation
Persistent settings in Yii2
- Host: GitHub
- URL: https://github.com/yii2mod/yii2-settings
- Owner: yii2mod
- License: mit
- Created: 2015-02-27T11:21:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T17:51:48.000Z (almost 5 years ago)
- Last Synced: 2024-09-18T22:09:49.886Z (9 days ago)
- Topics: yii2, yii2-extension, yii2-settings, yii2-settings-module
- Language: PHP
- Homepage:
- Size: 99.6 KB
- Stars: 102
- Watchers: 11
- Forks: 33
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Yii2 Settings Extension
Persistent, application-wide settings for Yii2.
[](https://packagist.org/packages/yii2mod/yii2-settings) [](https://packagist.org/packages/yii2mod/yii2-settings) [](https://packagist.org/packages/yii2mod/yii2-settings)
[](https://travis-ci.org/yii2mod/yii2-settings)
[](https://scrutinizer-ci.com/g/yii2mod/yii2-settings/?branch=master)
## Support us
Does your business depend on our contributions? Reach out and support us on [Patreon](https://www.patreon.com/yii2mod).
All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```sh
php composer.phar require --prefer-dist yii2mod/yii2-settings "*"
```
or add
```
"yii2mod/yii2-settings": "*"
```
to the require section of your composer.json.
Configuration
-------------
**Database Migrations**
Before usage this extension, we'll also need to prepare the database.
```sh
php yii migrate --migrationPath=@vendor/yii2mod/yii2-settings/migrations
```
**Module Setup**
To access the module, you need to configure the modules array in your application configuration:
```php
'modules' => [
'settings' => [
'class' => 'yii2mod\settings\Module',
],
],
```
You can then access settings management section through the following URL:
```
http://localhost/path/to/index.php?r=settings
```
or if you have enabled pretty URLs, you may use the following URL:
```
http://localhost/path/to/index.php/settings
```
**Component Setup**
To use the Setting Component, you need to configure the components array in your application configuration:
```php
'components' => [
'settings' => [
'class' => 'yii2mod\settings\components\Settings',
],
],
```
Usage:
---------
```php
$settings = Yii::$app->settings;
$value = $settings->get('section', 'key');
$settings->set('section', 'key', 125.5);
$settings->set('section', 'key', 'false', SettingType::BOOLEAN_TYPE);
// Checking existence of setting
$settings->has('section', 'key');
// Activates a setting
$settings->activate('section', 'key');
// Deactivates a setting
$settings->deactivate('section', 'key');
// Removes a setting
$settings->remove('section', 'key');
// Removes all settings
$settings->removeAll();
// Get's all values in the specific section.
$settings->getAllBySection('section');
$settings->invalidateCache(); // automatically called on set(), remove();
```
Manage custom settings
----------------------
You can use your own form model to manage custom settings for your web application via `SettingsAction`.
To use the `SettingsAction` class you need to follow the following steps:
1) Create your own model, for example:
```php
Yii::t('app', 'Application Name'),
'adminEmail' => Yii::t('app', 'Admin Email'),
];
}
}
```
2) Create view file, named `settings.php` with the following content:
```php
title = Yii::t('app', 'Manage Application Settings');
?>
field($model, 'appName'); ?>
field($model, 'adminEmail'); ?>
'btn btn-success']) ?>
```
3) Add settings action to your controller class as follows:
```php
[
'class' => \yii2mod\settings\actions\SettingsAction::class,
// also you can use events as follows:
'on beforeSave' => function ($event) {
// your custom code
},
'on afterSave' => function ($event) {
// your custom code
},
'modelClass' => \app\models\forms\ConfigurationForm::class,
],
];
}
}
```
*Now you can access to the settings page by the following URL: http://localhost/path/to/index.php?r=site/manage-settings/*
Internationalization
----------------------
All text and messages introduced in this extension are translatable under category 'yii2mod.settings'.
You may use translations provided within this extension, using following application configuration:
```php
return [
'components' => [
'i18n' => [
'translations' => [
'yii2mod.settings' => [
'class' => 'yii\i18n\PhpMessageSource',
'basePath' => '@yii2mod/settings/messages',
],
// ...
],
],
// ...
],
// ...
];
```