Added an option to disable Piwik tracking

mnapoli · Sep 16, 2014 · 9ff7523 · 9ff7523
1 parent 2aa781e
commit 9ff7523
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -50,6 +50,16 @@ Don't forget to add the tracker script at the end of the HTML document, for exam
 </html>
 ```
 
+### Development environment
+
+In some environments, you want to disable Piwik's tracking (for example on your local machine).
+That is easily possible by passing `false` for the `$enabled` parameter:
+
+```php
+$twig->addExtension(new PiwikTwigExtension($host, $siteId, false));
+```
+
+
 ## License
 
 This library is released under the [MIT license](http://opensource.org/licenses/MIT).
diff --git a/src/PiwikTwigExtension.php b/src/PiwikTwigExtension.php
@@ -23,10 +23,18 @@ class PiwikTwigExtension extends Twig_Extension
      */
     private $siteId;
 
-    public function __construct($piwikHost = null, $siteId = null)
+    /**
+     * Useful for disabling Piwik tracking in dev environment.
+     *
+     * @var bool
+     */
+    private $enabled = true;
+
+    public function __construct($piwikHost = null, $siteId = null, $enabled = true)
     {
         $this->piwikHost = $piwikHost;
         $this->siteId = $siteId;
+        $this->enabled = (bool) $enabled;
     }
 
     public function getName()
@@ -45,6 +53,11 @@ public function getFunctions()
         ];
     }
 
+    /**
+     * @param string|null $piwikHost
+     * @param string|null $siteId
+     * @return string
+     */
     public function generatePiwikTrackerCode($piwikHost = null, $siteId = null)
     {
         $piwikHost = $piwikHost ?: $this->piwikHost;
@@ -57,6 +70,11 @@ public function generatePiwikTrackerCode($piwikHost = null, $siteId = null)
             throw new InvalidArgumentException('No Piwik site ID was configured or given to generate the tracker code');
         }
 
+        // Check only now so that exceptions are still thrown in dev environment
+        if (! $this->enabled) {
+            return '';
+        }
+
         $piwikHost = rtrim($piwikHost, '/');
 
         $code = <<<HTML

diff --git a/tests/DisabledExtensionFixture/EmptyFunctionCall.test b/tests/DisabledExtensionFixture/EmptyFunctionCall.test
@@ -0,0 +1,8 @@
+--TEST--
+Calling "piwik" function without parameters when the extension is disabled
+--TEMPLATE--
+{{ piwik() }}
+--DATA--
+return array();
+--EXPECT--
+Twig_Error: Twig_Error_Runtime: An exception has been thrown during the rendering of a template ("No Piwik host was configured or given to generate the tracker code") in "index.twig" at line 2 in "EmptyFunctionCall.test".
diff --git a/tests/DisabledExtensionFixture/FunctionCall.test b/tests/DisabledExtensionFixture/FunctionCall.test
@@ -0,0 +1,7 @@
+--TEST--
+Calling "piwik" function when the extension is disabled
+--TEMPLATE--
+{{ piwik('foo', 123) }}
+--DATA--
+return array();
+--EXPECT--
diff --git a/tests/DisabledExtensionTest.php b/tests/DisabledExtensionTest.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Tests\PiwikTwigExtension;
+
+use PiwikTwigExtension\PiwikTwigExtension;
+use Twig_Test_IntegrationTestCase;
+
+class DisabledExtensionTest extends Twig_Test_IntegrationTestCase
+{
+    protected function getExtensions()
+    {
+        return [
+            new PiwikTwigExtension(null, null, false),
+        ];
+    }
+
+    protected function getFixturesDir()
+    {
+        return __DIR__ . '/DisabledExtensionFixture/';
+    }
+}