nystudio107 / craft-instantanalytics

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\instantanalytics\twigextensions;

use Craft;
use craft\helpers\Template;
use nystudio107\instantanalytics\helpers\IAnalytics;
use nystudio107\instantanalytics\InstantAnalytics;
use Twig\Extension\AbstractExtension;
use Twig\Extension\GlobalsInterface;
use Twig\Markup;
use Twig\TwigFilter;
use Twig\TwigFunction;

/**
 * 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()
    {
        return 'InstantAnalytics';
    }

    /** @noinspection ReturnTypeCanBeDeclaredInspection */

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

     * @@inheritdoc
     */

Missing @return tag in function comment

    public function getGlobals()
    {
        $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->ia->getGlobals(InstantAnalytics::$currentTemplate),
                ];
            }
        }

        return $globals;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getFilters()
    {
        return [
            new TwigFilter('pageViewAnalytics', [$this, 'pageViewAnalytics']),
            new TwigFilter('eventAnalytics', [$this, 'eventAnalytics']),
            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()
    {
        return [
            new TwigFunction('pageViewAnalytics', [$this, 'pageViewAnalytics']),
            new TwigFunction('eventAnalytics', [$this, 'eventAnalytics']),
            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 null|IAnalytics object
     */
    public function pageViewAnalytics($url = '', $title = '')
    {
        return InstantAnalytics::$plugin->ia->pageViewAnalytics($url, $title);
    }

    /**
     * Get an Event analytics object
     *
     * @param string $eventCategory

Missing parameter comment

     * @param string $eventAction

Missing parameter comment

     * @param string $eventLabel

Missing parameter comment

     * @param int $eventValue

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @return null|IAnalytics
     */
    public function eventAnalytics($eventCategory = '', $eventAction = '', $eventLabel = '', $eventValue = 0)
    {
        return InstantAnalytics::$plugin->ia->eventAnalytics($eventCategory, $eventAction, $eventLabel, $eventValue);
    }

    /**
     * Return an Analytics object
     *
     * @return null|IAnalytics
     */
    public function analytics()
    {
        return InstantAnalytics::$plugin->ia->analytics();
    }

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

Missing parameter comment

     * @param $title

Missing parameter comment

     *
     * @return Markup
     * @throws \yii\base\Exception
     */
    public function pageViewTrackingUrl($url, $title): Markup
    {
        return Template::raw(InstantAnalytics::$plugin->ia->pageViewTrackingUrl($url, $title));
    }

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

Missing parameter comment

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

     * @param string $eventCategory

Missing parameter comment

     * @param string $eventAction

Missing parameter comment

     * @param string $eventLabel

Missing parameter comment

     * @param int $eventValue

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @return Markup
     * @throws \yii\base\Exception
     */
    public function eventTrackingUrl(
        $url,
        $eventCategory = '',
        $eventAction = '',
        $eventLabel = '',
        $eventValue = 0
    ): Markup
    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        return Template::raw(InstantAnalytics::$plugin->ia->eventTrackingUrl(

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

            $url,
            $eventCategory,
            $eventAction,
            $eventLabel,
            $eventValue
        ));

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

    }
}