daprime-com/yii-configbuilder

Configuration builder extension for applications based on Yii2

0.2.0 2021-02-10 08:21 UTC

Requires

• yiisoft/yii2: *

BSD-3-Clause

• Dmitri Klimenko
• Igor Murujev

• yii2
• daprime

README

Config builder class proposes a special configuration files structure to make it easier to configure Your Yii2 application for different environments.

Installation

Install extension with composer.

• add repository to list of repositories (composer.json)

 "repositories": [
	    {
    		"type": "vcs",
    		"url": "https://github.com/daprime-com/yii-configbuilder"
	    }
]

• add configbuilder to require section

"daprime-com/yii-configbuilder": "0.*"

Usage

Prepare config folder files structure to look like this:

- base
--- common
--- web
--- console
- prod
--- common
--- web
--- console
... any other environments

The workflow of ConfigBuilder is following:

• takes common file from base directory
• takes (web|console) file from base directory (depends on web or cli execution)
• takes YII_ENV constant value to know what environment is used
• takes common file from (prod|dev|test) directory
• takes (web|console) file from env directory

Initialization

To initialize ConfigBuilder change your application entry points like that:

// Before
$config = require(__DIR__ . '/../config/web.php');
(new yii\web\Application($config))->run();

// After
Yii::setAlias('@root', $rootPath); //root alias is required for builder to work

$configBuilder = new \yii\configbuilder\ConfigBuilder();
(new yii\web\Application($configBuilder->getWebConfig()))->run();