https://github.com/lav45/yii2-project-configuration
This extension helps you to easily store and retrieve settings for your project.
https://github.com/lav45/yii2-project-configuration
config configuration extension project yii2
Last synced: 3 months ago
JSON representation
This extension helps you to easily store and retrieve settings for your project.
- Host: GitHub
- URL: https://github.com/lav45/yii2-project-configuration
- Owner: lav45
- License: bsd-2-clause
- Created: 2017-08-23T13:28:59.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-06-21T06:58:05.000Z (about 1 year ago)
- Last Synced: 2025-10-29T17:04:00.055Z (8 months ago)
- Topics: config, configuration, extension, project, yii2
- Language: PHP
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
yii2-project-configuration
==========================
[](https://packagist.org/packages/lav45/yii2-project-configuration)
[](https://packagist.org/packages/lav45/yii2-project-configuration)
[](https://packagist.org/packages/lav45/yii2-project-configuration)
This extension helps you to easily store and retrieve settings for your project.
## Installation
The preferred way to install this extension through [composer](http://getcomposer.org/download/).
You can set the console
```
~$ composer require "lav45/yii2-project-configuration" --prefer-dist
```
or add
```
"require": {
"lav45/yii2-project-configuration": "1.0.*"
}
```
in ```require``` section in `composer.json` file.
## Using
```php
// Yii::setAlias('@app_config_path', __DIR__ . '/settings');
$db_name = config('db_name', 'site-db-name');
$db_host = config('db_host', 'localhost');
return [
'components' => [
'db' => [
'class' => 'yii\db\Connection',
'dsn' => "mysql:host={$db_host};dbname={$db_name}",
'username' => config('db_username', 'root'),
'password' => config('db_password', '****'),
'enableSchemaCache' => true,
'charset' => 'utf8',
],
]
];
```
## Management
Control is made through a console controller
Will add it to the console application's configuration file
```php
return [
'controllerMap' => [
'config' => 'lav45\projectConfiguration\console\controllers\ConfigController'
]
];
```
### Use console controller
```
# Set value by key
~$ yii config db_name site-db
# Display all keys
~$ yii config
~> db_name: site-db
# Show value by key
~$ yii config db_name
~> site-db
# Delete key
~$ yii config/delete db_name
```
You can configure the component using [Yii::setAlias()](https://github.com/yiisoft/yii2/blob/2.0.12/docs/guide/concept-aliases.md#defining-aliases-) before using the `config()`
| Key | Default value | Description |
|:-----------------|:------------------------------|:-----------------------------------------------------|
| @app_config_key | 'app-config' | The key which will be stored settings |
| @app_config_path | '/storage' | Path where will be stored the file with the settings |
## License
**yii2-project-configuration** it is available under a BSD 3-Clause License. Detailed information can be found in the `LICENSE.md`.