Skip to content
Yii2 Statistics Module
PHP CSS
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Update assets Feb 18, 2019
behaviors Collect profiling data Mar 4, 2020
commands Fixed updating GeoIP database from MaxMind.com Mar 25, 2020
controllers Translations... Mar 4, 2020
database Add update MaxMind GeoIP2 DB from console Feb 17, 2019
messages/ru-RU/app/modules Added pagination Mar 26, 2020
migrations Added type and status code of response Mar 24, 2019
models Added serial data validator Mar 4, 2020
views Columns reorder Mar 31, 2020
.gitignore Update .gitignore Feb 18, 2019
CHANGELOG.md Added pagination Mar 26, 2020
LICENSE Updating year in copyrights Mar 6, 2020
Module.php Added DSN to loads stats, view select period fixed Mar 30, 2020
README.md Added pagination Mar 26, 2020
StatsAsset.php Rename assets bundle Jun 8, 2019
composer.json Up to date dependencies Mar 25, 2020

README.md

Yii2 Github all releases Progress GitHub license GitHub release

Yii2 Statistics Module

Statistics module for Yii2

Requirements

Installation

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

$ composer require "wdmg/yii2-stats:dev-master"

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 GeoIP2 DB

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,
        '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' => '...',
        '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

Name Type Default Description
collectStats boolean true Collect statistics with this module?
routePrefix string 'admin' Route prefix to the module control panel.
storagePeriod integer 0 Days, how many to store statistics. 0 - infinity.
useChart boolean true Use charts when displaying statistics.
ignoreDev boolean true Ignore activity in development mode.
ignoreAjax boolean true Ignoring activity for Ajax requests.
ignoreRoute array ['/admin'] Ignoring the activity at the specified routing.
ignoreListIp array ['127.0.0.1'] Ignoring activity from specified IP addresses.
ignoreListUA array [...] Ignoring of activity at specified UserAgents.
cookieName string 'yii2_stats' The name of the cookie to store the visit ID.
cookieExpire integer 3110400 Cookie lifetime.
maxmindLicenseKey mixed false MaxMind LicenseKey for GeoLite2 databases.
advertisingSystems array [...] List to detect the transition from advertising sites.
socialNetworks array [...] List for detecting transition from social networks.
searchEngines array [...] List for detecting the transition from search engines.
clientPlatforms array [...] List for detecting the client's OS.
clientBrowsers array [...] Client's Browser detection list.

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.1 - Added pagination, fixed updating GeoIP database from MaxMind.com
  • v.1.2.0 - Collect profiling data
  • v.1.1.10 - Fixed deprecated class declaration
  • v.1.1.9 - Loading module options from params, optimize GeoIP database update

Copyright and License

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

You can’t perform that action at this time.