nystudio107 / craft-instantanalytics

src/controllers/TrackController.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\controllers;

use craft\web\Controller;
use nystudio107\instantanalytics\InstantAnalytics;

/**
 * TrackController
 *
 * @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 TrackController extends Controller
{

    // Protected Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var    bool|array Allows anonymous access to this controller's actions.
     *         The actions must be in 'kebab-case'
     * @access protected
     */
    protected $allowAnonymous = [
        'track-page-view-url',
        'track-event-url'
    ];

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

    /**

Missing short description in doc comment

     * @param string $url

Missing parameter comment

     * @param string $title

Missing parameter comment

     */

Missing @return tag in function comment

    public function actionTrackPageViewUrl(string $url, string $title)
    {
        $analytics = InstantAnalytics::$plugin->ia->pageViewAnalytics($url, $title);
        if ($analytics !== null) {
            $analytics->sendPageview();
        }
        $this->redirect($url, 200);
    }

    /**

Missing short description in doc comment

     * @param string $url

Missing parameter comment

     * @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

     */

Missing @return tag in function comment

    public function actionTrackEventUrl(
        string $url,
        string $eventCategory,
        string $eventAction,
        string $eventLabel,
        int    $eventValue
    )
    {

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

        $analytics = InstantAnalytics::$plugin->ia->eventAnalytics(
            $eventCategory,
            $eventAction,
            $eventLabel,
            $eventValue
        );
        // Get the file name
        $path = parse_url($url, PHP_URL_PATH);
        if ($analytics !== null) {
            $analytics->setDocumentPath($path)
                ->sendEvent();
        }
        $this->redirect($url, 200);
    }
}