nystudio107\webperf\controllers\ChartsController

Complexity

Total Complexity

22

Size/Duplication

Total Lines	204
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	actionDashboardStatsAverage()	0	53	9
B	actionDashboardSlowestPages()	0	63	9
A	actionWidget()	0	39	4

<?php
/**
 * Webperf plugin for Craft CMS 3.x
 *
 * Monitor the performance of your webpages through real-world user timing data
 *
 * @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\webperf\controllers;

use Craft;

The type Craft was not found. Maybe you did not declare it correctly or list all dependencies?

use nystudio107\webperf\helpers\Permission as PermissionHelper;

use craft\db\Query;

The type craft\db\Query was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\helpers\ArrayHelper;

The type craft\helpers\ArrayHelper was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\web\Controller;

The type craft\web\Controller was not found. Maybe you did not declare it correctly or list all dependencies?

use yii\web\ForbiddenHttpException;

The type yii\web\ForbiddenHttpException was not found. Maybe you did not declare it correctly or list all dependencies?

use yii\web\Response;

The type yii\web\Response was not found. Maybe you did not declare it correctly or list all dependencies?

/**

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 indented incorrectly; expected 2 spaces but found 4

 * @package   Webperf

Tag value indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value 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

     * @var    bool|array

Tag value indented incorrectly; expected 1 spaces but found 4

     */
    protected $allowAnonymous = [
    ];

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

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

Missing parameter comment

     * @param string $column

Missing parameter comment

     * @param int    $siteId

Missing parameter comment

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionDashboardStatsAverage(
        string $range = 'day',
        string $column = 'pageLoad',
        int $siteId = 0
    ): Response {
        PermissionHelper::controllerPermissionCheck('webperf: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('{{%webperf_data_samples}}')
                ->select([

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

                    'AVG('.$column.') AS avg',
                ])

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

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

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

                    'AVG("'.$column.'") AS avg',
                ])

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

                ->where("\"dateUpdated\" >= ( CURRENT_TIMESTAMP - INTERVAL '{$days} days' )");
            if ((int)$siteId !== 0) {
                $query->andWhere(['siteId' => $siteId]);
            }
            $stats = $query->all();
        }
        if ($stats) {
            $data = ArrayHelper::getColumn($stats, 'avg');
        }

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

    /**
     * The Dashboard stats slowest pages list
     *
     * @param string $range

Missing parameter comment

     * @param string $column

Missing parameter comment

     * @param int    $limit

Missing parameter comment

     * @param int    $siteId

Missing parameter comment

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionDashboardSlowestPages(
        string $range = 'day',
        string $column = 'pageLoad',
        int $limit = 3,
        int $siteId = 0
    ): Response {
        PermissionHelper::controllerPermissionCheck('webperf: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('{{%webperf_data_samples}}')
                ->select([

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

                    '*',
                    'AVG('.$column.') AS avg',
                ])

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

                ->where("dateUpdated >= ( CURDATE() - INTERVAL '{$days}' DAY )");
            if ((int)$siteId !== 0) {
                $query->andWhere(['siteId' => $siteId]);
            }
            $query
                ->orderBy('avg DESC')
                ->groupBy('url')
                ->limit($limit);
            $stats = $query->all();
        }
        if ($db->getIsPgsql()) {
            // Query the db
            $query = (new Query())
                ->from('{{%webperf_data_samples}}')
                ->select([

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

                    'AVG("'.$column.'") AS avg',
                ])

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

                ->where("\"dateUpdated\" >= ( CURRENT_TIMESTAMP - INTERVAL '{$days} days' )");
            if ((int)$siteId !== 0) {
                $query->andWhere(['siteId' => $siteId]);
            }
            $stats = $query->all();
        }
        if ($stats) {
            $data = ArrayHelper::getColumn($stats, 'avg');

The assignment to $data is dead and can be removed.

        }

        Craft::debug('Slowest Pages: '.print_r($stats, true), __METHOD__);

        $data = [];

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

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

Missing parameter comment

     *
     * @return Response
     */
    public function actionWidget($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
    // =========================================================================
}