README

Yii2 User views counting

System of accounting user views.

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-2023 W.D.M.Group, Ukraine

Requirements

• PHP 5.6 or higher
• Yii2 v.2.0.35 and newest
• Yii2 Base module (required)
• Yii2 Users module (optionaly)

Installation

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

$ composer require "wdmg/yii2-views"

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

$ php yii views/init

And select the operation you want to perform:

1. Apply all module migrations
2. 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-views/migrations

Configure

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

'modules' => [
    ...
    'views' => [
        'class' => 'wdmg\views\Module',
        'routePrefix' => 'admin',
        'cacheExpire' => 3600 // hits cache lifetime, `0` - for not use cache
    ],
    ...
],

Usage examples

To accountштп the number of views of an object, use the component method Yii::$app->views-set() module, into which you need to transfer the context and identifier. The same parameters are a condition for unique selection/filtering when receiving a view counter in the method Yii::$app->views-get() of component.

Store and get the views count

<?php
    if ($views = Yii::$app->views) {
        $count = $views->set(
            'page-views', // context (string, human-readable description of the section)
            'site/index', // target of object (string|null, by default is resolved route)
            true // flag, true - for return actualy count of views,
            true // flag, true - for register only unique views
        );
        echo $count;
    }
?>

Only get the count of views

<?php
    if ($views = Yii::$app->views) {
        $count = $views->get(
            'page-views', // context (string, human-readable description of the section)
            'site/index', // target of object (string|null, by default is resolved route)
        );
        echo $count;
    }
?>

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

Status and version [ready to use]

• v.1.1.0 - Update copyrights, fix menu dashboard
• v.1.0.1 - Update dependencies, README.md
• v.1.0.0 - Added component for set/get views counter