README

Yii2 Activity Module

User activity tracking system for Yii2. You can use the extension component to register any activity.

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 Users module (required)

Installation

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

$ composer require "wdmg/yii2-activity"

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

$ php yii activity/init

And select the operation you want to perform:

Apply all module migrations
Revert all module migrations
Clear users activity log

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

Configure

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

'modules' => [
    ...
    'activity' => [
        'class' => 'wdmg\activity\Module',
        'routePrefix' => 'admin',
        'surfingActivity': false, // Log of web-surfing activity
        'backendSurfing': true, // Log of web-surfing activity by backend.
        'frontendSurfing': false, // Log of web-surfing activity by frontend.
        'ignoringRoutes': [], // Ignoring activity by request route
        'ignoringUsers': [], // Ignoring activity by user ID
        'ignoringIp': [] // Ignoring activity by user IP
    ],
    ...
],

Usecase

Use the setActivity($message = null, $action = null, $type = null, $level = 1) method to log events and user actions, you can use the construction

<?php

    if($model->login()) {
        $activity = new Activity;
        $activity->setActivity('User has successfully login.', 'login', 'info', 2);
        ...
    }
    
    // or from component
    
    if($model->login()) {
        Yii::$app->activity->set('User has successfully login.', 'login', 'info', 2);
        ...
    }
    
?>

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('activity')->dashboardNavItems(),
            ...
        ]
    ]);
?>

Status and version [ready to use]

v.1.2.2 - Update README.md and dependencies
v.1.2.1 - Add filter/sort order, save autoupdate to user options
v.1.2.0 - Update copyrights
v.1.1.13 - Live auto-update for list
v.1.1.12 - Update README.md, added clear users activity log from console
v.1.1.11 - Update README.md and dependencies
v.1.1.10 - Added properties, refactoring setActivity() method
v.1.1.9 - Added pagination, up to date dependencies
v.1.1.8 - Fixed deprecated class declaration
v.1.1.7 - Added extra options to composer.json and navbar menu icon
v.1.1.6 - Added choice param for non interactive mode

wdmg / yii2-activity

Maintainers

Details