Skip to content
Module storage application settings for Yii2
PHP
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
commands
components
controllers
messages/ru-RU/app/modules
migrations
models
views
.gitignore
CHANGELOG.md
LICENSE
Module.php
README.md
composer.json

README.md

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.6 - Up to date dependencies
  • v.1.5.5 - Fixed deprecated class declaration
  • v.1.5.4 - Added delete and deleteAll for options component
  • v.1.5.3 - Added edit interface for array/object options
You can’t perform that action at this time.