Storage application options (settings) in the database for Yii2
- PHP 5.6 or higher
- Yii2 v.2.0.20 and newest
- Yii2 Base module (required)
- Yii2 SelectInput widget
To install the module, run the following command in the console:
$ composer require "wdmg/yii2-options"
After configure db connection, run the following command in the console:
$ php yii options/init
And select the operation you want to perform:
- Apply all module migrations
- Revert all module migrations
- Scan and add all application options
In any case, you can execute the migration and create the initial data, run the following command in the console:
$ php yii migrate --migrationPath=@vendor/wdmg/yii2-options/migrations
To add a module to the project, add the following data in your configuration file:
'modules' => [
...
'options' => [
'class' => 'wdmg\options\Module',
'autoloadOptions' => true,
'routePrefix' => 'admin'
],
...
],
<?php
// Get app options (default)
$options = Yii::$app->params;
$email = $options['adminEmail'];
// Get app options (from DB)
$options = Yii::$app->options;
$email = $options->get('adminEmail');
$tokenExpire = $options->get('user.passwordResetTokenExpire');
// or
$email = $options->adminEmail;
$tokenExpire = $options->user->passwordResetTokenExpire;
// Set app options
$options = Yii::$app->options;
$options->set('adminEmail', "admin@example.com");
$options->set('user.passwordResetTokenExpire', 3600);
// or
$options->adminEmail = "admin@example.com";
//$options->user->passwordResetTokenExpire = 3600; //@TODO Emplement later
?>
Use the Module::dashboardNavItems() method of the module to generate a navigation items list for NavBar, like this:
<?php
echo Nav::widget([
'options' => ['class' => 'navbar-nav navbar-right'],
'label' => 'Modules',
'items' => [
Yii::$app->getModule('options')->dashboardNavItems(),
...
]
]);
?>
- v.1.4.0 - Bugfix settype for options
- v.1.3.13 - Changes to scan and add modules options from console
- v.1.3.12 - Added extra options to composer.json and navbar menu icon