nystudio107 / craft-instantanalytics

src/InstantAnalytics.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;

use Craft;
use craft\base\Plugin;
use craft\commerce\elements\Order;

The type craft\commerce\elements\Order was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\commerce\events\LineItemEvent;

The type craft\commerce\events\LineItemEvent was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\commerce\Plugin as Commerce;

The type craft\commerce\Plugin was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\events\PluginEvent;
use craft\events\RegisterUrlRulesEvent;
use craft\events\TemplateEvent;
use craft\helpers\UrlHelper;
use craft\services\Plugins;
use craft\web\twig\variables\CraftVariable;
use craft\web\UrlManager;
use craft\web\View;
use nystudio107\instantanalytics\helpers\Field as FieldHelper;
use nystudio107\instantanalytics\helpers\IAnalytics;
use nystudio107\instantanalytics\models\Settings;
use nystudio107\instantanalytics\services\ServicesTrait;
use nystudio107\instantanalytics\twigextensions\InstantAnalyticsTwigExtension;
use nystudio107\instantanalytics\variables\InstantAnalyticsVariable;
use nystudio107\seomatic\Seomatic;

The type nystudio107\seomatic\Seomatic was not found. Maybe you did not declare it correctly or list all dependencies?

use Twig\Error\LoaderError;
use yii\base\Event;

/** @noinspection MissingPropertyAnnotationsInspection */

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

 * @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 InstantAnalytics extends Plugin
{
    // Traits
    // =========================================================================

    use ServicesTrait;

    // Constants
    // =========================================================================

    const COMMERCE_PLUGIN_HANDLE = 'commerce';
    const SEOMATIC_PLUGIN_HANDLE = 'seomatic';

    // Static Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var InstantAnalytics
     */
    public static $plugin;

    /**

Missing short description in doc comment

     * @var Settings
     */
    public static $settings;

    /**

Missing short description in doc comment

     * @var Commerce|null
     */
    public static $commercePlugin;

    /**

Missing short description in doc comment

     * @var Seomatic|null
     */
    public static $seomaticPlugin;

    /**

Missing short description in doc comment

     * @var string
     */
    public static $currentTemplate = '';

    /**

Missing short description in doc comment

     * @var bool
     */
    public static $pageViewSent = false;

    /**

Missing short description in doc comment

     * @var bool
     */
    public static $craft31 = false;

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string
     */
    public $schemaVersion = '1.0.0';

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSection = false;

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSettings = true;

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
        self::$plugin = $this;
        self::$settings = $this->getSettings();
        self::$craft31 = version_compare(Craft::$app->getVersion(), '3.1', '>=');

It seems like version_compare(Craft::app->getVersion(), '3.1', '>=') can also be of type integer. However, the property $craft31 is declared as type boolean. Maybe add an additional type check?

        // Determine if Craft Commerce is installed & enabled
        self::$commercePlugin = Craft::$app->getPlugins()->getPlugin(self::COMMERCE_PLUGIN_HANDLE);
        // Determine if SEOmatic is installed & enabled
        self::$seomaticPlugin = Craft::$app->getPlugins()->getPlugin(self::SEOMATIC_PLUGIN_HANDLE);
        // Add in our Craft components
        $this->addComponents();
        // Install our global event handlers
        $this->installEventListeners();

        Craft::info(
            Craft::t(
                'instant-analytics',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function settingsHtml()
    {
        $commerceFields = [];

        if (self::$commercePlugin) {
            $productTypes = self::$commercePlugin->getProductTypes()->getAllProductTypes();

            foreach ($productTypes as $productType) {
                $productFields = $this->getPullFieldsFromLayoutId($productType->fieldLayoutId);
                /** @noinspection SlowArrayOperationsInLoopInspection */

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

                $commerceFields = \array_merge($commerceFields, $productFields);
                if ($productType->hasVariants) {
                    $variantFields = $this->getPullFieldsFromLayoutId($productType->variantFieldLayoutId);
                    /** @noinspection SlowArrayOperationsInLoopInspection */

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

                    $commerceFields = \array_merge($commerceFields, $variantFields);
                }
            }
        }

        // Rend the settings template
        try {
            return Craft::$app->getView()->renderTemplate(
                'instant-analytics/settings',
                [
                    'settings' => $this->getSettings(),
                    'commerceFields' => $commerceFields,
                ]
            );
        } catch (LoaderError $e) {
            Craft::error($e->getMessage(), __METHOD__);
        } catch (\Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return '';
    }

    /**

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

     * Handle the `{% hook iaSendPageView %}`
     *
     * @param array &$context

Missing parameter comment

Doc comment for parameter &$context does not match actual variable name $context

     *
     * @return string|null
     */
    public function iaSendPageView(/** @noinspection PhpUnusedParameterInspection */ array &$context)

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

    {
        $this->sendPageView();

        return '';
    }

    // Protected Methods
    // =========================================================================

    /**
     * Add in our Craft components
     */

Missing @return tag in function comment

    protected function addComponents()
    {
        $view = Craft::$app->getView();
        // Add in our Twig extensions
        $view->registerTwigExtension(new InstantAnalyticsTwigExtension());
        // Install our template hook
        $view->hook('iaSendPageView', [$this, 'iaSendPageView']);
        // Register our variables
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function (Event $event) {
                /** @var CraftVariable $variable */

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

                $variable = $event->sender;
                $variable->set('instantAnalytics', [

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

                    'class' => InstantAnalyticsVariable::class,
                    'viteService' => $this->vite,
                ]);

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

            }
        );
    }

    /**
     * Install our event listeners
     */

Missing @return tag in function comment

    protected function installEventListeners()
    {
        // Handler: Plugins::EVENT_AFTER_INSTALL_PLUGIN
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_INSTALL_PLUGIN,
            function (PluginEvent $event) {
                if ($event->plugin === $this) {
                    $request = Craft::$app->getRequest();
                    if ($request->isCpRequest) {
                        Craft::$app->getResponse()->redirect(UrlHelper::cpUrl('instant-analytics/welcome'))->send();
                    }
                }
            }
        );
        $request = Craft::$app->getRequest();
        // Install only for non-console site requests
        if ($request->getIsSiteRequest() && !$request->getIsConsoleRequest()) {
            $this->installSiteEventListeners();
        }
        // Install only for non-console Control Panel requests
        if ($request->getIsCpRequest() && !$request->getIsConsoleRequest()) {
            $this->installCpEventListeners();
        }
    }

    /**
     * Install site event listeners for site requests only
     */

Missing @return tag in function comment

    protected function installSiteEventListeners()
    {
        // Handler: UrlManager::EVENT_REGISTER_SITE_URL_RULES
        Event::on(
            UrlManager::class,
            UrlManager::EVENT_REGISTER_SITE_URL_RULES,
            function (RegisterUrlRulesEvent $event) {
                Craft::debug(
                    'UrlManager::EVENT_REGISTER_SITE_URL_RULES',
                    __METHOD__
                );
                // Register our Control Panel routes
                $event->rules = array_merge(
                    $event->rules,
                    $this->customFrontendRoutes()
                );
            }
        );
        // Remember the name of the currently rendering template
        Event::on(
            View::class,
            View::EVENT_BEFORE_RENDER_PAGE_TEMPLATE,
            function (TemplateEvent $event) {
                self::$currentTemplate = $event->template;
            }
        );
        // Remember the name of the currently rendering template
        Event::on(
            View::class,
            View::EVENT_AFTER_RENDER_PAGE_TEMPLATE,
            function (TemplateEvent $event) {

The parameter $event is not used and could be removed.

                if (self::$settings->autoSendPageView) {
                    $this->sendPageView();
                }
            }
        );
        // Commerce-specific hooks
        if (self::$commercePlugin) {
            Event::on(Order::class, Order::EVENT_AFTER_COMPLETE_ORDER, function (Event $e) {

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

                $order = $e->sender;
                if (self::$settings->autoSendPurchaseComplete) {
                    $this->commerce->orderComplete($order);
                }
            });

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

            Event::on(Order::class, Order::EVENT_AFTER_ADD_LINE_ITEM, function (LineItemEvent $e) {

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

                $lineItem = $e->lineItem;
                if (self::$settings->autoSendAddToCart) {
                    $this->commerce->addToCart($lineItem->order, $lineItem);
                }
            });

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

            // Check to make sure Order::EVENT_AFTER_REMOVE_LINE_ITEM is defined
            if (defined(Order::class . '::EVENT_AFTER_REMOVE_LINE_ITEM')) {
                Event::on(Order::class, Order::EVENT_AFTER_REMOVE_LINE_ITEM, function (LineItemEvent $e) {

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

                    $lineItem = $e->lineItem;
                    if (self::$settings->autoSendRemoveFromCart) {
                        $this->commerce->removeFromCart($lineItem->order, $lineItem);
                    }
                });

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

            }
        }
    }

    /**
     * Install site event listeners for Control Panel requests only
     */

Missing @return tag in function comment

    protected function installCpEventListeners()
    {
    }

    /**
     * Return the custom frontend routes
     *
     * @return array
     */
    protected function customFrontendRoutes(): array
    {
        return [
            'instantanalytics/pageViewTrack/<filename:[-\w\.*]+>?' =>
                'instant-analytics/track/track-page-view-url',
            'instantanalytics/eventTrack/<filename:[-\w\.*]+>?' =>
                'instant-analytics/track/track-event-url',
        ];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function createSettingsModel()
    {
        return new Settings();
    }

    // Private Methods
    // =========================================================================

    /**
     * Send a page view with the pre-loaded IAnalytics object
     */

Missing @return tag in function comment

    private function sendPageView()

Private method name "InstantAnalytics::sendPageView" must be prefixed with an underscore

    {
        $request = Craft::$app->getRequest();
        if ($request->getIsSiteRequest() && !$request->getIsConsoleRequest() && !self::$pageViewSent) {
            self::$pageViewSent = true;
            /** @var IAnalytics $analytics */

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

            $analytics = self::$plugin->ia->getGlobals(self::$currentTemplate);
            // Bail if we have no analytics object
            if ($analytics === null) {
                return;
            }
            // If SEOmatic is installed, set the page title from it
            $this->setTitleFromSeomatic($analytics);
            // Send the page view
            $response = $analytics->sendPageview();
            Craft::info(
                Craft::t(
                    'instant-analytics',
                    'pageView sent, response:: {response}',
                    [
                        'response' => print_r($response, true),
                    ]
                ),
                __METHOD__
            );
        } else {
            Craft::error(
                Craft::t(
                    'instant-analytics',
                    'Analytics not sent because googleAnalyticsTracking is not set'
                ),
                __METHOD__
            );
        }
    }

    /**
     * If SEOmatic is installed, set the page title from it
     *
     * @param $analytics

Missing parameter comment

     */

Missing @return tag in function comment

    private function setTitleFromSeomatic(IAnalytics $analytics)

Private method name "InstantAnalytics::setTitleFromSeomatic" must be prefixed with an underscore

    {
        if (self::$seomaticPlugin && Seomatic::$settings->renderEnabled) {
            $titleTag = Seomatic::$plugin->title->get('title');
            if ($titleTag) {
                $titleArray = $titleTag->renderAttributes();
                if (!empty($titleArray['title'])) {
                    $analytics->setDocumentTitle($titleArray['title']);
                }
            }
        }
    }

    /**

Missing short description in doc comment

     * @param $layoutId

Missing parameter comment

     *
     * @return array
     */
    private function getPullFieldsFromLayoutId($layoutId): array

Private method name "InstantAnalytics::getPullFieldsFromLayoutId" must be prefixed with an underscore

    {
        $result = ['' => 'none'];
        if ($layoutId === null) {
            return $result;
        }
        $fieldLayout = Craft::$app->getFields()->getLayoutById($layoutId);
        if ($fieldLayout) {
            $result = FieldHelper::fieldsOfTypeFromLayout(FieldHelper::TEXT_FIELD_CLASS_KEY, $fieldLayout, false);
        }

        return $result;
    }
}