nystudio107\webperf\variables\WebperfVariable

Complexity

Total Complexity

4

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	includeBeacon()	0	3	1
A	renderType()	0	3	1
A	includeCraftBeacon()	0	3	1
A	totalSamples()	0	3	1

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

use nystudio107\webperf\Webperf;

/**

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 indented incorrectly; expected 2 spaces but found 4

 * @package   Webperf

Tag value indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value 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 WebperfVariable extends ManifestVariable
{
    // Public Methods
    // =========================================================================

    /**
     * Whether to include the beacon or not
     *
     * @param bool $include

Missing parameter comment

     */

Missing @return tag in function comment

    public function includeBeacon(bool $include)
    {
        Webperf::$settings->includeBeacon = $include;
    }

    /**
     * Whether to include the Craft beacon or not
     *
     * @param bool $include

Missing parameter comment

     */

Missing @return tag in function comment

    public function includeCraftBeacon(bool $include)
    {
        Webperf::$settings->includeCraftProfiling = $include;
    }

    /**
     * Change the type of render; either `html` or `amp-html` are valid for $renderType
     *
     * @param string $renderType

Missing parameter comment

     */

Missing @return tag in function comment

    public function renderType(string $renderType)
    {
        Webperf::$renderType = $renderType;
    }

    /**

Missing short description in doc comment

     * @param int    $siteId

Missing parameter comment

     * @param string $column

Missing parameter comment

     *
     * @return int|string
     */
    public function totalSamples(int $siteId, string $column)
    {
        return Webperf::$plugin->dataSamples->totalSamples($siteId, $column);
    }

}