add enabled option - new in 2.6.0 (#12)

* add enabled option - new in 2.6.0 * rename to sandbox * disable by default
fourlabsldn · Apr 22, 2017 · 3f6164b · 3f6164b
1 parent 607fae1
commit 3f6164b
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 3 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -33,6 +33,9 @@ public function getConfigTreeBuilder()
                 ->booleanNode('async_requests')
                     ->defaultTrue()
                 ->end()
+                ->booleanNode('sandbox')
+                    ->defaultFalse()
+                ->end()
             ->end()
         ;
 

diff --git a/README.md b/README.md
@@ -86,6 +86,7 @@ Example of configuration in `app/config.yml`:
         use_ssl: true
         anonymize_ip: false
         async_requests: true
+        sandbox: true
 
 Set your Google Analytics Tracking / Web Property ID in `tracking_id` key **[REQUIRED]**
 
@@ -127,6 +128,12 @@ To Make Async Requests, set `async_requests` to true. Default: true
 async_requests: true
 ```
 
+When sandbox mode is enabled, no hits are actually sent to GA. In this case the library returns a AnalyticsResponseInterface object that with empty values. Default: false
+
+``` yaml
+sandbox: true
+```
+
 ## To Do
 - Unit tests
 

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -19,6 +19,7 @@
             <argument>%gamp.anonymize_ip%</argument>
             <argument>%gamp.async_requests%</argument>
             <argument>%kernel.debug%</argument>
+            <argument>%gamp.sandbox%</argument>
         </service>
     </services>
 </container>
diff --git a/Service/AnalyticsFactory.php b/Service/AnalyticsFactory.php
@@ -15,12 +15,13 @@ class AnalyticsFactory
      * @param bool         $anonymize
      * @param bool         $async
      * @param bool         $debug
+     * @param bool         $sandbox
      *
      * @return Analytics
      */
-    public function createAnalytics(RequestStack $requestStack, $version, $trackingId, $ssl, $anonymize, $async, $debug)
+    public function createAnalytics(RequestStack $requestStack, $version, $trackingId, $ssl, $anonymize, $async, $debug, $sandbox)
     {
-        $analytics = new Analytics($ssl);
+        $analytics = new Analytics($ssl, $sandbox);
 
         $analytics
             ->setProtocolVersion($version)

diff --git a/composer.json b/composer.json
@@ -18,7 +18,7 @@
     ],
     "require": {
         "php": ">=5.5",
-        "theiconic/php-ga-measurement-protocol": "^2.5.1",
+        "theiconic/php-ga-measurement-protocol": "^2.6",
         "symfony/framework-bundle": "~2.4 || ~3.0"
     },
     "autoload": {