nystudio107\webperf\services\Beacons

Complexity

Total Complexity

11

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	ampHtmlIframe()	0	17	1
A	getDocumentTitle()	0	18	5
A	includeHtmlBeacon()	0	19	1
A	includeAmpHtmlScript()	0	11	1
A	includeAmpHtmlBeacon()	0	9	1
A	includeCraftBeacon()	0	25	2

<?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) 2018 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\models\DataSample;
use nystudio107\webperf\Webperf;
use nystudio107\webperf\helpers\PluginTemplate;

use nystudio107\seomatic\Seomatic;

The type nystudio107\seomatic\Seomatic 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\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
    // =========================================================================

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

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

    {
        $view = Craft::$app->getView();
        $boomerangUrl = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/webperf/assetbundles/boomerang/dist/js/boomerang-1.0.0.min.js',
            true
        );
        $boomerangTitle = $this->getDocumentTitle();
        $script = PluginTemplate::renderPluginTemplate(
            '_frontend/scripts/load-boomerang-iframe.twig',
            [
                'boomerangScriptUrl' => $boomerangUrl,
                'boomerangTitle' => $boomerangTitle,
                'boomerangRequestId' => Webperf::$requestUuid,
            ]
        );
        $view->registerJs(
            $script,
            $view::POS_HEAD
        );
    }

    /*
     * @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'),
            ]
        );
        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();
        $html = PluginTemplate::renderPluginTemplate(
            '_frontend/scripts/boomerang-amp-iframe-html.twig',
            [
                'boomerangScriptUrl' => $boomerangUrl,
                'boomerangTitle' => $boomerangTitle,
                'boomerangRequestId' => Webperf::$requestUuid,
            ]
        );

        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()
    {
        if (Webperf::$beaconIncluded) {
            $stats = Webperf::$plugin->profileTarget->stats;
            // Allocate a new DataSample, and fill it in
            $sample = new DataSample([

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

                'requestId' => Webperf::$requestUuid,
                'url' =>DataSample::PLACEHOLDER_URL,
                'craftTotalMs' => (int)($stats['database']['duration']
                    + $stats['twig']['duration']
                    + $stats['other']['duration']),
                '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
            $sample->setScenario(DataSample::SCENARIO_CRAFT_BEACON);
            Craft::debug('Saving Craft DataSample: '.print_r($sample, true), __METHOD__);
            Webperf::$plugin->dataSamples->addDataSample($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 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;
    }
}