nystudio107\webperf\models\Settings

Complexity

Total Complexity

5

Size/Duplication

Total Lines	247
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	behaviors()	0	5	1
A	rules()	0	50	1
A	init()	0	7	3

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

use Craft;

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

use craft\base\Model;

The type craft\base\Model was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\validators\ArrayValidator;

The type craft\validators\ArrayValidator was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\validators\ColorValidator;

The type craft\validators\ColorValidator was not found. Maybe you did not declare it correctly or list all dependencies?

use yii\behaviors\AttributeTypecastBehavior;

The type yii\behaviors\AttributeTypecastBehavior was not found. Maybe you did not declare it correctly or list all dependencies?

use putyourlightson\blitz\Blitz;

The type putyourlightson\blitz\Blitz 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 for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Webperf

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag 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 Settings extends Model
{
    // Constants
    // =========================================================================

    const BLITZ_PLUGIN_HANDLE = 'blitz';

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    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;
        }
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    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,
            ]
        ];
    }

    /**

Missing short description in doc comment

     * @return array
     */
    public function behaviors()
    {
        return [
            'typecast' => [
                'class' => AttributeTypecastBehavior::class,
                // 'attributeTypes' will be composed automatically according to `rules()`
            ],
        ];
    }
}