wdmg/yii2-options

Storage application options (settings) in the database

Installs: 26

Dependents: 1

Suggesters: 0

Stars: 2

Watchers: 3

Forks: 2

Open Issues: 0

Type:yii2-extension

1.5.0 2019-09-07 14:28 UTC

README

Yii2 Github all releases Progress GitHub license GitHub release

Yii2 Options Module

Storage application options (settings) in the database for Yii2

Requirements

Installation

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:

  1. Apply all module migrations
  2. Revert all module migrations
  3. Scan and add all application options

Migrations

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

Configure

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'
    ],
    ...
],

Usage

<?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
    
?>

Routing

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(),
            ...
        ]
    ]);
?>

Status and version [ready to use]

  • v.1.5.0 - Bugfix autoload options
  • v.1.4.0 - Bugfix settype for options
  • v.1.3.13 - Changes to scan and add modules options from console