ChartsController::actionDashboardStatsAverage() - Code Metrics - Inspection of "Updated assets build" - nystudio107/craft-webperf - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v1 ( a04106...17dfe3 )

by Andrew

created 2019-01-26 22:08 UTC

ChartsController::actionDashboardStatsAverage() B

↳ Parent: ChartsController

Complexity

Conditions	8
Paths	30

Size

Total Lines	56
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	34
dl	0
loc	56
rs	8.1315
c	0
b	0
f	0
cc	8
nc	30
nop	5

How to fix Long Method

<?php
/**
 * Webperf plugin for Craft CMS 3.x
 *
 * Monitor the performance of your webpages through real-world user timing data
 *
 * @link      https://nystudio107.com

 * @copyright Copyright (c) 2019 nystudio107

 */


namespace nystudio107\webperf\controllers;

use nystudio107\webperf\helpers\Permission as PermissionHelper;

use Craft;
filter:
    dependency_paths: ["lib/*"]
use craft\db\Query;
filter:
    dependency_paths: ["lib/*"]
use craft\helpers\ArrayHelper;
filter:
    dependency_paths: ["lib/*"]
use craft\helpers\UrlHelper;
filter:
    dependency_paths: ["lib/*"]
use craft\web\Controller;
filter:
    dependency_paths: ["lib/*"]

use yii\web\ForbiddenHttpException;
filter:
    dependency_paths: ["lib/*"]
use yii\web\Response;
filter:
    dependency_paths: ["lib/*"]

/**

 * @author    nystudio107

 * @package   Webperf

 * @since     1.0.0

 */

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

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

    /**

     * @var    bool|array

     */
    protected $allowAnonymous = [];

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

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

     * @param string $end

     * @param string $column

     * @param string $pageUrl

     * @param int    $siteId

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionDashboardStatsAverage(
        string $start,
        string $end,
        string $column = 'pageLoad',
        $pageUrl = '',
        int $siteId = 0
    ): Response {
        PermissionHelper::controllerPermissionCheck('webperf:dashboard');
        $data = [];
        // Add a day since YYYY-MM-DD is really YYYY-MM-DD 00:00:00
        $end = date('Y-m-d', strtotime($end.'+1 day'));
        $pageUrl = urldecode($pageUrl);
        // 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([

                    'COUNT(url) AS cnt',
                    'AVG('.$column.') AS avg',
                ])
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
                ->where(['between', 'dateUpdated', $start, $end])
                ->andWhere(['not', [$column => null]]);
            if ((int)$siteId !== 0) {
                $query->andWhere(['siteId' => $siteId]);
            }
            if ($pageUrl !== '') {
                $query->andWhere(['url' => $pageUrl]);
            }
            $stats = $query->all();
        }
        if ($db->getIsPgsql()) {
            // Query the db
            $query = (new Query())
                ->from('{{%webperf_data_samples}}')
                ->select([

                    'AVG("'.$column.'") AS avg',
                ])
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
                ->where(['between', 'dateUpdated', $start, $end])
                ->andWhere(['not', [$column => null]]);
            if ((int)$siteId !== 0) {
                $query->andWhere(['siteId' => $siteId]);
            }
            $stats = $query->all();
        }
        // Massage the data
        if ($stats) {
            foreach ($stats as &$stat) {
                $stat['cnt'] = (int)$stat['cnt'];
            }
            $data = $stats[0];
        }

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

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

     * @param string $end

     * @param string $column

     * @param int    $limit

     * @param int    $siteId

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionDashboardSlowestPages(
        string $start,
        string $end,
        string $column = 'pageLoad',
        int $limit = 3,
        int $siteId = 0
    ): Response {
        PermissionHelper::controllerPermissionCheck('webperf:dashboard');
        $data = [];
        // Add a day since YYYY-MM-DD is really YYYY-MM-DD 00:00:00
        $end = date('Y-m-d', strtotime($end.'+1 day'));
        // 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([

                    'url',
                    'MIN(title) AS title',
                    'COUNT(url) AS cnt',
                    'AVG('.$column.') AS avg',
                ])
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
                ->where(['between', 'dateUpdated', $start, $end])
                ->andWhere(['not', [$column => null]]);
            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([

                    'url',
                    'MIN("title") AS title',
                    'COUNT(url) AS cnt',
                    'AVG("'.$column.'") AS avg',
                ])
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
                ->where(['between', 'dateUpdated', $start, $end])
                ->andWhere(['not', [$column => null]]);
            if ((int)$siteId !== 0) {
                $query->andWhere(['siteId' => $siteId]);
            }
            $query
                ->orderBy('avg DESC')
                ->groupBy('url')
                ->limit($limit);
            $stats = $query->all();
        }
        // Massage the data
        if ($stats) {
            foreach ($stats as &$stat) {
                $stat['cnt'] = (int)$stat['cnt'];
                $stat['detailPageUrl'] = UrlHelper::cpUrl('webperf/page-detail', [

                    'pageUrl' => $stat['url'],
                    'siteId' => $siteId,
                ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
                // Decode any emojis in the title
                if (!empty($stat['title'])) {
                    $stat['title'] = html_entity_decode($stat['title'], ENT_NOQUOTES, 'UTF-8');
                }
            }
            $data = $stats;
        }

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

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

     * @param string $end

     * @param string $pageUrl

     * @param int    $siteId

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionPagesAreaChart(
        string $start,
        string $end,
        $pageUrl = '',
        int $siteId = 0
    ): Response {
        PermissionHelper::controllerPermissionCheck('webperf:dashboard');
        $data = [];
        // Add a day since YYYY-MM-DD is really YYYY-MM-DD 00:00:00
        $end = date('Y-m-d', strtotime($end.'+1 day'));
        $pageUrl = urldecode($pageUrl);
        $dateStart = new \DateTime($start);
        $dateEnd = new \DateTime($end);
        $interval = date_diff($dateStart, $dateEnd);
        $dateFormat = '"%Y-%m-%d %l%p"';
        if ($interval->days > 30) {
            $dateFormat = '"%Y-%m-%d"';
        }
        // 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([

                    'AVG(pageLoad) AS pageLoad',
                    'AVG(domInteractive) AS domInteractive',
                    'AVG(firstContentfulPaint) AS firstContentfulPaint',
                    'AVG(firstPaint) AS firstPaint',
                    'AVG(firstByte) AS firstByte',
                    'AVG(connect) AS connect',
                    'AVG(dns) AS dns',
                    'AVG(craftTotalMs) AS craftTotalMs',
                    'AVG(craftTwigMs) AS craftTwigMs',
                    'AVG(craftDbMs) AS craftDbMs',
                    'DATE_FORMAT(dateUpdated, '.$dateFormat.') AS sampleDate',
                ])
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
                ->where(['between', 'dateUpdated', $start, $end])

                ;
            if ((int)$siteId !== 0) {
                $query->andWhere(['siteId' => $siteId]);
            }
            if ($pageUrl !== '') {
                $query->andWhere(['url' => $pageUrl]);
            }
            $stats = $query
                ->groupBy('sampleDate')
                ->all();
        }
        if ($db->getIsPgsql()) {
        }
        // Massage the data
        if ($stats) {
            $data[] = [
                'name' => 'Database Queries',
                'data' => ArrayHelper::getColumn($stats, 'craftDbMs'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
            $data[] = [
                'name' => 'Twig Rendering',
                'data' => ArrayHelper::getColumn($stats, 'craftTwigMs'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
            $data[] = [
                'name' => 'Craft Rendering',
                'data' => ArrayHelper::getColumn($stats, 'craftTotalMs'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
            $data[] = [
                'name' => 'DNS Lookup',
                'data' => ArrayHelper::getColumn($stats, 'dns'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
            $data[] = [
                'name' => 'Connect',
                'data' => ArrayHelper::getColumn($stats, 'connect'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
            $data[] = [
                'name' => 'First Byte',
                'data' => ArrayHelper::getColumn($stats, 'firstByte'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
            $data[] = [
                'name' => 'First Paint',
                'data' => ArrayHelper::getColumn($stats, 'firstPaint'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
            $data[] = [
                'name' => 'First Contentful Paint',
                'data' => ArrayHelper::getColumn($stats, 'firstContentfulPaint'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
            $data[] = [
                'name' => 'DOM Interactive',
                'data' => ArrayHelper::getColumn($stats, 'domInteractive'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
            $data[] = [
                'name' => 'Page Load',
                'data' => ArrayHelper::getColumn($stats, 'pageLoad'),
                'labels' => ArrayHelper::getColumn($stats, 'sampleDate'),
            ];
        }

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

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

     *
     * @return Response
     */
    public function actionWidget($days = 1): Response
    {
        $data = [];
        return $this->asJson($data);
    }

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


1			<?php
2			/**
3			* Webperf plugin for Craft CMS 3.x
4			*
5			* Monitor the performance of your webpages through real-world user timing data
6			*
7			* @link https://nystudio107.com
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
8			* @copyright Copyright (c) 2019 nystudio107
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
9			*/
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
10
11			namespace nystudio107\webperf\controllers;
12
13			use nystudio107\webperf\helpers\Permission as PermissionHelper;
14
15			use Craft;
			0 ignored issues – show Bug introduced 2019-01-20 08:15 UTC by Report Bug Copy Issue Report The type `Craft` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16			use craft\db\Query;
			0 ignored issues – show Bug introduced 2019-01-20 08:15 UTC by Report Bug Copy Issue Report The type `craft\db\Query` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
17			use craft\helpers\ArrayHelper;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `craft\helpers\ArrayHelper` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
18			use craft\helpers\UrlHelper;
			0 ignored issues – show Bug introduced 2019-01-20 08:15 UTC by Report Bug Copy Issue Report The type `craft\helpers\UrlHelper` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
19			use craft\web\Controller;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `craft\web\Controller` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
20
21			use yii\web\ForbiddenHttpException;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `yii\web\ForbiddenHttpException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
22			use yii\web\Response;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `yii\web\Response` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
23
24			/**
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
25			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 2 spaces but found 4 Loading history...
26			* @package Webperf
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 1 spaces but found 3 Loading history...
27			* @since 1.0.0

nystudio107 / craft-webperf

Push — v1 ( a04106...17dfe3 )

ChartsController::actionDashboardStatsAverage() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like