nystudio107\instantanalytics\InstantAnalytics

Complexity

Total Complexity

30

Size/Duplication

Total Lines	313
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	installCpEventListeners()	0	2	1
A	createSettingsModel()	0	3	1
A	setTitleFromSeomatic()	0	8	5
A	iaSendPageView()	0	5	1
B	installEventListeners()	0	23	7
A	init()	0	21	1
A	addComponents()	0	15	1
A	installSiteEventListeners()	0	50	3
A	settingsHtml()	0	35	4
A	sendPageView()	0	29	5
A	customFrontendRoutes()	0	5	1

<?php
/**
 * Instant Analytics plugin for Craft CMS 3.x
 *
 * 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 nystudio107\instantanalytics\helpers\IAnalytics;
use nystudio107\instantanalytics\helpers\Field as FieldHelper;
use nystudio107\instantanalytics\models\Settings;
use nystudio107\instantanalytics\services\Commerce as CommerceService;
use nystudio107\instantanalytics\services\IA as IAService;
use nystudio107\instantanalytics\variables\InstantAnalyticsVariable;
use nystudio107\instantanalytics\twigextensions\InstantAnalyticsTwigExtension;

use Craft;
use craft\base\Plugin;
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\seomatic\Seomatic;

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

use yii\base\Event;
use yii\base\Exception;

/** @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 indented incorrectly; expected 2 spaces but found 4

 * @package   InstantAnalytics

Tag value indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value indented incorrectly; expected 3 spaces but found 5

 *
 * @property  IAService       $ia

Tag value indented incorrectly; expected 1 spaces but found 2

 * @property  CommerceService $commerce

Tag value indented incorrectly; expected 1 spaces but found 2

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class InstantAnalytics extends Plugin
{
    // 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 Plugin|null
     */
    public static $commercePlugin;

    /**

Missing short description in doc comment

     * @var Plugin|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;

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
        self::$plugin = $this;

        // 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) {
            /**
             * TODO: pending Commerce for Craft 3
             * $productTypes = craft()->commerce_productTypes->getAllProductTypes();
             * foreach ($productTypes as $productType) {
             * $productFields = $this->_getPullFieldsFromLayoutId($productType->fieldLayoutId);
             * $commerceFields = array_merge($commerceFields, $productFields);
             * if ($productType->hasVariants) {
             * $variantFields = $this->_getPullFieldsFromLayoutId($productType->variantFieldLayoutId);
             * $commerceFields = array_merge($commerceFields, $variantFields);
             * }
             * }
             */
        }

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

        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', InstantAnalyticsVariable::class);
            }
        );
    }

    /**
     * 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 AdminCP 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 AdminCP 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) {
                $settings = InstantAnalytics::$plugin->getSettings();
                if ($settings->autoSendPageView) {
                    $this->sendPageView();
                }
            }
        );
        // Register our site routes
        Event::on(
            UrlManager::class,
            UrlManager::EVENT_REGISTER_SITE_URL_RULES,
            function (RegisterUrlRulesEvent $event) {
                $event->rules['instantanalytics/pageViewTrack/<filename:[-\w\.*]+>?'] =

Multi-line assignments must have the equal sign on the second line

                    'instant-analytics/track/track-page-view-url';
                $event->rules['instantanalytics/eventTrack/<filename:[-\w\.*]+>?'] =

Multi-line assignments must have the equal sign on the second line

                    'instant-analytics/track/track-event-url';
            }
        );
        // Commerce-specific hooks
        if (self::$commercePlugin) {
            // TODO: pending Commerce for Craft 3
        }
    }

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

Missing @return tag in function comment

    protected function installCpEventListeners()
    {
    }

    /**
     * Return the custom frontend routes
     *
     * @return array
     */
    protected function customFrontendRoutes(): array
    {
        return [
            // Make webpack async bundle loading work out of published AssetBundles
            '/cpresources/instant-analytics/<resourceType:{handle}>/<fileName>' => 'instant-analytics/cp-nav/resource',
        ];
    }

    /**

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 = InstantAnalytics::$plugin->ia->getGlobals(self::$currentTemplate);
            // If SEOmatic is installed, set the page title from it
            $this->setTitleFromSeomatic($analytics);
            // Send the page view
            if ($analytics) {

$analytics is of type nystudio107\instantanalytics\helpers\IAnalytics, thus it always evaluated to true. If $analytics can have other possible types, add them to src/InstantAnalytics.php:304

                $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__
                );
            }
        }
    }

    /**

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

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

Missing parameter comment

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

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

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

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 '';
    }

    /**

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

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

Missing parameter name

     */

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']);
                }
            }
        }
    }
}