README

Yii2 Private messages Module

System for sending users private messages for Yii2

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-messages"

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

$ php yii messages/init

And select the operation you want to perform:

Apply all module migrations
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-messages/migrations

Configure

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

'modules' => [
    ...
    'messages' => [
        'class' => 'wdmg\messages\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([
    'options' => ['class' => 'navbar-nav navbar-right'],
        'label' => 'Modules',
        'items' => [
            Yii::$app->getModule('messages')->dashboardNavItems(),
            ...
        ]
    ]);
?>

Status and version [in progress development]

v.1.0.0 - Update copyrights, fix nav menu
v.0.0.10 - Update README.md and dependencies
v.0.0.9 - Update dependencies, fixed migrations
v.0.0.8 - 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 - yii2-users module set to optionaly

wdmg / yii2-messages

Maintainers

Details