dukt / analytics

src/services/Reports.php

<?php
/**
 * @link      https://dukt.net/analytics/
 * @copyright Copyright (c) 2022, Dukt
 * @license   https://github.com/dukt/analytics/blob/master/LICENSE.md
 */

namespace dukt\analytics\services;

use Craft;
use craft\helpers\StringHelper;
use dukt\analytics\errors\InvalidElementException;
use dukt\analytics\models\ReportRequestCriteria;
use yii\base\Component;
use dukt\analytics\Plugin as Analytics;

This use statement conflicts with another class in this namespace, dukt\analytics\services\Analytics. Consider defining an alias.

use \Google_Service_AnalyticsReporting_Report;

class Reports extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Returns a realtime report.
     *
     * @param array $request
     *
     * @return array
     * @throws \yii\base\InvalidConfigException
     */
    public function getRealtimeReport(array $request)
    {
        $view = Analytics::$plugin->getViews()->getViewById($request['viewId']);

        $tableId = null;

        if ($view) {

$view is of type dukt\analytics\models\View, thus it always evaluated to true.

            $tableId = 'ga:'.$view->gaViewId;
        }

        $metrics = $request['metrics'];
        $optParams = $request['optParams'];

        $cacheId = ['reports.getRealtimeReport', $tableId, $metrics, $optParams];
        $response = Analytics::$plugin->cache->get($cacheId);

        if (!$response) {
            $response = Analytics::$plugin->getApis()->getAnalytics()->getService()->data_realtime->get($tableId, $metrics, $optParams);

            $cacheDuration = Analytics::$plugin->getSettings()->realtimeRefreshInterval;
            Analytics::$plugin->cache->set($cacheId, $response, $cacheDuration);
        }

        return (array)$response;
    }

    /**
     * Get e-commerce report.
     *
     * @param $viewId
     * @param $period
     *
     * @return array
     */
    public function getEcommerceReport($viewId, $period)
    {
        $startDate = '7daysAgo';
        $endDate = 'today';
        $dimensions = 'ga:date';

        switch ($period) {
            case 'week':
                $startDate = '7daysAgo';
                break;
            case 'month':
                $startDate = '30daysAgo';
                break;
            case 'year':
                $startDate = '365daysAgo';
                $dimensions = 'ga:yearMonth';
                break;
        }

        $metrics = 'ga:transactionRevenue,ga:revenuePerTransaction,ga:transactions,ga:transactionsPerSession';

        $criteria = new ReportRequestCriteria;
        $criteria->viewId = $viewId;
        $criteria->startDate = $startDate;
        $criteria->endDate = $endDate;
        $criteria->metrics = $metrics;
        $criteria->dimensions = $dimensions;

It seems like $dimensions of type string is incompatible with the declared type array of property $dimensions.

        $criteria->includeEmptyRows = true;

        $reportResponse = Analytics::$plugin->getApis()->getAnalyticsReporting()->getReport($criteria);
        $report = $reportResponse->toSimpleObject();
        $reportData = $this->parseReportingReport($reportResponse);

        $view = Analytics::$plugin->getViews()->getViewById($viewId);

        return [
            'period' => $startDate.' - '.$endDate,
            'totalRevenue' => $report->data->totals[0]->values[0],
            'totalRevenuePerTransaction' => $report->data->totals[0]->values[1],
            'totalTransactions' => $report->data->totals[0]->values[2],
            'totalTransactionsPerSession' => $report->data->totals[0]->values[3],
            'reportData' => [
                'view' => $view->name,
                'chart' => $reportData,
                'period' => $period,
                'periodLabel' => Craft::t('analytics', 'This '.$period)
            ],
        ];
    }

    /**
     * Returns an element report.
     *
     * @param int      $elementId
     * @param int|null $siteId
     * @param string   $metric
     *
     * @return array
     * @throws \Exception
     */
    public function getElementReport($elementId, $siteId, $metric)
    {
        $uri = Analytics::$plugin->getAnalytics()->getElementUrlPath($elementId, $siteId);

        if (!$uri) {
            throw new InvalidElementException("Element doesn't support URLs.", 1);
        }

        if ($uri === '__home__') {
            $uri = '';
        }

        $siteView = Analytics::$plugin->getViews()->getSiteViewBySiteId($siteId);

        $viewId = null;

        if ($siteView) {

$siteView is of type dukt\analytics\models\SiteView, thus it always evaluated to true.

            $viewId = $siteView->viewId;
        }

        $startDate = date('Y-m-d', strtotime('-1 month'));
        $endDate = date('Y-m-d');
        $dimensions = 'ga:date';
        $metrics = $metric;
        $filters = 'ga:pagePath=='.$uri;

        $request = [
            'viewId' => $viewId,
            'startDate' => $startDate,
            'endDate' => $endDate,
            'metrics' => $metrics,
            'dimensions' => $dimensions,
            'filters' => $filters
        ];

        $cacheId = ['reports.getElementReport', $request];
        $response = Analytics::$plugin->cache->get($cacheId);

        if (!$response) {

            $criteria = new ReportRequestCriteria;
            $criteria->viewId = $viewId;
            $criteria->startDate = $startDate;
            $criteria->endDate = $endDate;
            $criteria->metrics = $metrics;
            $criteria->dimensions = $dimensions;

It seems like $dimensions of type string is incompatible with the declared type array of property $dimensions.

            $criteria->filtersExpression = $filters;

            $reportResponse = Analytics::$plugin->getApis()->getAnalyticsReporting()->getReport($criteria);
            $response = $this->parseReportingReport($reportResponse);

            if ($response) {

$response is a non-empty array, thus is always true.

The expression $response of type array<string,array|string[]> 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 $response;
    }

    /**
     * Returns an area report.
     *
     * @param array $request
     *
     * @return array
     * @throws \yii\base\InvalidConfigException
     */
    public function getAreaReport(array $request)
    {
        $viewId = ($request['viewId'] ?? null);
        $period = ($request['period'] ?? null);
        $metricString = ($request['options']['metric'] ?? null);

        switch ($period) {
            case 'year':
                $dimensionString = 'ga:yearMonth';
                $startDate = date('Y-m-01', strtotime('-1 '.$period));
                $endDate = date('Y-m-d');
                break;

            default:
                $dimensionString = 'ga:date';
                $startDate = date('Y-m-d', strtotime('-1 '.$period));
                $endDate = date('Y-m-d');
        }

        $criteria = new ReportRequestCriteria;
        $criteria->viewId = $viewId;
        $criteria->startDate = $startDate;
        $criteria->endDate = $endDate;
        $criteria->metrics = $metricString;
        $criteria->dimensions = $dimensionString;

It seems like $dimensionString of type string is incompatible with the declared type array of property $dimensions.

        $criteria->includeEmptyRows = true;

        $criteria->orderBys = [
            ['fieldName' => $dimensionString, 'orderType' => 'VALUE', 'sortOrder' => 'ASCENDING']
        ];

        $reportResponse = Analytics::$plugin->getApis()->getAnalyticsReporting()->getReport($criteria);
        $report = $this->parseReportingReport($reportResponse);

        $total = $report['totals'][0];

        $view = Analytics::$plugin->getViews()->getViewById($viewId);

        return [
            'view' => $view->name,
            'type' => 'area',
            'chart' => $report,
            'total' => $total,
            'metric' => Craft::t('analytics', Analytics::$plugin->metadata->getDimMet($metricString)),
            'period' => $period,
            'periodLabel' => Craft::t('analytics', 'This '.$period)
        ];
    }

    /**
     * Returns a counter report.
     *
     * @param array $request
     *
     * @return array
     * @throws \yii\base\InvalidConfigException
     */
    public function getCounterReport(array $request)
    {
        $viewId = ($request['viewId'] ?? null);
        $period = ($request['period'] ?? null);
        $metricString = ($request['options']['metric'] ?? null);
        $startDate = date('Y-m-d', strtotime('-1 '.$period));
        $endDate = date('Y-m-d');

        $criteria = new ReportRequestCriteria;
        $criteria->viewId = $viewId;
        $criteria->startDate = $startDate;
        $criteria->endDate = $endDate;
        $criteria->metrics = $metricString;


        $reportResponse = Analytics::$plugin->getApis()->getAnalyticsReporting()->getReport($criteria);
        $report = $this->parseReportingReport($reportResponse);

        $total = 0;

        if (!empty($report['totals'][0])) {
            $total = $report['totals'][0];
        }

        $counter = [
            'type' => $report['cols'][0]['type'],
            'value' => $total,
            'label' => StringHelper::toLowerCase(Craft::t('analytics', Analytics::$plugin->metadata->getDimMet($metricString)))
        ];

        $view = Analytics::$plugin->getViews()->getViewById($viewId);

        return [
            'view' => $view->name,
            'type' => 'counter',
            'counter' => $counter,
            'response' => $report,
            'metric' => Craft::t('analytics', Analytics::$plugin->metadata->getDimMet($metricString)),
            'period' => $period,
            'periodLabel' => Craft::t('analytics', 'this '.$period)
        ];
    }

    /**
     * Returns a pie report.
     *
     * @param array $request
     *
     * @return array
     * @throws \yii\base\InvalidConfigException
     */
    public function getPieReport(array $request)
    {
        $viewId = ($request['viewId'] ?? null);
        $period = ($request['period'] ?? null);
        $dimensionString = ($request['options']['dimension'] ?? null);
        $metricString = ($request['options']['metric'] ?? null);
        $startDate = date('Y-m-d', strtotime('-1 '.$period));
        $endDate = date('Y-m-d');

        $criteria = new ReportRequestCriteria;
        $criteria->viewId = $viewId;
        $criteria->startDate = $startDate;
        $criteria->endDate = $endDate;
        $criteria->metrics = $metricString;
        $criteria->dimensions = $dimensionString;

        $reportResponse = Analytics::$plugin->getApis()->getAnalyticsReporting()->getReport($criteria);
        $report = $this->parseReportingReport($reportResponse);

        $view = Analytics::$plugin->getViews()->getViewById($viewId);

        return [
            'view' => $view->name,
            'type' => 'pie',
            'chart' => $report,
            'dimension' => Craft::t('analytics', Analytics::$plugin->metadata->getDimMet($dimensionString)),
            'metric' => Craft::t('analytics', Analytics::$plugin->metadata->getDimMet($metricString)),
            'period' => $period,
            'periodLabel' => Craft::t('analytics', 'this '.$period)
        ];
    }

    /**
     * Returns a table report.
     *
     * @param array $request
     *
     * @return array
     * @throws \yii\base\InvalidConfigException
     */
    public function getTableReport(array $request)
    {
        $viewId = ($request['viewId'] ?? null);

        $period = ($request['period'] ?? null);
        $dimensionString = ($request['options']['dimension'] ?? null);
        $metricString = ($request['options']['metric'] ?? null);

        $criteria = new ReportRequestCriteria;
        $criteria->viewId = $viewId;
        $criteria->dimensions = $dimensionString;
        $criteria->metrics = $metricString;
        $criteria->startDate = date('Y-m-d', strtotime('-1 '.$period));
        $criteria->endDate = date('Y-m-d');

        $reportResponse = Analytics::$plugin->getApis()->getAnalyticsReporting()->getReport($criteria);
        $report = $this->parseReportingReport($reportResponse);

        $view = Analytics::$plugin->getViews()->getViewById($viewId);

        return [
            'view' => $view->name,
            'type' => 'table',
            'chart' => $report,
            'dimension' => Craft::t('analytics', Analytics::$plugin->metadata->getDimMet($dimensionString)),
            'metric' => Craft::t('analytics', Analytics::$plugin->metadata->getDimMet($metricString)),
            'period' => $period,
            'periodLabel' => Craft::t('analytics', 'This '.$period)
        ];
    }

    /**
     * Returns a geo report.
     *
     * @param array $request
     *
     * @return array
     * @throws \yii\base\InvalidConfigException
     */
    public function getGeoReport(array $request)
    {
        $viewId = ($request['viewId'] ?? null);
        $period = ($request['period'] ?? null);
        $dimensionString = ($request['options']['dimension'] ?? null);
        $metricString = ($request['options']['metric'] ?? null);

        $originDimension = $dimensionString;

        if ($dimensionString === 'ga:city') {
            $dimensionString = 'ga:latitude,ga:longitude,'.$dimensionString;
        }

        $criteria = new ReportRequestCriteria;
        $criteria->viewId = $viewId;
        $criteria->dimensions = $dimensionString;
        $criteria->metrics = $metricString;
        $criteria->startDate = date('Y-m-d', strtotime('-1 '.$period));
        $criteria->endDate = date('Y-m-d');

        $reportResponse = Analytics::$plugin->getApis()->getAnalyticsReporting()->getReport($criteria);
        $report = $this->parseReportingReport($reportResponse);

        $view = Analytics::$plugin->getViews()->getViewById($viewId);

        return [
            'view' => $view->name,
            'type' => 'geo',
            'chart' => $report,
            'dimensionRaw' => $originDimension,
            'dimension' => Craft::t('analytics', Analytics::$plugin->metadata->getDimMet($originDimension)),
            'metric' => Craft::t('analytics', Analytics::$plugin->metadata->getDimMet($metricString)),
            'period' => $period,
            'periodLabel' => Craft::t('analytics', 'This '.$period)
        ];
    }

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

    /**
     * @param Google_Service_AnalyticsReporting_Report $report
     * @return array
     */
    private function parseReportingReport(Google_Service_AnalyticsReporting_Report $report): array
    {
        $cols = $this->parseReportingReportCols($report);
        $rows = $this->parseReportingReportRows($report);
        $totals = $report->getData()->getTotals()[0]->getValues();

        return [
            'cols' => $cols,
            'rows' => $rows,
            'totals' => $totals
        ];
    }

    /**
     * @param Google_Service_AnalyticsReporting_Report $report
     * @return array
     */
    private function parseReportingReportCols(Google_Service_AnalyticsReporting_Report $report): array
    {
        $columnHeader = $report->getColumnHeader();
        $columnHeaderDimensions = $columnHeader->getDimensions();
        $metricHeaderEntries = $columnHeader->getMetricHeader()->getMetricHeaderEntries();

        $cols = [];

        if ($columnHeaderDimensions) {

The expression $columnHeaderDimensions of type string[] 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.

            foreach ($columnHeaderDimensions as $columnHeaderDimension) {

                $id = $columnHeaderDimension;
                $label = Analytics::$plugin->metadata->getDimMet($columnHeaderDimension);

                switch ($columnHeaderDimension) {
                    case 'ga:date':
                    case 'ga:yearMonth':
                        $type = 'date';
                        break;

                    case 'ga:continent':
                        $type = 'continent';
                        break;
                    case 'ga:subContinent':
                        $type = 'subContinent';
                        break;

                    case 'ga:latitude':
                    case 'ga:longitude':
                        $type = 'float';
                        break;

                    default:
                        $type = 'string';
                }

                $col = [
                    'type' => $type,
                    'label' => Craft::t('analytics', $label),
                    'id' => $id,
                ];

                array_push($cols, $col);
            }
        }

        foreach ($metricHeaderEntries as $metricHeaderEntry) {
            $label = Analytics::$plugin->metadata->getDimMet($metricHeaderEntry['name']);

            $col = [
                'type' => strtolower($metricHeaderEntry['type']),

It seems like $metricHeaderEntry['type'] can also be of type null; however, parameter $string of strtolower() does only seem to accept string, maybe add an additional type check?

                'label' => Craft::t('analytics', $label),
                'id' => $metricHeaderEntry['name'],
            ];

            array_push($cols, $col);
        }

        return $cols;
    }

    /**
     * @param Google_Service_AnalyticsReporting_Report $report
     * @return array
     */
    private function parseReportingReportRows(Google_Service_AnalyticsReporting_Report $report): array
    {
        $columnHeader = $report->getColumnHeader();
        $columnHeaderDimensions = $columnHeader->getDimensions();

        $rows = [];

        foreach ($report->getData()->getRows() as $_row) {

            $colIndex = 0;
            $row = [];

            $dimensions = $_row->getDimensions();

            if ($dimensions) {

The expression $dimensions of type string[] 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.

                foreach ($dimensions as $_dimension) {

                    $value = $_dimension;

                    if ($columnHeaderDimensions) {

The expression $columnHeaderDimensions of type string[] 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.

                        if (isset($columnHeaderDimensions[$colIndex])) {
                            switch ($columnHeaderDimensions[$colIndex]) {
                                case 'ga:continent':
                                    $value = Analytics::$plugin->geo->getContinentCode($value);
                                    break;
                                case 'ga:subContinent':
                                    $value = Analytics::$plugin->geo->getSubContinentCode($value);
                                    break;
                            }
                        }
                    }

                    array_push($row, $value);

                    $colIndex++;
                }
            }

            foreach ($_row->getMetrics() as $_metric) {
                array_push($row, $_metric->getValues()[0]);
                $colIndex++;
            }

            array_push($rows, $row);
        }

        return $rows;
    }
}