Settings::behaviors() - Code Metrics - Inspection of "Merge branch 'release/1.0.8' into v1" - nystudio107/craft-webperf - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v1 ( 76f4e4...83a102 )

by Andrew

created 2019-04-19 19:22 UTC

Settings::behaviors() A

↳ Parent: Settings

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	10
dl	0
loc	17
rs	9.9332
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\models;

use nystudio107\webperf\Webperf;

use Craft;
filter:
    dependency_paths: ["lib/*"]
use craft\base\Model;
filter:
    dependency_paths: ["lib/*"]
use craft\behaviors\EnvAttributeParserBehavior;
filter:
    dependency_paths: ["lib/*"]
use craft\validators\ArrayValidator;
filter:
    dependency_paths: ["lib/*"]
use craft\validators\ColorValidator;
filter:
    dependency_paths: ["lib/*"]

use yii\behaviors\AttributeTypecastBehavior;
filter:
    dependency_paths: ["lib/*"]

use putyourlightson\blitz\Blitz;
filter:
    dependency_paths: ["lib/*"]

/**

 * @author    nystudio107

 * @package   Webperf

 * @since     1.0.0

 */

class Settings extends Model
{
    // Constants
    // =========================================================================

    const BLITZ_PLUGIN_HANDLE = 'blitz';

    // Public Properties
    // =========================================================================

    /**

     * @var string The public-facing name of the plugin
     */
    public $pluginName = 'Webperf';

    /**

     * @var bool Whether or not to include the beacon on the page
     */
    public $includeBeacon = true;

    /**

     * @var bool Whether or not to include the Craft profiling of pages
     */
    public $includeCraftProfiling = true;

    /**

     * @var bool If the site is static cached, turn this option on to prevent Webperf from generating a unique beacon token
     */
    public $staticCachedSite = false;

    /**

     * @var int The number of data samples to store
     */
    public $dataSamplesStoredLimit = 100000;

    /**

     * @var bool Whether the DataSamples should be trimmed after each new DataSample is added
     */
    public $automaticallyTrimDataSamples = true;

    /**

     * @var bool Whether outlier data samples that are 10x the mean should be deleted
     */
    public $trimOutlierDataSamples = true;

    /**

     * @var int The number of milliseconds required between recording of frontend beacon data samples
     */
    public $rateLimitMs = 500;

    /**

     * @var string API Key for WebPageTest.org
     */
    public $webpageTestApiKey = '';

    /**

     * @var array [Regular expressions](https://regexr.com/) to match URLs to exclude from tracking
     */
    public $excludePatterns = [
        0 => [
            'pattern' => '/webperf/.*',
        ],
        1 => [
            'pattern' => '/cpresources/.*',
        ]
    ];

    /**

     * @var bool Whether Craft `warning` messages should be recorded in addition to `error` messages
     */
    public $includeCraftWarnings = false;

    /**

     * @var int The number of error samples to store
     */
    public $errorSamplesStoredLimit = 1000;

    /**

     * @var bool Whether the ErrorSamples should be trimmed after each new ErrorSample is added
     */
    public $automaticallyTrimErrorSamples = true;

    /**

     * @var bool Whether to filter bot user agents from generating profile hits or not
     *           NOT visible in the GUI currently
     */
    public $filterBotUserAgents = true;

    /**

     * @var bool Whether the performance summary sidebar should be shown on entry, category, and product pages
     */
    public $displaySidebar = true;

    /**

     * @var string The dashboard 'fast' color for charts
     */
    public $dashboardFastColor = '#00C800';

    /**

     * @var string The dashboard 'average' color for charts
     */
    public $dashboardAverageColor = '#FFFF00';

    /**

     * @var string The dashboard 'slow' color for charts
     */
    public $dashboardSlowColor = '#C80000';

    // Threshold levels
    // =========================================================================

    /**

     * @var int Threshold in seconds for the dns metric, beyond which it will be considered slow
     */
    public $dnsThreshold = 0.5;

    /**

     * @var int Threshold in seconds for the connect metric, beyond which it will be considered slow
     */
    public $connectThreshold = 0.5;

    /**

     * @var int Threshold in seconds for the first byte metric, beyond which it will be considered slow
     */
    public $firstByteThreshold = 2.0;

    /**

     * @var int Threshold in seconds for the first paint metric, beyond which it will be considered slow
     */
    public $firstPaintThreshold = 5.0;

    /**

     * @var int Threshold in seconds for the first contentful paint metric, beyond which it will be considered slow
     */
    public $firstContentfulPaintThreshold = 5.0;

    /**

     * @var int Threshold in seconds for the DOM interactive metric, beyond which it will be considered slow
     */
    public $domInteractiveThreshold = 5.0;

    /**

     * @var int Threshold in seconds for the page load metric, beyond which it will be considered slow
     */
    public $pageLoadThreshold = 10.0;

    /**

     * @var int Threshold in seconds for the Craft execution metric, beyond which it will be considered slow
     */
    public $craftTotalMsThreshold = 2.0;

    /**

     * @var int Threshold in seconds for the database queries metric, beyond which it will be considered slow
     */
    public $craftDbMsThreshold = 2.0;

    /**

     * @var int Threshold in seconds for the Twig rendering metric, beyond which it will be considered slow
     */
    public $craftTwigMsThreshold = 2.0;

    /**

     * @var int Threshold in seconds for the Craft other metric, beyond which it will be considered slow
     */
    public $craftOtherMsThreshold = 2.0;

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

    /**

     * @inheritdoc
     */

    public function init()
    {
        parent::init();
        // If Blitz is installed & enabled, flip the $staticCachedSite on
        $blitz = Craft::$app->getPlugins()->getPlugin(self::BLITZ_PLUGIN_HANDLE);
        if ($blitz && Blitz::$plugin->getSettings()->cachingEnabled) {
            $this->staticCachedSite = true;
        }
    }

    /**

     * @inheritdoc
     */

    public function rules()
    {
        return [
            ['pluginName', 'string'],
            ['pluginName', 'default', 'value' => 'Webperf'],
            ['includeBeacon', 'boolean'],
            ['includeCraftProfiling', 'boolean'],
            ['staticCachedSite', 'boolean'],
            ['dataSamplesStoredLimit', 'integer'],
            ['dataSamplesStoredLimit', 'default', 'value' => 100000],
            ['automaticallyTrimDataSamples', 'boolean'],
            ['trimOutlierDataSamples', 'boolean'],
            ['rateLimitMs', 'integer'],
            ['rateLimitMs', 'default', 'value' => 500],
            ['webpageTestApiKey', 'string'],
            ['excludePatterns', ArrayValidator::class],
            ['includeCraftWarnings', 'boolean'],
            ['errorSamplesStoredLimit', 'integer'],
            ['errorSamplesStoredLimit', 'default', 'value' => 1000],
            ['automaticallyTrimErrorSamples', 'boolean'],
            ['filterBotUserAgents', 'boolean'],
            ['displaySidebar', 'boolean'],
            ['dashboardFastColor', 'default', 'value' => '#00C800'],
            ['dashboardAverageColor', 'default', 'value' => '#FFA500'],
            ['dashboardSlowColor', 'default', 'value' => '#C80000'],
            [
                [
                    'dashboardFastColor',
                    'dashboardAverageColor',
                    'dashboardSlowColor',
                ],
                ColorValidator::class
            ],
            [
                [
                    'dnsThreshold',
                    'connectThreshold',
                    'firstByteThreshold',
                    'firstPaintThreshold',
                    'firstContentfulPaintThreshold',
                    'domInteractiveThreshold',
                    'pageLoadThreshold',
                    'craftTotalMsThreshold',
                    'craftDbMsThreshold',
                    'craftTwigMsThreshold',
                    'craftOtherMsThreshold',
                ],
                'number',
                'min' => 0.1,
                'max' => 100,
            ]
        ];
    }

    /**

     * @return array
     */
    public function behaviors()
    {
        $craft31Behaviors = [];
        if (Webperf::$craft31) {
            $craft31Behaviors = [
                'parser' => [
                    'class' => EnvAttributeParserBehavior::class,
                    'attributes' => [
                        'webpageTestApiKey',
                    ],
                ]
            ];
        }

        return array_merge($craft31Behaviors, [

            'typecast' => [
                'class' => AttributeTypecastBehavior::class,
                // 'attributeTypes' will be composed automatically according to `rules()`
            ],
        ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }
}


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:37 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:37 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:37 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2019-01-02 04:37 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2019-01-02 04:37 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2019-01-02 04:37 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2019-01-02 04:37 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
10
11			namespace nystudio107\webperf\models;
12
13			use nystudio107\webperf\Webperf;
14
15			use Craft;
			0 ignored issues – show Bug introduced 2019-01-21 19:27 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\base\Model;
			0 ignored issues – show Bug introduced 2019-04-08 15:46 UTC by Report Bug Copy Issue Report The type `craft\base\Model` 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\behaviors\EnvAttributeParserBehavior;
			0 ignored issues – show Bug introduced 2019-04-08 15:46 UTC by Report Bug Copy Issue Report The type `craft\behaviors\EnvAttributeParserBehavior` 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\validators\ArrayValidator;
			0 ignored issues – show Bug introduced 2019-04-08 01:10 UTC by Report Bug Copy Issue Report The type `craft\validators\ArrayValidator` 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\validators\ColorValidator;
			0 ignored issues – show Bug introduced 2019-01-16 03:11 UTC by Report Bug Copy Issue Report The type `craft\validators\ColorValidator` 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\behaviors\AttributeTypecastBehavior;
			0 ignored issues – show Bug introduced 2019-04-08 01:10 UTC by Report Bug Copy Issue Report The type `yii\behaviors\AttributeTypecastBehavior` 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
23			use putyourlightson\blitz\Blitz;
			0 ignored issues – show Bug introduced 2019-01-21 19:27 UTC by Report Bug Copy Issue Report The type `putyourlightson\blitz\Blitz` 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...
24
25			/**
			0 ignored issues – show Coding Style introduced 2019-01-21 19:27 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
26			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2019-01-02 04:37 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:37 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-04-08 00:47 UTC by Report Bug Copy Issue Report Tag value for @author tag indented incorrectly; expected 2 spaces but found 4 Loading history...
27			* @package Webperf
			0 ignored issues – show Coding Style introduced 2019-04-08 00:47 UTC by Report Bug Copy Issue Report Tag value for @package tag indented incorrectly; expected 1 spaces but found 3 Loading history...

nystudio107 / craft-webperf

Push — v1 ( 76f4e4...83a102 )

Settings::behaviors() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like