nystudio107 / craft-instantanalytics-ga4

src/variables/InstantAnalyticsVariable.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\variables;

use Br33f\Ga4\MeasurementProtocol\Dto\Event\BaseEvent;
use craft\commerce\elements\Product;
use craft\commerce\elements\Variant;
use craft\helpers\Template;
use nystudio107\instantanalyticsGa4\ga4\Analytics;
use nystudio107\instantanalyticsGa4\ga4\events\PageViewEvent;
use nystudio107\instantanalyticsGa4\helpers\Analytics as AnalyticsHelper;
use nystudio107\instantanalyticsGa4\InstantAnalytics;
use nystudio107\pluginvite\variables\ViteVariableInterface;
use nystudio107\pluginvite\variables\ViteVariableTrait;
use Twig\Markup;
use yii\base\Exception;

/**
 * Instant Analytics Variable
 *
 * @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     1.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 InstantAnalyticsVariable implements ViteVariableInterface
{
    use ViteVariableTrait;

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

    /**
     * Get a PageView Event
     *
     * @param string $url

Missing parameter comment

     * @param string $title

Missing parameter comment

     *
     * @return PageViewEvent
     */
    public function pageViewEvent(string $url = '', string $title = ''): PageViewEvent
    {
        return InstantAnalytics::$plugin->ga4->getPageViewEvent($url, $title);
    }

    /**
     * Get 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 simpleEvent(string $eventName = ''): BaseEvent
    {
        return InstantAnalytics::$plugin->ga4->getSimpleEvent($eventName);
    }

    /**
     * Return the GA4 Analytics object
     *
     * @return Analytics
     */
    public function ga4(): Analytics
    {
        return InstantAnalytics::$plugin->ga4->getAnalytics();
    }

    /**

Missing short description in doc comment

     * @param Product|Variant $productVariant the Product or Variant
     */

Missing @return tag in function comment

    public function addCommerceProductView($productVariant): void
    {
        InstantAnalytics::$plugin->commerce->addCommerceProductImpression($productVariant);
    }

    /**
     * Get a PageView tracking URL
     *
     * @param $url

Missing parameter comment

     * @param $title

Missing parameter comment

     *
     * @return Markup
     * @throws Exception
     */
    public function pageViewTrackingUrl($url, $title): Markup
    {
        return Template::raw(AnalyticsHelper::getPageViewTrackingUrl($url, $title));
    }

    /**
     * Get an Event tracking URL
     *
     * @param string $url

Missing parameter comment

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

     * @param string $eventName

Missing parameter comment

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

     * @param array $params

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

     * @return Markup

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

     * @throws Exception

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

     */
    public function eventTrackingUrl(
        string $url,
        string $eventName = '',
        array  $params = [],
    ): Markup {
        return Template::raw(AnalyticsHelper::getEventTrackingUrl($url, $eventName, $params));
    }
}