/yii2-votes

User voting module for Yii2

Primary LanguagePHPMIT LicenseMIT

Progress Github all releases GitHub version Progress GitHub license

Yii2 User votes

System of accounting user votes

Requirements

  • PHP 5.6 or higher
  • Yii2 v.2.0.20 and newest
  • Yii2 Base module (required)
  • Yii2 Users module (optionaly)

Installation

To install the module, run the following command in the console:

$ composer require "wdmg/yii2-votes"

After configure db connection, run the following command in the console:

$ php yii votes/init

And select the operation you want to perform:

  1. Apply all module migrations
  2. Revert all module migrations

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-votes/migrations

Configure

To add a module to the project, add the following data in your configuration file:

'modules' => [
    ...
    'votes' => [
        'class' => 'wdmg\votes\Module',
        'routePrefix' => 'admin'
    ],
    ...
],

Routing

Use the Module::dashboardNavItems() method of the module to generate a navigation items list for NavBar, like this:

<?php
    echo Nav::widget([
    'votes' => ['class' => 'navbar-nav navbar-right'],
        'label' => 'Modules',
        'items' => [
            Yii::$app->getModule('votes')->dashboardNavItems(),
            ...
        ]
    ]);
?>

Status and version [in progress development]

  • v.0.0.7 - Added extra options to composer.json and navbar menu icon
  • v.0.0.7 - Added choice param for non interactive mode
  • v.0.0.6 - Module refactoring