nystudio107 /
craft-webperf
| 1 | <?php |
||
| 4 | * |
||
| 5 | * Monitor the performance of your webpages through real-world user timing data |
||
| 6 | * |
||
| 7 | * @link https://nystudio107.com |
||
|
Coding Style
introduced
by
|
|||
| 8 | * @copyright Copyright (c) 2019 nystudio107 |
||
| 9 | */ |
||
| 10 | |||
| 11 | namespace nystudio107\webperf\models; |
||
| 12 | |||
| 13 | use Craft; |
||
| 14 | use craft\base\Model; |
||
| 15 | use craft\validators\ColorValidator; |
||
| 16 | |||
| 17 | use putyourlightson\blitz\Blitz; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * @author nystudio107 |
||
| 21 | * @package Webperf |
||
| 22 | * @since 1.0.0 |
||
| 23 | */ |
||
| 24 | class Settings extends Model |
||
| 25 | { |
||
| 26 | // Constants |
||
| 31 | // Public Properties |
||
| 32 | // ========================================================================= |
||
| 33 | |||
| 34 | /** |
||
| 35 | * @var string The public-facing name of the plugin |
||
| 36 | */ |
||
| 37 | public $pluginName = 'Webperf'; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * @var bool Whether or not to include the beacon on the page |
||
| 41 | */ |
||
| 42 | public $includeBeacon = true; |
||
| 43 | |||
| 44 | /** |
||
| 45 | * @var bool Whether or not to include the Craft profiling of pages |
||
| 46 | */ |
||
| 47 | public $includeCraftProfiling = true; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * @var bool If the site is static cached, turn this option on to prevent Webperf from generating a unique beacon token |
||
| 51 | */ |
||
| 52 | public $staticCachedSite = false; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * @var int The number of data samples to store |
||
| 56 | */ |
||
| 57 | public $dataSamplesStoredLimit = 100000; |
||
| 58 | |||
| 59 | /** |
||
| 60 | * @var bool Whether the DataSamples should be trimmed after each new DataSample is added |
||
| 61 | */ |
||
| 62 | public $automaticallyTrimDataSamples = true; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * @var bool Whether outlier data samples that are 10x the mean should be deleted |
||
| 66 | */ |
||
| 67 | public $trimOutlierDataSamples = true; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * @var int The number of milliseconds required between recording of frontend beacon data samples |
||
| 71 | */ |
||
| 72 | public $rateLimitMs = 500; |
||
| 73 | |||
| 74 | /** |
||
| 75 | * @var string API Key for WebPageTest.org |
||
| 76 | */ |
||
| 77 | public $webpageTestApiKey = ''; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * @var bool Whether Craft `warning` messages should be recorded in addition to `error` messages |
||
| 81 | */ |
||
| 82 | public $includeCraftWarnings = false; |
||
| 83 | |||
| 84 | /** |
||
| 85 | * @var int The number of error samples to store |
||
| 86 | */ |
||
| 87 | public $errorSamplesStoredLimit = 1000; |
||
| 88 | |||
| 89 | /** |
||
| 90 | * @var bool Whether the ErrorSamples should be trimmed after each new ErrorSample is added |
||
| 91 | */ |
||
| 92 | public $automaticallyTrimErrorSamples = true; |
||
| 93 | |||
| 94 | /** |
||
| 95 | * @var bool Whether to filter bot user agents from generating profile hits or not |
||
| 96 | * NOT visible in the GUI currently |
||
| 97 | */ |
||
| 98 | public $filterBotUserAgents = true; |
||
| 99 | |||
| 100 | /** |
||
| 101 | * @var bool Whether the performance summary sidebar should be shown on entry, category, and product pages |
||
| 102 | */ |
||
| 103 | public $displaySidebar = true; |
||
| 104 | |||
| 105 | /** |
||
| 106 | * @var string The dashboard 'fast' color for charts |
||
| 107 | */ |
||
| 108 | public $dashboardFastColor = '#00C800'; |
||
| 109 | |||
| 110 | /** |
||
| 111 | * @var string The dashboard 'average' color for charts |
||
| 112 | */ |
||
| 113 | public $dashboardAverageColor = '#FFFF00'; |
||
| 114 | |||
| 115 | /** |
||
| 116 | * @var string The dashboard 'slow' color for charts |
||
| 117 | */ |
||
| 118 | public $dashboardSlowColor = '#C80000'; |
||
| 120 | // Public Methods |
||
| 121 | // ========================================================================= |
||
| 122 | |||
| 123 | public function init() |
||
| 124 | { |
||
| 125 | parent::init(); |
||
| 126 | // If Blitz is installed & enabled, flip the $staticCachedSite on |
||
| 130 | } |
||
| 131 | } |
||
| 132 | |||
| 133 | /** |
||
| 134 | * @inheritdoc |
||
| 135 | */ |
||
| 136 | public function rules() |
||
| 137 | { |
||
| 138 | return [ |
||
| 171 |
Loading history...