nystudio107\webperf\services\Beacons

Complexity

Total Complexity

21

Size/Duplication

Total Lines	225
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	ampHtmlIframe()	0	19	2
A	getDocumentTitle()	0	21	6
A	includeHtmlBeacon()	0	8	1
A	includeAmpHtmlScript()	0	11	1
A	includeAmpHtmlBeacon()	0	10	1
A	htmlBeaconScript()	0	20	2
A	includeCraftBeacon()	0	45	4
A	includeCraftErrorsBeacon()	0	32	4

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

use nystudio107\webperf\Webperf;
use nystudio107\webperf\base\CraftDataSample;
use nystudio107\webperf\helpers\MultiSite;
use nystudio107\webperf\helpers\PluginTemplate;
use nystudio107\webperf\models\CraftDbErrorSample;
use nystudio107\webperf\models\CraftDbDataSample;

use nystudio107\seomatic\Seomatic;

The type nystudio107\seomatic\Seomatic was not found. Maybe you did not declare it correctly or list all dependencies?

use Jaybizzle\CrawlerDetect\CrawlerDetect;

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

use Craft;

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

use craft\base\Component;

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

use craft\errors\SiteNotFoundException;

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

use craft\helpers\UrlHelper;

The type craft\helpers\UrlHelper 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 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 Beacons extends Component
{
    // Constants
    // =========================================================================

    const AMP_IFRAME_SCRIPT_URL = "https://cdn.ampproject.org/v0/amp-iframe-0.1.js";
    const SEOMATIC_PLUGIN_HANDLE = 'seomatic';

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

    /**

Missing short description in doc comment

     * @return void
     */
    public function includeHtmlBeacon()
    {
        $view = Craft::$app->getView();
        $script = $this->htmlBeaconScript(false);
        // Register the JavaScript
        $view->registerJs(
            $script,
            $view::POS_HEAD
        );
    }

    /**

Missing short description in doc comment

     * @param bool        $headless

Missing parameter comment

     * @param string|null $title

Missing parameter comment

     *
     * @return string
     */
    public function htmlBeaconScript(bool $headless = false, string $title = null): string
    {
        $boomerangUrl = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/webperf/assetbundles/boomerang/dist/js/boomerang-1.0.0.min.js',
            true
        );
        $boomerangTitle = $title ?? $this->getDocumentTitle();
        $boomerangRequestId = Webperf::$settings->staticCachedSite ? null : Webperf::$requestUuid;
        $script = PluginTemplate::renderPluginTemplate(
            '_frontend/scripts/load-boomerang-iframe.twig',
            [
                'headless' => $headless,
                'boomerangScriptUrl' => $boomerangUrl,
                'boomerangTitle' => $boomerangTitle,
                'boomerangRequestId' => $boomerangRequestId,
            ],
            'jsMin'
        );

        return $script;
    }

    /*
     * @return void
     */
    public function includeAmpHtmlScript()

You must use "/**" style comments for a function comment

    {
        $view = Craft::$app->getView();
        $view->registerJsFile(
            self::AMP_IFRAME_SCRIPT_URL,
            [
                'position' => $view::POS_HEAD,
                'async' => 'async',
                'custom-element' => 'amp-iframe',
            ],
            'webperf-amp-iframe-script'
        );
    }

    /*
     * @return void
     */
    public function includeAmpHtmlBeacon()

You must use "/**" style comments for a function comment

    {
        $html = PluginTemplate::renderPluginTemplate(
            '_frontend/scripts/load-boomerang-amp-iframe.twig',
            [
                'boomerangIframeUrl' => UrlHelper::siteUrl('/webperf/render/amp-iframe'),
            ],
            'minify'
        );
        echo $html;
    }

    /*
     * @return void
     */
    public function ampHtmlIframe()

You must use "/**" style comments for a function comment

    {
        $boomerangUrl = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/webperf/assetbundles/boomerang/dist/js/boomerang-1.0.0.min.js',
            true
        );
        $boomerangTitle = $this->getDocumentTitle();
        $boomerangRequestId = Webperf::$settings->staticCachedSite ? null : Webperf::$requestUuid;
        $html = PluginTemplate::renderPluginTemplate(
            '_frontend/scripts/boomerang-amp-iframe-html.twig',
            [
                'boomerangScriptUrl' => $boomerangUrl,
                'boomerangTitle' => $boomerangTitle,
                'boomerangRequestId' => $boomerangRequestId,
            ],
            'minify'
        );

        return $html;

The expression return $html returns the type string which is incompatible with the documented return type void.

    }

    /**

Missing short description in doc comment

     * @return void
     */
    public function includeCraftBeacon()
    {
        // Filter out bot/spam requests via UserAgent
        if (Webperf::$settings->filterBotUserAgents) {
            $crawlerDetect = new CrawlerDetect;
            // Check the user agent of the current 'visitor'
            if ($crawlerDetect->isCrawler()) {
                return;
            }
        }
        $url = Webperf::$requestUrl ?? CraftDataSample::PLACEHOLDER_URL;
        // Get the site id
        try {
            $site = MultiSite::getSiteFromUrl($url);
            $siteId = $site->id;
        } catch (SiteNotFoundException $e) {
            $siteId = null;
        }
        $stats = Webperf::$plugin->profileTarget->stats;
        $request = Craft::$app->getRequest();
        $pageLoad = (int)($stats['database']['duration']
            + $stats['twig']['duration']
            + $stats['other']['duration']);
        // Allocate a new DataSample, and fill it in
        $sample = new CraftDbDataSample([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'requestId' => Webperf::$requestUuid,
            'siteId' => $siteId,
            'url' => $url,
            'title' => $this->getDocumentTitle(),
            'queryString' => $request->getQueryString(),
            'pageLoad' => $pageLoad,
            'craftTotalMs' => $pageLoad,
            'craftDbMs' => (int)$stats['database']['duration'],
            'craftDbCnt' => (int)$stats['database']['count'],
            'craftTwigMs' => (int)$stats['twig']['duration'],
            'craftTwigCnt' => (int)$stats['twig']['count'],
            'craftOtherMs' => (int)$stats['other']['duration'],
            'craftOtherCnt' => (int)$stats['other']['count'],
            'craftTotalMemory' => (int)($stats['database']['memory']
                + $stats['twig']['memory']
                + $stats['other']['memory']),
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        // Save the data sample
        Craft::debug('Saving Craft DataSample: '.print_r($sample->getAttributes(), true), __METHOD__);
        Webperf::$plugin->dataSamples->addDataSample($sample);
    }

    /**

Missing short description in doc comment

     * @return void
     */
    public function includeCraftErrorsBeacon()
    {
        // Filter out bot/spam requests via UserAgent
        if (Webperf::$settings->filterBotUserAgents) {
            $crawlerDetect = new CrawlerDetect;
            // Check the user agent of the current 'visitor'
            if ($crawlerDetect->isCrawler()) {
                return;
            }
        }
        $url = Webperf::$requestUrl ?? CraftDataSample::PLACEHOLDER_URL;
        // Get the site id
        try {
            $site = MultiSite::getSiteFromUrl($url);
            $siteId = $site->id;
        } catch (SiteNotFoundException $e) {
            $siteId = null;
        }
        $messages = Webperf::$plugin->errorsTarget->pageErrors;
        $request = Craft::$app->getRequest();
        // Allocate a new ErrorSample, and fill it in
        $sample = new CraftDbErrorSample([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'requestId' => Webperf::$requestUuid,
            'siteId' => $siteId,
            'url' => $url,
            'queryString' => $request->getQueryString(),
            'title' => $this->getDocumentTitle(),
            'pageErrors' => $messages,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        // Save the error sample
        Craft::debug('Saving Craft ErrorSample: '.print_r($sample->getAttributes(), true), __METHOD__);
        Webperf::$plugin->errorSamples->addErrorSample($sample);
    }

    // Protected Methods
    // =========================================================================

    /**
     * Get the title of the currently rendering document
     *
     * @return string
     */
    protected function getDocumentTitle(): string
    {
        // Default to whatever the view title is
        $view = Craft::$app->getView();
        $docTitle = $view->title;
        if (empty($docTitle)) {
            $docTitle = '';
        }
        // If SEOmatic is installed, get the title from it
        $seomatic = Craft::$app->getPlugins()->getPlugin(self::SEOMATIC_PLUGIN_HANDLE);
        if ($seomatic && Seomatic::$settings->renderEnabled) {
            $titleTag = Seomatic::$plugin->title->get('title');
            if ($titleTag) {
                $titleArray = $titleTag->renderAttributes();
                if (!empty($titleArray['title'])) {
                    $docTitle = $titleArray['title'];
                }
            }
        }

        return $docTitle;
    }
}