README

Yii2 Services Module

System Service 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 Activity module (support/optionaly)
Yii2 Stats module (support/optionaly)
Yii2 Users module (support/optionaly)
Yii2 Mailer module (support/optionaly)
Yii2 API module (support/optionaly)
Yii2 Search module (support/optionaly)
Yii2 RSS module (support/optionaly)
Yii2 Yandex.Turbo module (support/optionaly)
Yii2 Google AMP module (support/optionaly)
Yii2 Sitemap module (support/optionaly)

Installation

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

$ composer require "wdmg/yii2-services"

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

$ php yii services/init

And select the operation you want to perform:

Restore directory rights
Clear runtime cache
Clear web cache
Clear the all system cache

Configure

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

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

Status and version [ready to use]

v.2.0.0 - Update copyrights, fix nav menu
v.1.1.12 - Update dependencies, README.md
v.1.1.11 - Update README.md and dependencies

wdmg / yii2-services

Maintainers

Details