dukt\analytics\controllers\ReportsController

Complexity

Total Complexity

15

Size/Duplication

Total Lines	171
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	actionElement()	0	11	1
B	actionRealtimeWidget()	0	52	4
C	actionReportWidget()	0	45	8
B	getRealtimeDemoResponse()	0	25	2

<?php
/**
 * @link      https://dukt.net/craft/analytics/
 * @copyright Copyright (c) 2018, Dukt
 * @license   https://dukt.net/craft/analytics/docs/license
 */

namespace dukt\analytics\controllers;

use Craft;
use craft\web\Controller;
use dukt\analytics\errors\InvalidChartTypeException;
use dukt\analytics\Plugin as Analytics;
use yii\web\Response;

class ReportsController extends Controller
{
    // Public Methods
    // =========================================================================

    /**
     * Get element report.
     *
     * @return Response
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionElement()
    {
        $elementId = Craft::$app->getRequest()->getRequiredParam('elementId');
        $siteId = (int) Craft::$app->getRequest()->getRequiredParam('siteId');
        $metric = Craft::$app->getRequest()->getRequiredParam('metric');

        $response = Analytics::$plugin->getReports()->getElementReport($elementId, $siteId, $metric);

        return $this->asJson([
            'type' => 'area',
            'chart' => $response
        ]);
    }

    /**
     * Get realtime widget report.
     *
     * @return Response
     */
    public function actionRealtimeWidget()
    {
        if(Analytics::$plugin->getSettings()->demoMode) {
            return $this->getRealtimeDemoResponse();
        }


        // Active users
        
        $activeUsers = 0;

        $viewId = Craft::$app->getRequest()->getBodyParam('viewId');

        $request = [
            'viewId' => $viewId,
            'metrics' => 'ga:activeVisitors',
            'optParams' => []
        ];

        $response = Analytics::$plugin->getReports()->getRealtimeReport($request);

        if (!empty($response['totalsForAllResults']) && isset($response['totalsForAllResults']['ga:activeVisitors'])) {
            $activeUsers = $response['totalsForAllResults']['ga:activeVisitors'];
        }



        // Pageviews

        $pageviewsRequest = [
            'viewId' => $viewId,
            'metrics' => 'rt:pageviews',
            'optParams' => ['dimensions' => 'rt:minutesAgo']
        ];

        $pageviews = Analytics::$plugin->getReports()->getRealtimeReport($pageviewsRequest);


        // Active pages

        $activePagesRequest = [
            'viewId' => $viewId,
            'metrics' => 'rt:activeUsers',
            'optParams' => ['dimensions' => 'rt:pagePath', 'max-results' => 5]
        ];

        $activePages = Analytics::$plugin->getReports()->getRealtimeReport($activePagesRequest);

        return $this->asJson([
            'activeUsers' => $activeUsers,
            'pageviews' => $pageviews,
            'activePages' => $activePages,
        ]);
    }

    /**
     * Get report widget report.
     *
     * @return Response
     * @throws InvalidChartTypeException
     */
    public function actionReportWidget()
    {
        $viewId = Craft::$app->getRequest()->getBodyParam('viewId');
        $chart = Craft::$app->getRequest()->getBodyParam('chart');
        $period = Craft::$app->getRequest()->getBodyParam('period');
        $options = Craft::$app->getRequest()->getBodyParam('options');

        $request = [
            'viewId' => $viewId,
            'chart' => $chart,
            'period' => $period,
            'options' => $options,
        ];

        $cacheId = ['getReport', $request];

        $response = Analytics::$plugin->cache->get($cacheId);

        if (!$response) {
            switch ($chart) {
                case 'area':
                    $response = Analytics::$plugin->getReports()->getAreaReport($request);
                    break;
                case 'counter':
                    $response = Analytics::$plugin->getReports()->getCounterReport($request);
                    break;
                case 'pie':
                    $response = Analytics::$plugin->getReports()->getPieReport($request);
                    break;
                case 'table':
                    $response = Analytics::$plugin->getReports()->getTableReport($request);
                    break;
                case 'geo':
                    $response = Analytics::$plugin->getReports()->getGeoReport($request);
                    break;
                default:
                    throw new InvalidChartTypeException("Chart type `".$chart."` not supported.");
            }

            if ($response) {

The expression $response of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                Analytics::$plugin->cache->set($cacheId, $response);
            }
        }

        return $this->asJson($response);
    }

    // Private Methods
    // =========================================================================

    /**
     * Get realtime demo response.
     * 
     * @return Response
     */
    private function getRealtimeDemoResponse(): Response
    {
        $activeUsers = random_int(0, 20);
        $pageviews = [
            'rows' => []
        ];

        for($i = 0; $i <= 30; $i++) {
            $pageviews['rows'][] = [$i, random_int(0, 20)];
        }

        $activePages = [
            'rows' => [
                ['/some-url/', random_int(0, 20)],
                ['/some-super-long-url/with-kebab-case/', random_int(0, 20)],
                ['/somesuperlongurlwithoutkebabcasebutstillsuperlong/', random_int(10000000, 20000000)],
                ['/someothersuperlongurl/withoutkebabcasebutstillsuperlong/', random_int(0, 20)],
                ['/one-last-url/', random_int(0, 20)],
            ]
        ];

        return $this->asJson([
            'activeUsers' => $activeUsers,
            'pageviews' => $pageviews,
            'activePages' => $activePages,
        ]);
    }
}