crisu83 / yii-configbuilder
Helper for building application configurations for the Yii PHP framework.
Installs: 626
Dependents: 1
Suggesters: 0
Security: 0
Stars: 12
Watchers: 3
Forks: 8
Type:yii-extension
This package is auto-updated.
Last update: 2024-10-29 03:36:48 UTC
README
Helper for building application configurations for the Yii PHP framework.
Basic configuration
Usage
To use the config builder you simply need to load it in your entry script:
<?php $yii = __DIR__ . '/path/to/yii.php'; $builder = __DIR__ . '/path/to/ConfigBuilder.php'; require_once($yii); require_once($builder); $config = ConfigBuilder::build(array( __DIR__ . '/protected/config/common.php', __DIR__ . '/protected/config/web.php', __DIR__ . '/protected/config/dev.php', __DIR__ . '/protected/config/local.php', )); Yii::createWebApplication($config)->run();
index.php
Environment specific configurations
If you need different environments in your application you can use the buildForEnv method together with the EnvCommand to easily set environment specific configurations.
Configuration
Add the env command to your console config file (usually protected/config/console.php):
// console application configuration return array( ..... 'commandMap' => array( 'env' => array( 'class' => 'path.alias.to.EnvCommand', // optional configurations 'runtimePath' => 'application.runtime', // the path to the application runtime folder 'envPaths' => array('application.config.environments'), // the paths to application environment configs ), ), );
console.php
Usage
Update your entry script (usually index.php) to use the buildForEnv method.
<?php $config = ConfigBuilder::buildForEnv(array( __DIR__ . '/protected/config/common.php', __DIR__ . '/protected/config/web.php', __DIR__ . '/protected/config/environments/{environment}.php', __DIR__ . '/protected/config/local.php', ), __DIR__ . '/protected/runtime/environment');
index.php
Now you can use the env command to set the active environment (replace {environment}
is the name of the environment):
yiic env {environment}
Note: You do not need to create the environment configuration files, the command will prompt you to create them if they do not exist.