Passed
Push — v1 ( c4ac61...eb65dc )
by Andrew
10:32 queued 07:18
created

WebperfVariable::craft31()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 1
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
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 by
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 by
@copyright tag must contain a year and the name of the copyright holder
Loading history...
9
 */
0 ignored issues
show
Coding Style introduced by
PHP version not specified
Loading history...
Coding Style introduced by
Missing @category tag in file comment
Loading history...
Coding Style introduced by
Missing @package tag in file comment
Loading history...
Coding Style introduced by
Missing @author tag in file comment
Loading history...
Coding Style introduced by
Missing @license tag in file comment
Loading history...
10
11
namespace nystudio107\webperf\variables;
12
13
use nystudio107\webperf\Webperf;
14
15
/**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
16
 * @author    nystudio107
0 ignored issues
show
Coding Style introduced by
The tag in position 1 should be the @package tag
Loading history...
Coding Style introduced by
Content of the @author tag must be in the form "Display Name <[email protected]>"
Loading history...
Coding Style introduced by
Tag value indented incorrectly; expected 2 spaces but found 4
Loading history...
17
 * @package   Webperf
0 ignored issues
show
Coding Style introduced by
Tag value indented incorrectly; expected 1 spaces but found 3
Loading history...
18
 * @since     1.0.0
0 ignored issues
show
Coding Style introduced by
The tag in position 3 should be the @author tag
Loading history...
Coding Style introduced by
Tag value indented incorrectly; expected 3 spaces but found 5
Loading history...
19
 */
0 ignored issues
show
Coding Style introduced by
Missing @category tag in class comment
Loading history...
Coding Style introduced by
Missing @license tag in class comment
Loading history...
Coding Style introduced by
Missing @link tag in class comment
Loading history...
20
class WebperfVariable extends ManifestVariable
21
{
22
    // Public Methods
23
    // =========================================================================
24
25
    /**
26
     * Whether to include the beacon or not
27
     *
28
     * @param bool $include
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
29
     */
0 ignored issues
show
Coding Style introduced by
Missing @return tag in function comment
Loading history...
30
    public function includeBeacon(bool $include)
31
    {
32
        Webperf::$settings->includeBeacon = $include;
33
    }
34
35
    /**
36
     * Whether to include the Craft beacon or not
37
     *
38
     * @param bool $include
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
39
     */
0 ignored issues
show
Coding Style introduced by
Missing @return tag in function comment
Loading history...
40
    public function includeCraftBeacon(bool $include)
41
    {
42
        Webperf::$settings->includeCraftProfiling = $include;
43
    }
44
45
    /**
46
     * Change the type of render; either `html` or `amp-html` are valid for $renderType
47
     *
48
     * @param string $renderType
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
49
     */
0 ignored issues
show
Coding Style introduced by
Missing @return tag in function comment
Loading history...
50
    public function renderType(string $renderType)
51
    {
52
        Webperf::$renderType = $renderType;
53
    }
54
55
    /**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
56
     * @param int    $siteId
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
57
     * @param string $column
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
58
     *
59
     * @return int|string
60
     */
61
    public function totalSamples(int $siteId, string $column)
62
    {
63
        return Webperf::$plugin->dataSamples->totalSamples($siteId, $column);
64
    }
65
66
    /**
67
     * Get the total number of errors optionally limited by siteId, between
68
     * $start and $end
69
     *
70
     * @param int           $siteId
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Expected 9 spaces after parameter type; 11 found
Loading history...
71
     * @param string        $start
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Expected 6 spaces after parameter type; 8 found
Loading history...
72
     * @param string        $end
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Expected 6 spaces after parameter type; 8 found
Loading history...
73
     * @param string|null   $type
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Expected 1 spaces after parameter type; 3 found
Loading history...
74
     *
75
     * @return int
76
     */
77
    public function totalErrorSamplesRange(int $siteId, string $start, string $end, $type = null): int
78
    {
79
        return Webperf::$plugin->errorSamples->totalErrorSamplesRange($siteId, $start, $end, $type);
80
    }
81
82
    /**
83
     * Return whether we are running Craft 3.1 or later
84
     *
85
     * @return bool
86
     */
87
    public function craft31(): bool
88
    {
89
        return Webperf::$craft31;
90
    }
91
}
92