nystudio107\webperf\services\Recommendations

Complexity

Total Complexity

7

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	list()	0	15	3
A	data()	0	47	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) 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\services;

use nystudio107\webperf\base\Recommendation;
use nystudio107\webperf\models\RecommendationDataSample;
use nystudio107\webperf\recommendations\CraftQueryCount;
use nystudio107\webperf\recommendations\CraftQueryTime;
use nystudio107\webperf\recommendations\CraftTotalTime;
use nystudio107\webperf\recommendations\CraftTwigTime;
use nystudio107\webperf\recommendations\DomInteractive;
use nystudio107\webperf\recommendations\FirstByte;
use nystudio107\webperf\recommendations\FirstContentfulPaint;
use nystudio107\webperf\recommendations\MemoryLimit;

use Craft;

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

use craft\base\Component;

The type craft\base\Component 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 yii\helpers\Markdown;

The type yii\helpers\Markdown 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 Recommendations extends Component
{
    // Constants
    // =========================================================================

    const RECOMMENDATIONS_LIST = [
        CraftQueryCount::class,
        CraftQueryTime::class,
        CraftTwigTime::class,
        CraftTotalTime::class,
        FirstByte::class,
        FirstContentfulPaint::class,
        DomInteractive::class,
        MemoryLimit::class,
    ];

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

    /**
     * Return a list of recommendations
     *
     * @param RecommendationDataSample $sample

Missing parameter comment

     *
     * @return array
     */
    public function list(RecommendationDataSample $sample): array
    {
        $data = [];
        foreach (self::RECOMMENDATIONS_LIST as $recClass) {
            /** @var Recommendation $rec */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $rec = new $recClass(['sample' => $sample]);
            if ($rec->hasRecommendation) {
                $data[] = [
                    'summary' => Markdown::processParagraph($rec->summary),
                    'detail' => Markdown::processParagraph($rec->detail),
                    'learnMoreUrl' => $rec->learnMoreUrl,
                ];
            }
        }
        return $data;
    }

    /**
     * Return a list of recommendations
     *
     * @param string $pageUrl

Missing parameter comment

     * @param string $start

Missing parameter comment

     * @param string $end

Missing parameter comment

     * @param int    $siteId

Missing parameter comment

     *
     * @return array
     */
    public function data(
        $pageUrl = '',
        string $start = '',
        string $end = '',
        $siteId = 0
    ): array {
        $data = [];
        $db = Craft::$app->getDb();

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

        // 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);
        // Query the db table
        $query = (new Query())
            ->select([

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

                '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([[craftDbMs]]) AS craftDbMs',
                'AVG([[craftDbCnt]]) AS craftDbCnt',
                'AVG([[craftTwigMs]]) AS craftTwigMs',
                'AVG([[craftTwigCnt]]) AS craftTwigCnt',
                'AVG([[craftOtherMs]]) AS craftOtherMs',
                'AVG([[craftOtherCnt]]) AS craftOtherCnt',
                'AVG([[craftTotalMemory]]) AS craftTotalMemory',
            ])

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

            ->from(['{{%webperf_data_samples}}'])
            ->where(['between', 'dateCreated', $start, $end]);
        if (!empty($pageUrl)) {
            $query->andWhere(['url' => $pageUrl]);
        }
        if ((int)$siteId !== 0) {
            $query->andWhere(['siteId' => $siteId]);
        }
        $stats = $query->all();
        if ($stats) {
            $data = $stats[0];
        }

        return $data;
    }
}