nystudio107 / craft-instantanalytics-ga4

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\instantanalyticsGa4;

use Craft;
use craft\base\Model;
use craft\base\Plugin;
use craft\commerce\elements\Order;
use craft\commerce\events\LineItemEvent;
use craft\commerce\Plugin as Commerce;
use craft\events\PluginEvent;
use craft\events\RegisterUrlRulesEvent;
use craft\events\TemplateEvent;
use craft\helpers\App;
use craft\helpers\UrlHelper;
use craft\services\Plugins;
use craft\web\twig\variables\CraftVariable;
use craft\web\UrlManager;
use craft\web\View;
use Exception;
use nystudio107\instantanalyticsGa4\helpers\Analytics;
use nystudio107\instantanalyticsGa4\helpers\Field as FieldHelper;
use nystudio107\instantanalyticsGa4\models\Settings;
use nystudio107\instantanalyticsGa4\services\ServicesTrait;
use nystudio107\instantanalyticsGa4\twigextensions\InstantAnalyticsTwigExtension;
use nystudio107\instantanalyticsGa4\variables\InstantAnalyticsVariable;
use nystudio107\seomatic\Seomatic;
use yii\base\Event;
use yii\web\Response;
use function array_merge;

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

    /**

Missing short description in doc comment

     * @var string
     */
    protected const COMMERCE_PLUGIN_HANDLE = 'commerce';

    /**

Missing short description in doc comment

     * @var string
     */
    protected const SEOMATIC_PLUGIN_HANDLE = 'seomatic';

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

    /**

Missing short description in doc comment

     * @var null|InstantAnalytics
     */
    public static ?InstantAnalytics $plugin = null;

    /**

Missing short description in doc comment

     * @var null|Settings
     */
    public static ?Settings $settings = null;

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        parent::init();
        self::$plugin = $this;
        /** @var Settings $settings */

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

        $settings = $this->getSettings();
        self::$settings = $settings;

        // Add in our Craft components
        $this->addComponents();
        // Install our global event handlers
        $this->installEventListeners();

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

    /**

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

     * Handle the `{% hook iaSendPageView %}`
     */

Missing @return tag in function comment

    public function iaSendPageView(/** @noinspection PhpUnusedParameterInspection */ array &$context = []): string

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->ga4->addPageViewEvent();
        return '';
    }

    /**

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

     * Handle the `{% hook iaInsertGtag %}`
     */

Missing @return tag in function comment

    public function iaInsertGtag(/** @noinspection PhpUnusedParameterInspection */ array &$context = []): string

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

    {
        $config = [];

        if (self::$settings->sendUserId) {
            $userId = Analytics::getUserId();
            if (!empty($userId)) {
                $config['user_id'] = $userId;
            }
        }

        $measurementId = App::parseEnv(self::$settings->googleAnalyticsMeasurementId);


        $view = Craft::$app->getView();
        $existingMode = $view->getTemplateMode();
        $view->setTemplateMode(View::TEMPLATE_MODE_CP);
        $content = $view->renderTemplate('instant-analytics-ga4/_includes/gtag', compact('measurementId', 'config'));
        $view->setTemplateMode($existingMode);

        return $content;
    }

    public function logAnalyticsEvent(string $message, array $variables = [], string $category = ''): void

Missing doc comment for function logAnalyticsEvent()

    {
        Craft::info(
            Craft::t('instant-analytics-ga4', $message, $variables),
            $category
        );
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function settingsHtml(): ?string
    {
        $commerceFields = [];

        if (self::$commercePlugin !== null) {
            $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->maxVariants > 1) {
                    $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-ga4/settings',
                [
                    'settings' => $this->getSettings(),
                    'commerceFields' => $commerceFields,
                ]
            );
        } catch (Exception $exception) {
            Craft::error($exception->getMessage(), __METHOD__);
        }

        return '';
    }
    // Protected Methods
    // =========================================================================

    /**
     * Add in our Craft components
     */

Missing @return tag in function comment

    protected function addComponents(): void
    {
        $view = Craft::$app->getView();
        // Add in our Twig extensions
        $view->registerTwigExtension(new InstantAnalyticsTwigExtension());
        // Install our template hooks
        $view->hook('iaSendPageView', [$this, 'iaSendPageView']);
        $view->hook('iaInsertGtag', [$this, 'iaInsertGtag']);

        // Register our variables
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function(Event $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                /** @var CraftVariable $variable */

Missing short description in doc comment

The open comment tag must be the only content on the line

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(): void
    {
        // Handler: Plugins::EVENT_AFTER_INSTALL_PLUGIN
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_INSTALL_PLUGIN,
            function(PluginEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                if ($event->plugin === $this) {
                    $request = Craft::$app->getRequest();
                    if ($request->isCpRequest) {
                        Craft::$app->getResponse()->redirect(UrlHelper::cpUrl('instant-analytics-ga4/welcome'))->send();
                    }
                }
            }
        );

        // Handler: Plugins::EVENT_AFTER_LOAD_PLUGINS
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_LOAD_PLUGINS,
            function() {

Expected 1 space after FUNCTION keyword; 0 found

                // Determine if Craft Commerce is installed & enabled
                /** @var Commerce $commercePlugin */

Missing short description in doc comment

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

                $commercePlugin = Craft::$app->getPlugins()->getPlugin(self::COMMERCE_PLUGIN_HANDLE);
                self::$commercePlugin = $commercePlugin;
                // Determine if SEOmatic is installed & enabled
                /** @var Seomatic $seomaticPlugin */

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

                $seomaticPlugin = Craft::$app->getPlugins()->getPlugin(self::SEOMATIC_PLUGIN_HANDLE);
                self::$seomaticPlugin = $seomaticPlugin;

                // Make sure to install these only after we definitely know whether other plugins are installed
                $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(): void
    {
        // Handler: UrlManager::EVENT_REGISTER_SITE_URL_RULES
        Event::on(
            UrlManager::class,
            UrlManager::EVENT_REGISTER_SITE_URL_RULES,
            function(RegisterUrlRulesEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                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,
            static function(TemplateEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                self::$currentTemplate = $event->template;
            }
        );
        // Send the page-view event.
        Event::on(
            View::class,
            View::EVENT_AFTER_RENDER_PAGE_TEMPLATE,
            function(TemplateEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                if (self::$settings->autoSendPageView) {
                    $request = Craft::$app->getRequest();
                    if (!$request->getIsAjax()) {
                        $this->ga4->addPageViewEvent();
                    }
                }
            }
        );

        // Send the collected events
        Event::on(
            Response::class,
            Response::EVENT_BEFORE_SEND,
            function(Event $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                // Initialize this sooner rather than later, since it's possible this will want to tinker with cookies
                $this->ga4->getAnalytics();
            }
        );

        // Send the collected events
        Event::on(
            Response::class,
            Response::EVENT_AFTER_SEND,
            function(Event $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                $this->ga4->getAnalytics()->sendCollectedEvents();
            }
        );

        // Commerce-specific hooks
        if (self::$commercePlugin !== null) {
            Event::on(Order::class, Order::EVENT_AFTER_COMPLETE_ORDER, function(Event $e): void {

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

Expected 1 space after FUNCTION keyword; 0 found

                $order = $e->sender;
                if (self::$settings->autoSendPurchaseComplete) {
                    $this->commerce->triggerOrderCompleteEvent($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): void {

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

Expected 1 space after FUNCTION keyword; 0 found

                $lineItem = $e->lineItem;
                if (self::$settings->autoSendAddToCart) {
                    $this->commerce->triggerAddToCartEvent($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): void {

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

Expected 1 space after FUNCTION keyword; 0 found

                    $lineItem = $e->lineItem;
                    if (self::$settings->autoSendRemoveFromCart) {
                        $this->commerce->triggerRemoveFromCartEvent($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(): void
    {
    }

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function createSettingsModel(): ?Model
    {
        return new Settings();
    }

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

    /**

Missing short description in doc comment

     * @param $layoutId

Missing parameter comment

     *
     * @return mixed[]|array<string, string>
     */
    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;
    }
}