Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yii2tech/config
Yii2 application runtime configuration support
https://github.com/yii2tech/config
config configuration runtime yii yii2 yii2-extension
Last synced: about 2 months ago
JSON representation
Yii2 application runtime configuration support
- Host: GitHub
- URL: https://github.com/yii2tech/config
- Owner: yii2tech
- License: other
- Archived: true
- Created: 2015-07-08T13:01:42.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-10-10T02:47:06.000Z (almost 3 years ago)
- Last Synced: 2024-07-17T18:17:11.268Z (2 months ago)
- Topics: config, configuration, runtime, yii, yii2, yii2-extension
- Language: PHP
- Size: 67.4 KB
- Stars: 62
- Watchers: 10
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-yii2 - yii2tech/config - Application runtime config. (Core components)
README
Application Runtime Configuration Extension for Yii 2
This extension provides support for application runtime configuration, loading config from database.
For license information check the [LICENSE](LICENSE.md)-file.
[](https://packagist.org/packages/yii2tech/config)
[](https://packagist.org/packages/yii2tech/config)
[](https://travis-ci.org/yii2tech/config)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist yii2tech/config
```
or add
```json
"yii2tech/config": "*"
```
to the require section of your composer.json.
Usage
-----
This extension allows reconfigure already created Yii application instance using config composed from external storage
like relational database, MongoDB and so on. It allows to reconfigure any application property, component or module.
Configuration is performed by [[\yii2tech\config\Manager]] component, which should be added to the application configuration.
For example:
```php
[
'bootstrap' => [
'configManager',
// ...
],
'components' => [
'configManager' => [
'class' => 'yii2tech\config\Manager',
'items' => [
'appName' => [
'path' => 'name',
'label' => 'Application Name',
'rules' => [
['required']
],
],
'nullDisplay' => [
'path' => 'components.formatter.nullDisplay',
'label' => 'HTML representing not set value',
'rules' => [
['required']
],
],
],
],
...
],
];
```
[[\yii2tech\config\Manager]] implements [[\yii\base\BootstrapInterface]] interface, thus being placed under 'bootstrap'
section it will apply runtime configuration during application bootstrap. You can apply config manually to the application
or any [[\yii\base\Module]] descendant, using following code:
```php
$configManager = Yii::$app->get('configManager');
$configManager->configure(Yii::$app);
```
## Configuration items specification
Application parts, which should be reconfigured are determined by [[\yii2tech\config\Manager::$items]], which is a list
of [[\yii2tech\config\Item]]. Each configuration item determines the configuration path - a list of keys in application
configuration array, which leads to the target value. For example: path 'components.formatter.nullDisplay' (or
`['components', 'formatter', 'nullDisplay']`) points to the property 'nullDisplay' of [[\yii\i18n\Formatter]] component,
path 'name' points to [[\yii\base\Application::name]] and so on.
> Note: if no path is specified it will be considered as a key inside [[\yii\base\Module::$params]] array, which matches
configuration item id (name of key in [[\yii2tech\config\Manager::$items]] array).
Configuration item may also have several properties, which supports creation of web interface for configuration setup.
These are:
- 'label' - string, input label.
- 'description' - string, configuration parameter description or input hint.
- 'rules' - array, value validation rules.
- 'inputOptions' - array, list of any other input options.
Here are some examples of item specifications:
```php
'appName' => [
'path' => 'name',
'label' => 'Application Name',
'rules' => [
['required']
],
],
'nullDisplay' => [
'path' => 'components.formatter.nullDisplay',
'label' => 'HTML representing not set value',
'rules' => [
['required']
],
],
'adminEmail' => [
'label' => 'Admin email address',
'rules' => [
['required'],
['email'],
],
],
'adminTheme' => [
'label' => 'Admin interface theme',
'path' => ['modules', 'admin', 'theme'],
'rules' => [
['required'],
['in', 'range' => ['classic', 'bootstrap']],
],
'inputOptions' => [
'type' => 'dropDown',
'items' => [
'classic' => 'Classic',
'bootstrap' => 'Twitter Bootstrap',
],
],
],
```
> Tip: since runtime configuration may consist of many items and their declaration may cost a lot of code, it can
be moved into a separated file and specified by this file name.
## Configuration storage
Declared configuration items may be saved into persistent storage and then retrieved from it.
The actual item storage is determined via [[\yii2tech\config\Manager::storage]].
Following storages are available:
- [[\yii2tech\config\StoragePhp]] - stores configuration inside PHP files
- [[\yii2tech\config\StorageDb]] - stores configuration inside relational database
- [[\yii2tech\config\StorageMongoDb]] - stores configuration inside MongoDB
- [[\yii2tech\config\StorageActiveRecord]] - finds configuration using ActiveRecord
Please refer to the particular storage class for more details.
## Creating configuration web interface
The most common use case for this extension is creating a web interface, which allows control of application
configuration in runtime.
[[\yii2tech\config\Manager]] serves not only for applying of the configuration - it also helps to create an
interface for configuration editing.
The web controller for configuration management may look like following:
```php
use yii\base\Model;
use yii\web\Controller;
use Yii;
class ConfigController extends Controller
{
/**
* Performs batch updated of application configuration records.
*/
public function actionIndex()
{
/* @var $configManager \yii2tech\config\Manager */
$configManager = Yii::$app->get('configManager');
$models = $configManager->getItems();
if (Model::loadMultiple($models, Yii::$app->request->post()) && Model::validateMultiple($models)) {
$configManager->saveValues();
Yii::$app->session->setFlash('success', 'Configuration updated.');
return $this->refresh();
}
return $this->render('index', [
'models' => $models,
]);
}
/**
* Restores default values for the application configuration.
*/
public function actionDefault()
{
/* @var $configManager \yii2tech\config\Manager */
$configManager = Yii::$app->get('configManager');
$configManager->clearValues();
Yii::$app->session->setFlash('success', 'Default values restored.');
return $this->redirect(['index']);
}
}
```
The main view file can be following:
```php
$model): ?>
field($model, "[{$key}]value");
$inputType = ArrayHelper::remove($model->inputOptions, 'type');
switch($inputType) {
case 'checkbox':
$field->checkbox();
break;
case 'textarea':
$field->textarea();
break;
case 'dropDown':
$field->dropDownList($model->inputOptions['items']);
break;
}
echo $field;
?>
= Html::a('Restore defaults', ['default'], ['class' => 'btn btn-danger', 'data-confirm' => 'Are you sure you want to restore default values?']); ?>
= Html::submitButton('Save', ['class' => 'btn btn-primary']) ?>
```
## Standalone configuration
[[\yii2tech\config\Manager]] can be used not only for application configuration storage: it may hold any abstract
configuration set for any standalone task. You can configure manager as an application component, which stores some
user settings as use it to retrieve it. For example:
```php
[
'components' => [
// no application boostap!
'userInterfaceConfig' => [
'class' => 'yii2tech\config\Manager',
'storage' => [
'class' => 'yii2tech\config\StorageDb',
'autoRestoreValues' => true, // restore config values from storage at component initialization
'filter' => function () {
return [
'userId' => Yii::$app->user->id // vary storage records by user
];
},
],
'items' => [
'sidebarEnabled' => [
'value' => true, // default value
'rules' => [
['boolean']
],
],
'backgroundColor' => [
'value' => '#101010', // default value
'rules' => [
['required']
],
],
// ...
],
],
...
],
];
Then you can retrieve any user setting via created component:
```php
if (Yii::$app->userInterfaceConfig->getItemValue('sidebarEnabled')) {
// render sidebar
}
echo Yii::$app->userInterfaceConfig->getItemValue('backgroundColor');
```
Note that you should enable [[\yii2tech\config\Manager::$autoRestoreValues]] to make configuration values to be
restored from persistent storage automatically, otherwise you'll have to invoke [[\yii2tech\config\Manager::restoreValues()]]
method manually. Also do not forget to specify default value for each configuration item, otherwise it will be picked up
from current application.
You may also use [[\yii2tech\config\Manager]] to configure particular component. For example:
```php
use yii\base\Component;
use yii2tech\config\Manager;
class SomeComponent extends Component
{
// fields to be configured:
public $isEnabled = true;
public $color = '#101010';
// config manager ;
private $_configManager;
public function getConfigManager()
{
if ($this->_configManager === null) {
$this->_configManager = new Manager([
'source' => $this,
'storage' => [
'class' => 'yii2tech\config\StorageDb',
'table' => 'SomeComponentConfig',
],
'items' => [
'isEnabled' => [
'path' => 'isEnabled',
'rules' => [
['boolean']
],
],
'color' => [
'path' => 'color',
'rules' => [
['required']
],
],
// ...
],
]);
}
return $this->_configManager;
}
public function init()
{
parent::init();
$this->getConfigManager()->configure($this); // populate component with config from DB
}
// ...
}
```
In above example fields `isEnabled` and `color` will always be configured from persistent storage.