Feature: Make settings and config better for public

This removes dotenv as a depedency for development. The plugin now uses
admin settings and a config file (basically makes it more crafty).

Author: hahnzilla

FbPixelPlugin.php

@@ -5,6 +5,13 @@ class FbPixelPlugin extends BasePlugin
 {
     public function init()
     {
+        if (
+            craft()->config->get('noop', 'fbpixel') ||
+            empty($this->getPixelId())
+        ) {
+            return;
+        }
+
         craft()->fbPixel->listen();
     }
 
@@ -18,6 +25,11 @@ public function getDescription()
         return Craft::t('Integrates Facebook Pixel with Craft Commerce');
     }
 
+    public function getDocumentationUrl()
+    {
+        return 'https://github.com/moment-inc/craft-fbpixel/wiki';
+    }
+
     public function getVersion()
     {
         return '0.0.1';
@@ -32,4 +44,34 @@ public function getDeveloperUrl()
     {
         return 'http://github.com/Moment-Inc';
     }
+
+    public function getCpAlerts($path, $fetch)
+    {
+        if (empty($this->getPixelId())) {
+            return ["Enter your pixel id <a href='{$this->getSettingsUrl()}'>here</a> for fbpixel to work."];
+        }
+    }
+
+    public function getSettingsHtml()
+    {
+        return craft()->templates->render('fbpixel/settings', [
+            'settings' => $this->getSettings()
+        ]);
+    }
+
+    public function getPixelId()
+    {
+        if (!empty(craft()->config->get('pixelId', 'fbpixel'))) {
+            return craft()->config->get('pixelId', 'fbpixel');
+        }
+
+        return $this->getSettings()->pixelId;
+    }
+
+    protected function defineSettings()
+    {
+        return [
+            'pixelId' => array(AttributeType::String),
+        ];
+    }
 }

config.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * FB Pixel Configuration
+ *
+ * Completely optional configuration settings for FB Pixel if you want specific control over things.
+ *
+ * Don't edit this file, instead copy it to 'craft/config' as 'fbpixel.php' and make
+ * your changes there.
+ */
+
+return [
+    /**
+     * fbpixel will by default render on any environment. If you want to shut it off then you can override it per environment (if you have multi environment configs setup).
+     */
+    'noop' => false,
+
+    /**
+     * you have to provide a pixel id in the admin. We give you the option to override that here. Mainly, because we have a test pixel id that we use.
+     */
+    'pixelId' => '',
+];

services/FbPixelService.php

@@ -11,10 +11,6 @@ class FbPixelService extends BaseApplicationComponent
      */
     public function listen()
     {
-        if (getenv('FB_PIXEL_NOOP')) {
-            return;
-        }
-
         craft()->templates->hook('fbPixel.renderBase', [
             $this, 'renderBase'
         ]);
@@ -32,7 +28,7 @@ public function listen()
     public function renderBase()
     {
         return $this->renderTemplate('base', [
-            'fbPixelId' => getenv('FB_PIXEL_ID')
+            'fbPixelId' => craft()->plugins->getPlugin('fbpixel')->getPixelId(),
         ]);
     }
 

services/FbPixel_AddPaymentInfoService.php

@@ -7,7 +7,6 @@ class FbPixel_AddPaymentInfoService extends BaseApplicationComponent
     public function render()
     {
         $cart = craft()->commerce_cart->getCart();
-
         $eventData = [
             'value' => $cart->totalPrice,
             'currency' => 'USD',

services/FbPixel_InitiateCheckoutService.php

@@ -14,9 +14,7 @@ public function listen()
     public function render()
     {
         $cart = craft()->commerce_cart->getCart();
-
         $addPaymentInfoRaw = craft()->fbPixel_addPaymentInfo->render();
-
         $item = [
             'content_name' => 'Checkout',
             'content_ids' => array_map(function($i) { return $i->sku; }, $cart->lineItems),
@@ -26,7 +24,6 @@ public function render()
             'currency' => 'USD'
         ];
 
-
         return $addPaymentInfoRaw . craft()->fbPixel->renderEvent('InitiateCheckout', $item);
     }
 }

services/FbPixel_PurchaseService.php

@@ -29,7 +29,7 @@ public function checkFlash()
 
     public function addHook()
     {
-        craft()->templates->hook('fbPixel.renderPurchase', [
+        craft()->templates->hook('fbPixel.renderBase', [
             $this, 'renderTemplate'
         ]);
     }

services/FbPixel_ViewContentService.php

@@ -6,13 +6,15 @@ class FbPixel_ViewContentService extends BaseApplicationComponent
 {
     public function listen()
     {
-        craft()->templates->hook('fbPixel.renderViewContent', [
+        craft()->templates->hook('fbPixel.renderBase', [
             $this, 'render'
         ]);
     }
 
     public function render(&$context)
     {
-        return craft()->fbPixel->renderEvent('ViewContent', $context['fbPixelItem']);
+        if (!empty($context['fbPixelItem'])) {
+            return craft()->fbPixel->renderEvent('ViewContent', $context['fbPixelItem']);
+        }
     }
 }

templates/settings.twig

@@ -0,0 +1,9 @@
+<div class="field">
+  <div class="heading">
+    <label>Pixel ID</label>
+  </div>
+
+  <div class="input ltr">
+    <input class="text code fullwidth" type="text" name="pixelId" value="{{ settings.pixelId }}">
+  </div>
+</div>