nystudio107 / craft-retour

src/controllers/ChartsController.php

<?php
/**
 * Retour plugin for Craft CMS
 *
 * Retour allows you to intelligently redirect legacy URLs, so that you don't
 * lose SEO value when rebuilding & restructuring a website
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\retour\controllers;

use Craft;
use craft\db\Query;
use craft\helpers\ArrayHelper;
use craft\web\Controller;
use nystudio107\retour\helpers\Permission as PermissionHelper;
use yii\web\ForbiddenHttpException;
use yii\web\Response;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Retour

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     3.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ChartsController extends Controller
{
    // Constants
    // =========================================================================

    // Protected Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    protected array|bool|int $allowAnonymous = [
    ];

    // Public Methods
    // =========================================================================

    /**
     * The Dashboard chart
     *
     * @param string $range

Missing parameter comment

     * @param int $siteId

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionDashboard(string $range = 'day', int $siteId = 0): Response
    {
        PermissionHelper::controllerPermissionCheck('retour:dashboard');
        $data = [];
        $days = 1;
        switch ($range) {
            case 'day':

Line indented incorrectly; expected 8 spaces, found 12

                $days = 1;
                break;
            case 'week':

Line indented incorrectly; expected 8 spaces, found 12

                $days = 7;
                break;
            case 'month':

Line indented incorrectly; expected 8 spaces, found 12

                $days = 30;
                break;
        }
        // Different dbs do it different ways
        $stats = null;
        $db = Craft::$app->getDb();
        if ($db->getIsMysql()) {
            // Query the db
            $query = (new Query())
                ->from('{{%retour_stats}}')
                ->select([

The opening parenthesis of a multi-line function call should be the last content on the line.

                    "DATE_FORMAT(hitLastTime, '%Y-%m-%d') AS date_formatted",
                    'COUNT(redirectSrcUrl) AS cnt',
                    'COUNT(handledByRetour = 1 or null) as handled_cnt',
                ])

For multi-line function calls, the closing parenthesis should be on a new line.

                ->where("hitLastTime >= ( CURDATE() - INTERVAL '{$days}' DAY )");
            if ((int)$siteId !== 0) {
                $query->andWhere(['siteId' => $siteId]);
            }
            $query
                ->orderBy('date_formatted ASC')
                ->groupBy('date_formatted');
            $stats = $query->all();
        }
        if ($db->getIsPgsql()) {
            // Query the db
            $query = (new Query())
                ->from('{{%retour_stats}}')
                ->select([

The opening parenthesis of a multi-line function call should be the last content on the line.

                    "to_char(\"hitLastTime\", 'yyyy-mm-dd') AS date_formatted",
                    "COUNT(\"redirectSrcUrl\") AS cnt",
                    "COUNT(CASE WHEN \"handledByRetour\" = true THEN 1 END) as handled_cnt",
                ])

For multi-line function calls, the closing parenthesis should be on a new line.

                ->where("\"hitLastTime\" >= ( CURRENT_TIMESTAMP - INTERVAL '{$days} days' )");
            if ((int)$siteId !== 0) {
                $query->andWhere(['siteId' => $siteId]);
            }
            $query
                ->orderBy('date_formatted ASC')
                ->groupBy('date_formatted');
            $stats = $query->all();
        }
        if ($stats) {
            $data[] = [
                'name' => '404 hits',
                'data' => array_merge(['0'], ArrayHelper::getColumn($stats, 'cnt')),
                'labels' => array_merge(['-'], ArrayHelper::getColumn($stats, 'date_formatted')),
            ];
            $data[] = [
                'name' => 'Handled 404 hits',
                'data' => array_merge(['0'], ArrayHelper::getColumn($stats, 'handled_cnt')),
                'labels' => array_merge(['-'], ArrayHelper::getColumn($stats, 'date_formatted')),
            ];
        }

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

    /**
     * The Dashboard chart
     *
     * @param int $days

Missing parameter comment

     *
     * @return Response
     */
    public function actionWidget(int $days = 1): Response
    {
        $data = [];
        // Different dbs do it different ways
        $stats = null;
        $handledStats = null;
        $db = Craft::$app->getDb();
        if ($db->getIsMysql()) {
            // Query the db
            $stats = (new Query())
                ->from('{{%retour_stats}}')
                ->where("hitLastTime >= ( CURDATE() - INTERVAL '{$days}' DAY )")
                ->count();
            $handledStats = (new Query())
                ->from('{{%retour_stats}}')
                ->where("hitLastTime >= ( CURDATE() - INTERVAL '{$days}' DAY )")
                ->andWhere('handledByRetour is TRUE')
                ->count();
        }
        if ($db->getIsPgsql()) {
            // Query the db
            $stats = (new Query())
                ->from('{{%retour_stats}}')
                ->where("\"hitLastTime\" >= ( CURRENT_TIMESTAMP - INTERVAL '{$days} days' )")
                ->count();
            $handledStats = (new Query())
                ->from('{{%retour_stats}}')
                ->where("\"hitLastTime\" >= ( CURRENT_TIMESTAMP - INTERVAL '{$days} days' )")
                ->andWhere('"handledByRetour" = TRUE')
                ->count();
        }
        if ($stats) {
            $data = [
                (int)$stats,
                (int)$handledStats,
            ];
        }

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

    // Protected Methods
    // =========================================================================
}