Adding Analytics Support

README.md

@@ -34,6 +34,7 @@ SEO Helper is a package that provides tools and helpers for SEO (Search Engine O
   * Framework agnostic package.
   * Open Graph & Twitter Cards are supported.
   * Webmaster tools site verifier tags are supported.
+  * Google Analytics tracking is supported.
   * Easy setup & configuration.
   * Well documented & IDE Friendly.
   * Well tested with maximum code quality.
@@ -52,14 +53,14 @@ SEO Helper is a package that provides tools and helpers for SEO (Search Engine O
 ## TODOS
 
   - [ ] Complete the documentation.
-  - [ ] Adding Google Analytics support.
 
 ## DONE
 
   - [x] Framework agnostic package.
   - [x] Open Graph supported.
   - [x] Twitter Cards supported.
   - [x] Webmaster tools supported.
+  - [x] Google Analytics supported.
   - [x] Laravel 5.1 supported.
 
 ## Contribution

_docs/4-Usage.md

@@ -10,6 +10,7 @@
   * [Keywords](#keywords)
   * [Miscellaneous Tags](#miscellaneous-tags)
   * [Webmasters](#webmasters)
+  * [Analytics](#analytics)
   * [Open Graph](#open-graph)
   * [Twitter Card](#twitter-card)
 2. [Helpers](#2-helpers)
@@ -703,6 +704,13 @@ echo $webmasters->render();
 
 For more details, check the [Webmasters API](5-API.md#webmasters).
 
+### Analytics
+
+```php
+```
+
+For more details, check the [Webmasters API](5-API.md#analytics).
+
 ### Open Graph
 
 It's pretty darn easy, right ? for the open graph protocol, same old stuff :

_docs/5-API.md

@@ -1,4 +1,4 @@
-# 5. API 
+# 5. API
 
 ## Table of contents
 
@@ -10,6 +10,7 @@
   * [Keywords](#keywords)
   * [Miscellaneous Tags](#miscellaneous-tags)
   * [Webmasters](#webmasters)
+  * [Analytics](#analytics)
   * [Open Graph](#open-graph)
   * [Twitter Card](#twitter-card)
 3. [Helpers](#3-helpers)
@@ -18,7 +19,7 @@
   * [SEO Meta](#seo-meta)
   * [SEO Open Graph](#seo-open-graph)
   * [SEO Twitter Card](#seo-twitter-card)
-  
+
 ## 1. Contracts
 
 ### Renderable
@@ -216,7 +217,7 @@ interface DescriptionInterface extends Renderable
      * @return self
      */
     public function setMax($max);
-    
+
     /* ------------------------------------------------------------------------------------------------
      |  Main Functions
      | ------------------------------------------------------------------------------------------------
@@ -407,6 +408,30 @@ interface WebmastersInterface extends Renderable
 }
 ```
 
+### Analytics
+
+```php
+<?php namespace Arcanedev\SeoHelper\Contracts\Entities;
+
+use Arcanedev\SeoHelper\Contracts\Renderable;
+
+interface AnalyticsInterface extends Renderable
+{
+    /* ------------------------------------------------------------------------------------------------
+     |  Getters & Setters
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Set google analytics code.
+     *
+     * @param  string  $code
+     *
+     * @return self
+     */
+    public function setGoogle($code);
+}
+```
+
 ### Open Graph
 
 ```php

config/seo-helper.php

@@ -87,4 +87,12 @@
             //
         ],
     ],
+
+    /* ------------------------------------------------------------------------------------------------
+     |  Analytics
+     | ------------------------------------------------------------------------------------------------
+     */
+    'analytics' => [
+        'google' => '', // UA-XXXXXXXX-X
+    ],
 ];

src/Contracts/Entities/AnalyticsInterface.php

@@ -0,0 +1,25 @@
+<?php namespace Arcanedev\SeoHelper\Contracts\Entities;
+
+use Arcanedev\SeoHelper\Contracts\Renderable;
+
+/**
+ * Interface  AnalyticsInterface
+ *
+ * @package   Arcanedev\SeoHelper\Contracts\Entities
+ * @author    ARCANEDEV <[email protected]>
+ */
+interface AnalyticsInterface extends Renderable
+{
+    /* ------------------------------------------------------------------------------------------------
+     |  Getters & Setters
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Set google analytics code.
+     *
+     * @param  string  $code
+     *
+     * @return self
+     */
+    public function setGoogle($code);
+}

src/Contracts/SeoMeta.php

@@ -123,6 +123,15 @@ public function addWebmaster($webmaster, $content);
      */
     public function setUrl($url);
 
+    /**
+     * Set the google analytics code.
+     *
+     * @param  string  $code
+     *
+     * @return self
+     */
+    public function setGoogleAnalytics($code);
+
     /* ------------------------------------------------------------------------------------------------
      |  Main Functions
      | ------------------------------------------------------------------------------------------------

src/Entities/Analytics.php

@@ -0,0 +1,113 @@
+<?php namespace Arcanedev\SeoHelper\Entities;
+
+use Arcanedev\SeoHelper\Contracts\Entities\AnalyticsInterface;
+use Arcanedev\Support\Traits\Configurable;
+
+/**
+ * Class     Analytics
+ *
+ * @package  Arcanedev\SeoHelper\Entities
+ * @author   ARCANEDEV <[email protected]>
+ */
+class Analytics implements AnalyticsInterface
+{
+    /* ------------------------------------------------------------------------------------------------
+     |  Traits
+     | ------------------------------------------------------------------------------------------------
+     */
+    use Configurable;
+
+    /* ------------------------------------------------------------------------------------------------
+     |  Properties
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Google analytics code.
+     *
+     * @var string
+     */
+    protected $google = '';
+
+    /* ------------------------------------------------------------------------------------------------
+     |  Constructor
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Make an Analytics instance.
+     *
+     * @param  array  $config
+     */
+    public function __construct(array $config)
+    {
+        $this->setConfigs($config);
+
+        $this->setGoogle($this->getConfig('google', ''));
+    }
+
+    /* ------------------------------------------------------------------------------------------------
+     |  Getters & Setters
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Set google analytics code.
+     *
+     * @param  string  $code
+     *
+     * @return self
+     */
+    public function setGoogle($code)
+    {
+        $this->google = $code;
+
+        return $this;
+    }
+
+    /* ------------------------------------------------------------------------------------------------
+     |  Main Functions
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Render the tag.
+     *
+     * @return string
+     */
+    public function render()
+    {
+        return implode(PHP_EOL, array_filter([
+            $this->renderGoogleScript(),
+        ]));
+    }
+
+    /**
+     * Render the tag.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->render();
+    }
+
+    /* ------------------------------------------------------------------------------------------------
+     |  Other Functions
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Render the google tracking code.
+     *
+     * @return string
+     */
+    private function renderGoogleScript()
+    {
+        return <<<EOT
+<script>
+    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+    m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+    })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+    ga('create', '$this->google', 'auto');
+    ga('send', 'pageview');
+</script>
+EOT;
+    }
+}

src/SeoMeta.php

@@ -1,5 +1,6 @@
 <?php namespace Arcanedev\SeoHelper;
 
+use Arcanedev\SeoHelper\Contracts\Entities\AnalyticsInterface;
 use Arcanedev\SeoHelper\Contracts\Entities\DescriptionInterface;
 use Arcanedev\SeoHelper\Contracts\Entities\KeywordsInterface;
 use Arcanedev\SeoHelper\Contracts\Entities\MiscTagsInterface;
@@ -67,6 +68,13 @@ class SeoMeta implements Contracts\SeoMeta
      */
     protected $webmasters;
 
+    /**
+     * The Analytics instance.
+     *
+     * @var AnalyticsInterface
+     */
+    protected $analytics;
+
     /* ------------------------------------------------------------------------------------------------
      |  Constructor
      | ------------------------------------------------------------------------------------------------
@@ -102,6 +110,9 @@ private function init()
         $this->webmasters(
             new Entities\Webmasters($this->getConfig('webmasters', []))
         );
+        $this->analytics(
+            new Entities\Analytics($this->getConfig('analytics', []))
+        );
     }
 
     /* ------------------------------------------------------------------------------------------------
@@ -178,6 +189,20 @@ public function webmasters(WebmastersInterface $webmasters)
         return $this;
     }
 
+    /**
+     * Set the Analytics instance.
+     *
+     * @param  Contracts\Entities\AnalyticsInterface  $analytics
+     *
+     * @return self
+     */
+    private function analytics(AnalyticsInterface $analytics)
+    {
+        $this->analytics = $analytics;
+
+        return $this;
+    }
+
     /**
      * Set the title.
      *
@@ -288,6 +313,20 @@ public function setUrl($url)
         return $this;
     }
 
+    /**
+     * Set the Google Analytics code.
+     *
+     * @param  string  $code
+     *
+     * @return self
+     */
+    public function setGoogleAnalytics($code)
+    {
+        $this->analytics->setGoogle($code);
+
+        return $this;
+    }
+
     /* ------------------------------------------------------------------------------------------------
      |  Main Functions
      | ------------------------------------------------------------------------------------------------
@@ -372,6 +411,7 @@ public function render()
             $this->keywords->render(),
             $this->misc->render(),
             $this->webmasters->render(),
+            $this->analytics->render(),
         ]));
     }