nystudio107\webperf\controllers\RecommendationsController

Complexity

Total Complexity

18

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
D	actionRecommendations()	0	135	18

<?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) 2019 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 nystudio107\webperf\helpers\Permission as PermissionHelper;

use Craft;

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

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\UrlHelper;

The type craft\helpers\UrlHelper 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 RecommendationsController 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
    // =========================================================================

    /**
     * Handle requests for the dashboard statistics table
     *
     * @param string $sort

Missing parameter comment

Doc comment for parameter $sort does not match actual variable name $start

     * @param int    $page

Missing parameter comment

Doc comment for parameter $page does not match actual variable name $end

     * @param int    $per_page

Missing parameter comment

Doc comment for parameter $per_page does not match actual variable name $sort

     * @param string $filter

Missing parameter comment

Doc comment for parameter $filter does not match actual variable name $page

     * @param string $start

Missing parameter comment

Doc comment for parameter $start does not match actual variable name $per_page

     * @param string $end

Missing parameter comment

Doc comment for parameter $end does not match actual variable name $filter

     * @param int    $siteId

Missing parameter comment

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionRecommendations(
        string $start = '',
        string $end = '',
        string $sort = 'pageLoad|DESC',
        int $page = 1,
        int $per_page = 20,
        $filter = '',
        $siteId = 0
    ): Response {
        PermissionHelper::controllerPermissionCheck('webperf:pages');
        $data = [];
        $sortField = 'pageLoad';
        $sortType = 'DESC';
        // Add a day since YYYY-MM-DD is really YYYY-MM-DD 00:00:00
        $end = date('Y-m-d', strtotime($end.'+1 day'));
        // Figure out the sorting type
        if ($sort !== '') {
            if (strpos($sort, '|') === false) {
                $sortField = $sort;
            } else {
                list($sortField, $sortType) = explode('|', $sort);
            }
        }
        // Query the db table
        $offset = ($page - 1) * $per_page;
        $query = (new Query())
            ->select([

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

                'url',
                'MIN(title) AS title',
                'COUNT(url) AS cnt',
                '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(craftDbCnt) AS craftDbCnt',
                'AVG(craftDbMs) AS craftDbMs',
                'AVG(craftTwigCnt) AS craftTwigCnt',
                'AVG(craftTwigMs) AS craftTwigMs',
                'AVG(craftTotalMemory) AS craftTotalMemory',
            ])

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

            ->from(['{{%webperf_data_samples}}'])
            ->offset($offset)
            ->where(['between', 'dateUpdated', $start, $end])

Space after closing parenthesis of function call prohibited

        ;
        if ((int)$siteId !== 0) {
            $query->andWhere(['siteId' => $siteId]);
        }
        if ($filter !== '') {
            $query
                ->andWhere(['like', 'url', $filter])
                ->orWhere(['like', 'title', $filter])

Space after closing parenthesis of function call prohibited

            ;
        }
        $query
            ->orderBy("{$sortField} {$sortType}")
            ->groupBy('url')
            ->limit($per_page)

Space after closing parenthesis of function call prohibited

        ;

        $stats = $query->all();
        if ($stats) {
            $user = Craft::$app->getUser()->getIdentity();
            // Compute the largest page load time
            $maxTotalPageLoad = 0;
            foreach ($stats as &$stat) {
             // Determine the stat type

Line indented incorrectly; expected at least 16 spaces, found 13

                if (!empty($stat['pageLoad']) && !empty($stat['craftTotalMs'])) {
                    $stat['type'] = 'both';
                }
                if (empty($stat['firstByte'])) {
                    $stat['type'] = 'craft';
                }
                if (empty($stat['craftTotalMs'])) {
                    $stat['type'] = 'frontend';
                }
                if ($stat['pageLoad'] > $maxTotalPageLoad) {
                    $maxTotalPageLoad = $stat['pageLoad'];
                }
            }
            // Massage the stats
            $index = 1;
            foreach ($stats as &$stat) {
                $stat['id'] = $index++;
                $stat['cnt'] = (int)$stat['cnt'];
                $stat['maxTotalPageLoad'] = (int)$maxTotalPageLoad;
                // Decode any emojis in the title
                if (!empty($stat['title'])) {
                    $stat['title'] = html_entity_decode($stat['title'], ENT_NOQUOTES, 'UTF-8');
                }
                // Set up the appropriate helper links
                $stat['deleteLink'] = UrlHelper::actionUrl('webperf/data-samples/delete-samples-by-url', [

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

                    'pageUrl' => $stat['url'],
                    'siteId' => $siteId
                ]);

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

                $stat['detailPageUrl'] = UrlHelper::cpUrl('webperf/page-detail', [

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

                    'pageUrl' => $stat['url'],
                    'siteId' => $siteId,
                ]);

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

                // Override based on permissions
                if (!$user->can('webperf:delete-data-samples')) {
                    $stat['deleteLink'] = '';
                }
                if (!$user->can('webperf:page-detail')) {
                    $stat['detailPageUrl'] = '';
                }
            }
            // Format the data for the API
            $data['data'] = $stats;
            $query = (new Query())
                ->from(['{{%webperf_data_samples}}'])
                ->groupBy('url')
                ->where(['between', 'dateUpdated', $start, $end])

Space after closing parenthesis of function call prohibited

                ;
            if ($filter !== '') {
                $query->andWhere(['like', 'url', $filter]);
                $query->orWhere(['like', 'title', $filter]);
            }
            $count = $query->count();
            $data['links']['pagination'] = [
                'total' => $count,
                'per_page' => $per_page,
                'current_page' => $page,
                'last_page' => ceil($count / $per_page),
                'next_page_url' => null,
                'prev_page_url' => null,
                'from' => $offset + 1,
                'to' => $offset + ($count > $per_page ? $per_page : $count),
            ];
        }

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

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