nystudio107 / craft-instantanalytics-ga4

src/twigextensions/InstantAnalyticsTwigExtension.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\twigextensions;

use Br33f\Ga4\MeasurementProtocol\Dto\Event\BaseEvent;
use Craft;
use craft\helpers\Template;
use nystudio107\instantanalyticsGa4\ga4\events\PageViewEvent;
use nystudio107\instantanalyticsGa4\helpers\Analytics;
use nystudio107\instantanalyticsGa4\InstantAnalytics;
use Twig\Extension\AbstractExtension;
use Twig\Extension\GlobalsInterface;
use Twig\Markup;
use Twig\TwigFilter;
use Twig\TwigFunction;
use yii\base\Exception;

/**
 * Twig can be extended in many ways; you can add extra tags, filters, tests,
 * operators, global variables, and functions. You can even extend the parser
 * itself with node visitors.
 *
 * http://twig.sensiolabs.org/doc/advanced.html

Doc comment long description must start with a capital letter

 *
 * @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 InstantAnalyticsTwigExtension extends AbstractExtension implements GlobalsInterface
{
    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return 'InstantAnalytics';
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getGlobals(): array
    {
        $globals = [];
        $view = Craft::$app->getView();
        if ($view->getIsRenderingPageTemplate()) {
            $request = Craft::$app->getRequest();
            if ($request->getIsSiteRequest() && !$request->getIsConsoleRequest()) {
                // Return our Analytics object as a Twig global
                $globals = [
                    'instantAnalytics' => InstantAnalytics::$plugin->ga4->getAnalytics(),
                ];
            }
        }

        return $globals;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getFilters(): array
    {
        return [
            new TwigFilter('pageViewEvent', [$this, 'pageViewEvent']),
            new TwigFilter('simpleAnalyticsEvent', [$this, 'simpleEvent']),
            new TwigFilter('pageViewTrackingUrl', [$this, 'pageViewTrackingUrl']),
            new TwigFilter('eventTrackingUrl', [$this, 'eventTrackingUrl']),
        ];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getFunctions(): array
    {
        return [
            new TwigFunction('pageViewEvent', [$this, 'pageViewEvent']),
            new TwigFunction('simpleAnalyticsEvent', [$this, 'simpleEvent']),
            new TwigFunction('pageViewTrackingUrl', [$this, 'pageViewTrackingUrl']),
            new TwigFunction('eventTrackingUrl', [$this, 'eventTrackingUrl']),
        ];
    }

    /**
     * Get a PageView analytics object
     *
     * @param string $url

Missing parameter comment

     * @param string $title

Missing parameter comment

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

    /**
     * Get an Event analytics object
     *
     * @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);
    }

    /**
     * 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(Analytics::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(Analytics::getEventTrackingUrl($url, $eventName, $params));
    }
}