Merge pull request #72 from matks/allow-dont-track-back-office

Add Configuration option to disable Back Office tracking

Author: Progi1984

classes/Form/ConfigurationForm.php

@@ -127,6 +127,24 @@ public function generate()
                         ],
                     ],
                 ],
+                [
+                    'type' => 'switch',
+                    'label' => $this->module->l('Disable Back Office Tracking'),
+                    'name' => 'GA_TRACK_BACKOFFICE_DISABLED',
+                    'hint' => $this->module->l('Use this option to disable the tracking inside the Back Office'),
+                    'values' => [
+                        [
+                            'id' => 'ga_track_backoffice',
+                            'value' => 1,
+                            'label' => $this->module->l('Enabled'),
+                        ],
+                        [
+                            'id' => 'ga_do_not_track_backoffice',
+                            'value' => 0,
+                            'label' => $this->module->l('Disabled'),
+                        ],
+                    ],
+                ],
             ],
             'submit' => [
                 'title' => $this->module->l('Save'),
@@ -158,6 +176,7 @@ public function generate()
         $helper->fields_value['GA_USERID_ENABLED'] = Configuration::get('GA_USERID_ENABLED');
         $helper->fields_value['GA_CROSSDOMAIN_ENABLED'] = Configuration::get('GA_CROSSDOMAIN_ENABLED');
         $helper->fields_value['GA_ANONYMIZE_ENABLED'] = Configuration::get('GA_ANONYMIZE_ENABLED');
+        $helper->fields_value['GA_TRACK_BACKOFFICE_DISABLED'] = Configuration::get('GA_TRACK_BACKOFFICE_DISABLED');
 
         return $helper->generateForm($fields_form);
     }
@@ -174,6 +193,7 @@ public function treat()
         $gaUserIdEnabled = Tools::getValue('GA_USERID_ENABLED');
         $gaCrossdomainEnabled = Tools::getValue('GA_CROSSDOMAIN_ENABLED');
         $gaAnonymizeEnabled = Tools::getValue('GA_ANONYMIZE_ENABLED');
+        $gaTrackBackOffice = Tools::getValue('GA_TRACK_BACKOFFICE_DISABLED');
 
         if (!empty($gaAccountId)) {
             Configuration::updateValue('GA_ACCOUNT_ID', $gaAccountId);
@@ -196,6 +216,11 @@ public function treat()
             $treatmentResult .= $this->module->displayConfirmation($this->module->l('Settings for Anonymize IP updated successfully'));
         }
 
+        if (null !== $gaTrackBackOffice) {
+            Configuration::updateValue('GA_TRACK_BACKOFFICE_DISABLED', (bool) $gaTrackBackOffice);
+            $treatmentResult .= $this->module->displayConfirmation($this->module->l('Settings for Disable Back Office tracking updated successfully'));
+        }
+
         return $treatmentResult;
     }
 }

classes/Hook/HookDisplayBackOfficeHeader.php

@@ -48,6 +48,10 @@ public function __construct(Ps_Googleanalytics $module, Context $context)
      */
     public function run()
     {
+        if (Configuration::get('GA_TRACK_BACKOFFICE_DISABLED')) {
+            return '';
+        }
+
         $js = '';
         if (strcmp(Tools::getValue('configure'), $this->module->name) === 0) {
             $this->context->controller->addCSS($this->module->getPathUri() . 'views/css/ganalytics.css');

classes/Hook/HookDisplayHeader.php

@@ -47,7 +47,11 @@ public function __construct(Ps_Googleanalytics $module, Context $context)
     public function run()
     {
         if (!Configuration::get('GA_ACCOUNT_ID')) {
-            return;
+            return '';
+        }
+
+        if (Configuration::get('GA_TRACK_BACKOFFICE_DISABLED') && $this->backOffice) {
+            return '';
         }
 
         $this->context->controller->addJs($this->module->getPathUri() . 'views/js/GoogleAnalyticActionLib.js');