README

Yii2 Newsletters

Newsletters manager for Yii2.

This module is an integral part of the Butterfly.СMS content management system, but can also be used as an standalone extension.

Requirements

PHP 5.6 or higher
Yii2 v.2.0.40 and newest
Yii2 Base module (required)
Yii2 Mailer module (optionality)
Yii2 Options module (optionality)
Yii2 Editor module (required)
Yii2 TagsInput widget (required)
Yii2 SelectInput widget (required)
Yii2 Validators (required)

Installation

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

$ composer require "wdmg/yii2-newsletters"

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

$ php yii newsletters/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-newsletters/migrations

Configure

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

'modules' => [
    ...
    'newsletters' => [
        'class' => 'wdmg\newsletters\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('newsletters')->dashboardNavItems(),
            ...
        ]
    ]);
?>

Status and version [ready to use]

v.2.0.0 - Some fix, update copyrights
v.1.0.11 - Show modal call fixed and counter stats
v.1.0.10 - RBAC implementation
v.1.0.9 - Update dependencies, README.md

wdmg / yii2-newsletters

Maintainers

Details