tracking/Classes/Dashboard/Widgets/PageViewsBar.php

<?php

namespace DanielSiepmann\Tracking\Dashboard\Widgets;

/*
 * Copyright (C) 2020 Daniel Siepmann <coding@daniel-siepmann.de>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

use DanielSiepmann\Tracking\Extension;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Dashboard\Widgets\AbstractBarChartWidget;

class PageViewsBar extends AbstractBarChartWidget
{
    protected $title = Extension::LANGUAGE_PATH . ':dashboard.widgets.pageViewsBar.title';

    protected $description = Extension::LANGUAGE_PATH . ':dashboard.widgets.pageViewsBar.description';

    protected $width = 2;

    protected $height = 4;

    /**
     * @var QueryBuilder
     */
    protected $queryBuilder;

    /**
     * @var \ArrayObject
     */
    private $settings;

    public function __construct(
        string $identifier,
        QueryBuilder $queryBuilder,
        \ArrayObject $settings
    ) {
        parent::__construct($identifier);

        $this->queryBuilder = $queryBuilder;
        $this->settings = $settings;
    }

    protected function prepareChartData(): void
    {
        list($labels, $data) = $this->calculateDataForLastDays((int) $this->settings['periodInDays']);

        $this->chartData = [
            'labels' => $labels,
            'datasets' => [
                [
                    'label' => $this->getLanguageService()->sL(
                        'LLL:EXT:tracking/Resources/Private/Language/locallang.xlf:widgets.pageViewsBar.chart.dataSet.0'
                    ),
                    'backgroundColor' => $this->chartColors[0],
                    'border' => 0,
                    'data' => $data
                ]
            ]
        ];
    }

    protected function getPageViewsInPeriod(int $start, int $end): int
    {
        $constraints = [
            $this->queryBuilder->expr()->gte('crdate', $start),
            $this->queryBuilder->expr()->lte('crdate', $end),
        ];

        if (count($this->settings['blackListedPages'])) {
            $constraints[] = $this->queryBuilder->expr()->notIn(
                'tx_tracking_pageview.pid',
                $this->queryBuilder->createNamedParameter(
                    $this->settings['blackListedPages'],
                    Connection::PARAM_INT_ARRAY
                )
            );
        }

        return (int)$this->queryBuilder
            ->count('*')
            ->from('tx_tracking_pageview')
            ->where(... $constraints)
            ->execute()
            ->fetchColumn();
    }

    protected function calculateDataForLastDays(int $days): array
    {
        $labels = [];
        $data = [];

        $format = $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] ?: 'Y-m-d';

        for ($daysBefore = $days; $daysBefore >= 0; $daysBefore--) {
            $timeForLabel = strtotime('-' . $daysBefore . ' day');
            $startPeriod = strtotime('-' . $daysBefore . ' day 0:00:00');
            $endPeriod =  strtotime('-' . $daysBefore . ' day 23:59:59');

            if ($timeForLabel === false || $startPeriod === false || $endPeriod === false) {
                continue;
            }

            $labels[] = date($format, $timeForLabel);
            $data[] = $this->getPageViewsInPeriod($startPeriod, $endPeriod);
        }

        return [
            $labels,
            $data,
        ];
    }
}