nystudio107 / craft-instantanalytics-ga4

src/services/Ga4.php

<?php
/**
 * Instant Analytics plugin for Craft CMS
 *
 * Instant Analytics brings full Google Analytics support to your Twig templates
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 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\instantanalyticsGa4\services;

use Br33f\Ga4\MeasurementProtocol\Dto\Event\BaseEvent;
use Br33f\Ga4\MeasurementProtocol\Dto\Parameter\BaseParameter;
use Craft;
use craft\base\Component;
use craft\helpers\Json;
use nystudio107\instantanalyticsGa4\ga4\Analytics;
use nystudio107\instantanalyticsGa4\ga4\events\PageViewEvent;
use nystudio107\instantanalyticsGa4\helpers\Analytics as AnalyticsHelper;
use nystudio107\instantanalyticsGa4\InstantAnalytics;

/** @noinspection MissingPropertyAnnotationsInspection */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

/**

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

 * @package   InstantAnalytics

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     5.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag 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 Ga4 extends Component
{
    /**

Missing short description in doc comment

     * @var ?Analytics
     */
    private $_analytics = null;

    /**

Missing short description in doc comment

     * @var bool
     */
    private $_pageViewSent = false;

    public function getAnalytics(): Analytics

Missing doc comment for function getAnalytics()

    {
        if (!$this->_analytics) {
            $this->_analytics = Craft::createObject(Analytics::class);
            $this->_analytics->init();
        }

        return $this->_analytics;
    }

    /**

Parameter $url should have a doc-comment as per coding-style.

Parameter $pageTitle should have a doc-comment as per coding-style.

     * Send a page view event
     */

Missing @return tag in function comment

    public function addPageViewEvent(string $url = '', string $pageTitle = ''): void
    {
        $request = Craft::$app->getRequest();

        if ($request->getIsSiteRequest() && !$request->getIsConsoleRequest() && !$this->_pageViewSent) {
            $this->_pageViewSent = true;

            $pageView = $this->getPageViewEvent($url, !empty($pageTitle) ? $pageTitle : InstantAnalytics::$currentTemplate);
            $this->getAnalytics()->addEvent($pageView);

            InstantAnalytics::$plugin->logAnalyticsEvent(

The method logAnalyticsEvent() does not exist on null.

                'pageView event queued for sending',
                [],
                __METHOD__
            );
        }
    }

    /**
     * Add a basic event to be sent to GA4
     *
     * @param string $url

Missing parameter comment

     * @param string $eventName

Missing parameter comment

     * @param array $params

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public function addSimpleEvent(string $url, string $eventName, array $params): void
    {
        $baseEvent = $this->getSimpleEvent($eventName);
        $baseEvent->setParamValue('documentPath', parse_url($url, PHP_URL_PATH));

        foreach ($params as $param => $value) {
            $baseEvent->addParam($param, new BaseParameter($value));
        }

        $this->getAnalytics()->addEvent($baseEvent);

        InstantAnalytics::$plugin->logAnalyticsEvent(
            'Simple event queued for {url} with the following parameters {params}',
            ['url' => $url, 'params' => Json::encode($params)],
            __METHOD__
        );
    }

    /**
     * Create a page view event
     *
     * @param string $url

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $pageTitle

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return PageViewEvent

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getPageViewEvent(string $url = '', string $pageTitle = ''): PageViewEvent
    {
        $event = $this->getAnalytics()->create()->PageViewEvent();
        $event->setPageTitle($pageTitle);

        // If SEOmatic is installed, set the page title from it
        $seomaticTitle = AnalyticsHelper::getTitleFromSeomatic();

        if ($seomaticTitle) {
            $event->setPageTitle($seomaticTitle);
        }

        $event->setPageLocation(AnalyticsHelper::getDocumentPathFromUrl($url));

        return $event;
    }

    /**
     * Create a simple event
     *
     * @param string $eventName

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return BaseEvent

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getSimpleEvent(string $eventName): BaseEvent
    {
        $baseEvent = $this->getAnalytics()->create()->BaseEvent();
        $baseEvent->setName($eventName);

        return $baseEvent;
    }
}