InstantAnalytics::sendPageView() - Code Metrics - Inspection of "Implement Commerce tracking" - nystudio107/craft-instantanalytics - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#4)

unknown

created 2018-11-16 05:32 UTC

InstantAnalytics::sendPageView() B

↳ Parent: InstantAnalytics

Complexity

Conditions	6
Paths	4

Size

Total Lines	33
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	21
dl	0
loc	33
rs	8.9617
c	0
b	0
f	0
cc	6
nc	4
nop	0

<?php
/**
 * Instant Analytics plugin for Craft CMS 3.x
 *
 * Instant Analytics brings full Google Analytics support to your Twig templates
 *
 * @link      https://nystudio107.com

 * @copyright Copyright (c) 2017 nystudio107

 */


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\fields\Categories;
use craft\fields\PlainText;
use craft\fields\RichText;
filter:
    dependency_paths: ["lib/*"]
use craft\fields\Redactor;
filter:
    dependency_paths: ["lib/*"]
use craft\fields\Tags;
use craft\helpers\UrlHelper;
use craft\services\Plugins;
use craft\web\twig\variables\CraftVariable;
use craft\web\UrlManager;
use craft\web\View;

use craft\commerce\Plugin as Commerce;
filter:
    dependency_paths: ["lib/*"]
use craft\commerce\elements\Order;
filter:
    dependency_paths: ["lib/*"]

use nystudio107\seomatic\Seomatic;
filter:
    dependency_paths: ["lib/*"]

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

/** @noinspection MissingPropertyAnnotationsInspection */


/**

 * @author    nystudio107

 * @package   InstantAnalytics

 * @since     1.0.0

 *
 * @property  IAService       $ia

 * @property  CommerceService $commerce

 */

class InstantAnalytics extends Plugin
{
    // Constants
    // =========================================================================

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

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

    /**

     * @var InstantAnalytics
     */
    public static $plugin;

    /**

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

    /**

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

    /**

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

    /**

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

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

    /**

     * @inheritdoc
     */

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

    /**

     * @inheritdoc
     */

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

        if (self::$commercePlugin) {
             $productTypes = Commerce::getInstance()->getProductTypes()->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 '';
    }

    /**

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

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

    {
        $this->sendPageView();

        return '';
    }

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

    /**
     * Add in our Craft components
     */

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

                $variable = $event->sender;
                $variable->set('instantAnalytics', InstantAnalyticsVariable::class);
            }
        );
    }

    /**
     * Install our event listeners
     */

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

    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();
                }
            }
        );
        // Commerce-specific hooks
        if (self::$commercePlugin) {

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

                $order = $e->sender;
                $settings = InstantAnalytics::$plugin->getSettings();

                if ($settings->autoSendPurchaseComplete) {
                    $this->commerce->orderComplete($order);
                }
            });
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.

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

                $lineItem = $e->lineItem;

                $settings = InstantAnalytics::$plugin->getSettings();
                
                if ($settings->autoSendAddToCart) {
                    $this->commerce->addToCart($lineItem->order, $lineItem);
                }
            });
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.

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

                $lineItem = $e->lineItem;

                $settings = InstantAnalytics::$plugin->getSettings();
                
                if ($settings->autoSendRemoveFromCart) {
                    $this->commerce->removeFromCart($lineItem->order, $lineItem);
                }
            });
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        }
    }

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

    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',
        // Make webpack async bundle loading work out of published AssetBundles
            '/cpresources/instant-analytics/<resourceType:{handle}>/<fileName>' => 'instant-analytics/manifest/resource',
        ];
    }

    /**

     * @inheritdoc
     */

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

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

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

    private function sendPageView()

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

            $analytics = InstantAnalytics::$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
            if ($analytics) {

                $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

     */

    private function setTitleFromSeomatic(IAnalytics $analytics)

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

    /**

     * @return array
     */
    private function _getPullFieldsFromLayoutId($layoutId)
    {
        $result = ['' => "none"];
        $fieldLayout = Craft::$app->getFields()->getLayoutById($layoutId);
        $fieldLayoutFields = $fieldLayout->getFields();
        
        foreach ($fieldLayoutFields as $field) {            
            switch (get_class($field)) {
                case PlainText::class:

                case RichText::class:

                case Redactor::class:

                case Categories::class:

                    $result[$field->handle] = $field->name;
                    break;
                case Tags::class:

                    break;
            }
        }

        return $result;
    }
}


1			<?php
2			/**
3			* Instant Analytics plugin for Craft CMS 3.x
4			*
5			* Instant Analytics brings full Google Analytics support to your Twig templates
6			*
7			* @link https://nystudio107.com
			0 ignored issues – show Coding Style introduced 2018-08-24 05:03 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
8			* @copyright Copyright (c) 2017 nystudio107
			0 ignored issues – show Coding Style introduced 2018-08-24 05:03 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
9			*/
			0 ignored issues – show Coding Style introduced 2018-08-24 05:03 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2018-08-24 05:03 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2018-08-24 05:03 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2018-08-24 05:03 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2018-08-24 05:03 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
10
11			namespace nystudio107\instantanalytics;
12
13			use nystudio107\instantanalytics\helpers\IAnalytics;
14			use nystudio107\instantanalytics\helpers\Field as FieldHelper;
15			use nystudio107\instantanalytics\models\Settings;
16			use nystudio107\instantanalytics\services\Commerce as CommerceService;
17			use nystudio107\instantanalytics\services\IA as IAService;
18			use nystudio107\instantanalytics\variables\InstantAnalyticsVariable;
19			use nystudio107\instantanalytics\twigextensions\InstantAnalyticsTwigExtension;
20
21			use Craft;
22			use craft\base\Plugin;
23			use craft\events\PluginEvent;
24			use craft\events\RegisterUrlRulesEvent;
25			use craft\events\TemplateEvent;
26			use craft\fields\Categories;
27			use craft\fields\PlainText;
28			use craft\fields\RichText;
			0 ignored issues – show Bug introduced 2018-11-16 04:39 UTC by Report Bug Copy Issue Report The type `craft\fields\RichText` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
29			use craft\fields\Redactor;
			0 ignored issues – show Bug introduced 2018-11-16 04:39 UTC by Report Bug Copy Issue Report The type `craft\fields\Redactor` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
30			use craft\fields\Tags;
31			use craft\helpers\UrlHelper;
32			use craft\services\Plugins;
33			use craft\web\twig\variables\CraftVariable;
34			use craft\web\UrlManager;
35			use craft\web\View;

nystudio107 / craft-instantanalytics

Pull Request — develop (#4)

InstantAnalytics::sendPageView() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like