CraftTotalTime::evaluate() - Code Metrics - Inspection of "Add recommendations" - nystudio107/craft-webperf - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( fb586e...8175c8 )

by Andrew

created 2019-01-28 23:40 UTC

CraftTotalTime::evaluate() A

↳ Parent: CraftTotalTime

Complexity

Conditions	2
Paths	2

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	12
dl	0
loc	21
rs	9.8666
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?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\recommendations;

use nystudio107\webperf\base\Recommendation;

use Craft;
filter:
    dependency_paths: ["lib/*"]

/**

 * @author    nystudio107

 * @package   Webperf

 * @since     1.0.0

 */

class CraftTotalTime extends Recommendation
{
    // Constants
    // =========================================================================

    const MAX_TOTAL_TIME = 2 * 1000;

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

    /**

     * @inheritdoc
     */

    public function evaluate()
    {
        // See if there are too many database queries
        if ($this->sample->craftTotalMs >= self::MAX_TOTAL_TIME) {
            $displayCraftTotalMs = ($this->sample->craftTotalMs / 1000) . 's';
            $this->hasRecommendation = true;
            $this->summary = Craft::t(
                'webperf',
                'Look into utilizing the `{% cache %}` tag',
                []
            );
            $this->detail = Craft::t(
                'webperf',
                'It took Craft a total of {displayCraftTotalMs} to render. Ensure you are utilizing the `{% cache %}` tag effectively to solve concurrency issues.',
                [
                    'displayCraftTotalMs' => $displayCraftTotalMs,
                ]
            );
            $this->learnMoreUrl = 'https://nystudio107.com/blog/the-craft-cache-tag-in-depth';

            return;
        }
    }
}


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-28 23:43 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-28 23:43 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-28 23:43 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
10
11			namespace nystudio107\webperf\recommendations;
12
13			use nystudio107\webperf\base\Recommendation;
14
15			use Craft;
			0 ignored issues – show Bug introduced 2019-01-28 23:43 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
17			/**
			0 ignored issues – show Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
18			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2019-01-28 23:43 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-28 23:43 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 2 spaces but found 4 Loading history...
19			* @package Webperf
			0 ignored issues – show Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 1 spaces but found 3 Loading history...
20			* @since 1.0.0
			0 ignored issues – show Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report The tag in position 3 should be the @author tag Loading history... Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 3 spaces but found 5 Loading history...
21			*/
			0 ignored issues – show Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
22			class CraftTotalTime extends Recommendation
23			{
24			// Constants
25			// =========================================================================
26
27			const MAX_TOTAL_TIME = 2 * 1000;
28
29			// Public Methods
30			// =========================================================================
31
32			/**
			0 ignored issues – show Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
33			* @inheritdoc
34			*/
			0 ignored issues – show Coding Style introduced 2019-01-28 23:43 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
35			public function evaluate()
36			{
37			// See if there are too many database queries
38			if ($this->sample->craftTotalMs >= self::MAX_TOTAL_TIME) {
39			$displayCraftTotalMs = ($this->sample->craftTotalMs / 1000) . 's';
40			$this->hasRecommendation = true;
41			$this->summary = Craft::t(
42			'webperf',
43			'Look into utilizing the `{% cache %}` tag',
44			[]
45			);
46			$this->detail = Craft::t(
47			'webperf',
48			'It took Craft a total of {displayCraftTotalMs} to render. Ensure you are utilizing the `{% cache %}` tag effectively to solve concurrency issues.',
49			[
50			'displayCraftTotalMs' => $displayCraftTotalMs,
51			]
52			);
53			$this->learnMoreUrl = 'https://nystudio107.com/blog/the-craft-cache-tag-in-depth';
54
55			return;
56			}
57			}
58			}
59

nystudio107 / craft-webperf

Push — develop ( fb586e...8175c8 )

CraftTotalTime::evaluate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like