Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sergeymakinen/yii2-config
Versatile config loader for Yii 2
https://github.com/sergeymakinen/yii2-config
config config-management configuration ini json loader php php-library yaml yii2 yii2-extension
Last synced: about 4 hours ago
JSON representation
Versatile config loader for Yii 2
- Host: GitHub
- URL: https://github.com/sergeymakinen/yii2-config
- Owner: sergeymakinen
- License: mit
- Archived: true
- Created: 2016-12-09T20:46:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-09-15T20:20:52.000Z (about 4 years ago)
- Last Synced: 2023-07-15T22:06:27.618Z (about 1 year ago)
- Topics: config, config-management, configuration, ini, json, loader, php, php-library, yaml, yii2, yii2-extension
- Language: PHP
- Size: 76.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Yii 2 config loader
Versatile config loader for Yii 2. You can define a single config definition file in your favorite language which will define a configuration for all your application tiers (`console`, `backend`, `frontend`, etc).
[](https://scrutinizer-ci.com/g/sergeymakinen/yii2-config) [](https://travis-ci.org/sergeymakinen/yii2-config) [](https://codecov.io/gh/sergeymakinen/yii2-config) [](https://insight.sensiolabs.com/projects/bb50f2be-7108-4923-992e-b4ee636f0252)
[](https://packagist.org/packages/sergeymakinen/yii2-config) [](https://packagist.org/packages/sergeymakinen/yii2-config) [](LICENSE)
## Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Example config](#example-config)
- [Shortcuts](#shortcuts)
- [Supported config formats](#supported-config-formats)
* [INI](#ini)
* [JSON](#json)
* [PHP array](#php-array)
* [PHP bootstrap](#php-bootstrap)
* [YAML](#yaml)
- [Extending](#extending)
## Installation
The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
Either run
```bash
composer require "sergeymakinen/yii2-config:^2.0"
```
or add
```json
"sergeymakinen/yii2-config": "^2.0"
```
to the require section of your `composer.json` file.
## Usage
First you need to define your config: it may be a PHP array right in the file you plan to include it in but it's better to place it in a file which can be in any [supported format](#supported-config-formats). Just like it's done in the [example](#example-config).
Then your entry scripts have to be modified to load the config. It's how it can look like for a `console` tier [`yii` file](docs/examples/basic/yii) (consider a *tier* as a *type*) in a Yii 2 [basic project template](https://github.com/yiisoft/yii2-app-basic):
```php
#!/usr/bin/env php
'console']);
$application = new yii\console\Application($config);
$exitCode = $application->run();
exit($exitCode);
```
And for a `backend` tier [`backend/web/index.php` file](docs/examples/advanced/backend/web/index.php) in a Yii 2 [advanced application template](https://github.com/yiisoft/yii2-app-advanced):
```php
'backend']);
(new yii\web\Application($config))->run();
```
## Example config
Consider this [config](docs/examples/readme/config/config.php):
```php
__DIR__,
'cacheDir' => dirname(__DIR__) . '/runtime/config',
'enableCaching' => YII_ENV_PROD,
'dirs' => [
'',
'{env}',
],
'files' => [
[
'class' => 'sergeymakinen\yii\config\PhpBootstrapLoader',
'path' => 'bootstrap.php',
],
'common.php',
'{tier}.php',
'web:@components.urlManager.rules' => 'routes.php',
'@components.log.targets' => 'logs.php',
'@params' => 'params.php',
],
];
```
`Config` will look for the following config files in `CONFIG_DIR` and `CONFIG_DIR/ENV` directories:
- `bootstrap.php` and `bootstrap-local.php` for a PHP code
- `common.php` and `common-local.php`
- `TIER.php` and `TIER-local.php`
- `routes.php` and `routes-local.php` when the tier is `web` will be merged as:
```php
[
'components' => [
'urlManager' => [
'rules' => [
// routes.php and routes-local.php contents
]
]
]
]
```
- `logs.php` and `logs-local.php` will be merged as:
```php
[
'components' => [
'log' => [
'targets' => [
// logs.php and logs-local.php contents
]
]
]
]
```
- `params.php` and `params-local.php` when the tier is `web` will be merged as:
```php
[
'params' => [
// params.php and params-local.php contents
]
]
```
## Shortcuts
As you can see in the [example section](#example-config) there are different ways to specify a config file configuration. To be able to write less, some common options can be written in a single string instead of an array.
`'TIER:ENV@KEY' => 'PATH'` will be resolved as (you can omit any part you don't need):
```php
[
'tier' => 'TIER',
'env' => 'ENV',
'key' => 'KEY',
'path' => 'PATH',
]
```
Samples:
Shortcut
Result
'bar'
[
'path' => 'bar',
]
'foo' => 'bar'
[
'env' => 'foo',
'path' => 'bar',
]
'foo@baz' => 'bar'
[
'env' => 'foo',
'key' => 'baz',
'path' => 'bar',
]
'loren:foo@baz' => 'bar'
[
'tier' => 'loren',
'env' => 'foo',
'key' => 'baz',
'path' => 'bar',
]
## Supported config formats
### INI
**Extension**: `ini`
**Loader class**: `sergeymakinen\yii\config\IniLoader`
**Example**:
```ini
[config]
class = yii\db\Connection
dsn = "mysql:host=localhost;dbname=yii2basic"
username = root
password = ""
charset = utf8
```
### JSON
**Extension**: `json`
**Loader class**: `sergeymakinen\yii\config\JsonLoader`
**Example**:
```json
{
"class": "yii\\db\\Connection",
"dsn": "mysql:host=localhost;dbname=yii2basic",
"username": "root",
"password": "",
"charset": "utf8"
}
```
### PHP array
**Extension**: `php`
**Loader class**: `sergeymakinen\yii\config\PhpArrayLoader`
**Example**:
```php
'yii\db\Connection',
'dsn' => 'mysql:host=localhost;dbname=yii2basic',
'username' => 'root',
'password' => '',
'charset' => 'utf8',
];
```
### PHP bootstrap
**Extension**: `php`
**Loader class**: `sergeymakinen\yii\config\PhpBootstrapLoader`
**Attention**: you need to explicitly set the class name to use this loader:
```php
[
'class' => 'sergeymakinen\config\PhpBootstrapLoader',
'path' => 'mybootstrapfile.php',
// ...
]
```
**Example**:
```php
set(yii\grid\GridView::class, function ($container, $params, $config) {
if (Yii::$app->controller instanceof yii\debug\controllers\DefaultController) {
$defaults = [];
} else {
$defaults = [
'layout' => '
{items}',
'tableOptions' => ['class' => 'table table-striped'],
];
}
return new yii\grid\GridView(array_merge($defaults, $config));
});
```
### YAML
**Extension**: `yml`, `yaml`
**Loader class**: `sergeymakinen\yii\config\YamlLoader`
**Attention**: you need to install the Symfony YAML library:
Either run
```bash
composer require "symfony/yaml:^2.8 || ^3.2"
```
or add
```json
"symfony/yaml": "^2.8 || ^3.2"
```
to the require section of your `composer.json` file.
**Example**:
```yaml
class: 'yii\db\Connection'
dsn: 'mysql:host=localhost;dbname=yii2basic'
username: root
password: ''
charset: utf8
```
## Extending
For example let's try to write a simple XML loader:
```php
use yii\helpers\Json;
class XmlLoader extends sergeymakinen\yii\config\ArrayLoader
{
/**
* {@inheritdoc}
*/
public function loadFile($path)
{
$xml = simplexml_load_string(file_get_contents($path), 'SimpleXMLElement', LIBXML_NOCDATA);
return Json::decode(Json::encode($xml));
}
}
```
If you wish to use the loader automatically for XML files then add the following entry to the `loaders` property array of `Config`:
```php
'xml' => 'XmlLoader'
```