nystudio107 / craft-instantanalytics

src/helpers/IAnalytics.php

<?php
/**
 * Instant Analytics plugin for Craft CMS
 *
 * @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>"

 * @copyright Copyright (c) 2017 nystudio107

The tag in position 2 should be the @author tag

@copyright tag must contain a year and the name of the copyright holder

 * @link      http://nystudio107.com

The tag in position 3 should be the @copyright tag

 * @package   InstantAnalytics

The tag in position 4 should be the @link tag

 * @since     1.0.0
 */

PHP version not specified

Missing @category tag in file comment

Missing @license tag in file comment

namespace nystudio107\instantanalytics\helpers;

use nystudio107\instantanalytics\InstantAnalytics;
use nystudio107\instantanalytics\models\Settings;

use Craft;

use \TheIconic\Tracking\GoogleAnalytics\Analytics;

The type \TheIconic\Tracking\GoogleAnalytics\Analytics was not found. Maybe you did not declare it correctly or list all dependencies?

use \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponseInterface;

The type \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponseInterface was not found. Maybe you did not declare it correctly or list all dependencies?

/**

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     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 IAnalytics extends Analytics
{

    protected $shouldSendAnalytics = null;

    /**

Missing short description in doc comment

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

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

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

     * @inheritdoc
     */
    public function __construct($isSsl = false, $isDisabled = false, array $options = [])
    {
        // Store whether or not we should be sending Analytics data
        $this->shouldSendAnalytics = InstantAnalytics::$settings->sendAnalyticsData;

        parent::__construct($isSsl, $isDisabled, $options);
    }

    /**
     * Turn an empty value so the twig tags {{ }} can be used
     *
     * @return string ''
     */
    public function __toString()
    {
        return '';
    }

    /**
     * Add a product impression to the Analytics object
     *
     * @param string $productVariant

Missing parameter comment

     * @param int    $index

Missing parameter comment

     * @param string $listName

Missing parameter comment

     * @param int    $listIndex

Missing parameter comment

     */

Missing @return tag in function comment

    public function addCommerceProductImpression(
        $productVariant = null,
        $index = 0,
        $listName = 'default',
        $listIndex = 1
    ) {

        if (InstantAnalytics::$commercePlugin) {
            if ($productVariant) {
                InstantAnalytics::$plugin->commerce->addCommerceProductImpression(
                    $this,
                    $productVariant,

$productVariant of type string is incompatible with the type craft\commerce\elements\Product|craft\commerce\elements\Variant expected by parameter $productVariant of nystudio107\instantanalytics\services\Commerce::addCommerceProductImpression().

                    $index,
                    $listName,
                    $listIndex
                );
            }
        } else {
            Craft::warning(
                Craft::t(
                    'instant-analytics',
                    'Craft Commerce is not installed'
                ),
                __METHOD__
            );
        }
    }

    /**
     * Add a product detail view to the Analytics object
     *
     * @param string $productVariant

Missing parameter comment

     */

Missing @return tag in function comment

    public function addCommerceProductDetailView($productVariant = null)
    {
        if (InstantAnalytics::$commercePlugin) {
            if ($productVariant) {
                InstantAnalytics::$plugin->commerce->addCommerceProductDetailView($this, $productVariant);

$productVariant of type string is incompatible with the type craft\commerce\elements\Product|craft\commerce\elements\Variant expected by parameter $productVariant of nystudio107\instantanalytics\services\Commerce::addCommerceProductDetailView().

            }
        } else {
            Craft::warning(
                Craft::t(
                    'instant-analytics',
                    'Craft Commerce is not installed'
                ),
                __METHOD__
            );
        }
    }

    /**
     * Add a checkout step to the Analytics object
     *
     * @param        $orderModel

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

Missing parameter comment

     * @param int    $step

Missing parameter comment

     * @param string $option

Missing parameter comment

     */

Missing @return tag in function comment

    public function addCommerceCheckoutStep($orderModel = null, $step = 1, $option = "")
    {
        if (InstantAnalytics::$commercePlugin) {
            if ($orderModel) {
                InstantAnalytics::$plugin->commerce->addCommerceCheckoutStep($this, $orderModel, $step, $option);
            }
        } else {
            Craft::warning(
                Craft::t(
                    'instant-analytics',
                    'Craft Commerce is not installed'
                ),
                __METHOD__
            );
        }
    }

    /**
     * Override sendHit() so that we can prevent Analytics data from being sent
     *
     * @param $methodName

Missing parameter comment

     *
     * @return AnalyticsResponseInterface|null
     */
    protected function sendHit($methodName)
    {
        $requestIp = $_SERVER['REMOTE_ADDR'];
        if ($this->shouldSendAnalytics) {
            if ($this->getClientId() !== null || $this->getUserId() !== null) {
                try {
                    Craft::info(
                        'Send hit for IAnalytics object: ' . print_r($this, true),

Are you sure print_r($this, true) of type string|true can be used in concatenation?

                        __METHOD__
                    );

                    return parent::sendHit($methodName);
                } catch (\Exception $e) {
                    if (InstantAnalytics::$settings->logExcludedAnalytics) {
                        Craft::info(
                            '*** sendHit(): error sending analytics: ' . $e->getMessage(),
                            __METHOD__
                        );
                    }
                }
            } elseif (InstantAnalytics::$settings->logExcludedAnalytics) {
                Craft::info(
                    '*** sendHit(): analytics not sent for '.$requestIp. ' because no clientId or userId is set',
                    __METHOD__
                );
            }
        } elseif (InstantAnalytics::$settings->logExcludedAnalytics) {
            Craft::info(
                '*** sendHit(): analytics not sent for '.$requestIp,
                __METHOD__
            );
        }

        return null;
    }
}