Yii2 Statistics Module

Statistics module for Yii2. The module takes into account site visitors with details on IP, web browser and user agent. In addition, the module allows you to keep statistics of the load on the web server and database.

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

Copyrights (c) 2019-2021 W.D.M.Group, Ukraine

Requirements

• PHP 5.6 or higher
• Yii2 v.2.0.40 and newest
• Yii2 Base module (required)
• Yii2 ChartJS widget
• Yii2 SelectInput widget
• GeoIP2 PHP API
• Yii2 Users module (optionaly)

Installation

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

$ composer require "wdmg/yii2-stats"

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

$ php yii stats/init

And select the operation you want to perform:

1. Apply all module migrations
2. Revert all module migrations
3. Update MaxMind GeoLite2 database

Migrations

In any case, you can execute the migration run the following command in the console:

$ php yii migrate --migrationPath=@vendor/wdmg/yii2-stats/migrations

Configure

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

'modules' => [
    ...
    'stats' => [
        'class' => 'wdmg\stats\Module',
        'collectStats' => true,
        'collectProfiling' => true,
        'detectLocation' => false,
        'routePrefix' => 'admin',
        'storagePeriod' => 0,
        'ignoreDev' => true,
        'ignoreAjax' => true,
        'useChart' => true,
        'ignoreRoute' => ['/admin', '/admin/'],
        'ignoreListIp' => ['::1', '127.0.0.1'],
        'ignoreListUA' => [],
        'cookieName' => 'yii2_stats',
        'cookieExpire' => 3110400,
        'maxmindLicenseKey' => false,
        'advertisingSystems' => ["gclid", "yclid", "fbclid", ...],
        'socialNetworks' => ["facebook", "instagram", "twitter", ...],
        'searchEngines' => ["google", "yandex", "yahoo", ...],
        'clientPlatforms' => [
            '/windows nt 10/i' => [
                'title' => 'Windows 10',
                'icon' => 'icon-win-10-os'
            ],
            ...
        ],
        'clientBrowsers' => [
            '/msie/i' => [
                'title' => 'Internet Explorer',
                'icon' => 'icon-ie-browser'
            ],
            ...
        ]
    ],
    ...
],

Options

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

Status and version [ready to use]

• v.1.2.5 - RBAC implementation
• v.1.2.4 - Update README.md
• v.1.2.3 - MaxMind License Key default property fixed and update MaxMind for Win platform fixed
• v.1.2.2 - Update README.md and dependencies versions
• v.1.2.1 - Added pagination, fixed updating GeoIP database from MaxMind.com
• v.1.2.0 - Collect profiling data

Copyright and License

This product also includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com