Quick & Easy Google Analytics with SiteConfig

Tweet

24 November 2010 | Ty Barho | Decorators, SiteConfig | Supports v2.4

16 9

Many people need a way to monitor their website, and while it's pretty easy to add the code to a SilverStripe template, or even the basic Page_Controller, I thought I would show how I modularized and made it accessible from the SiteConfig area of the CMS.

Module Structure

First, you're gonna need the directory setup for your GoogleAnalytics module. Mine looks something like:

- GoogleAnalytics (main module folder)
---- _config.php
---- code
-------- GoogleAnalytics.php
-------- GoogleAnalyticsExtender.php

Code

Now you need the code for your GoogleAnalytics object in SiteConfig, where you actually store the Analytics ID. Mine is very simple, and looks something like this:

GoogleAnalytics/code/GoogleAnalytics.php

<?php
class GoogleAnalytics extends DataObjectDecorator
{
        function extraStatics(){
                return array(
                        'db' => array(
                                'GoogleAnalyticsAccountID' => 'Text'
                        )
                );
        }
        
        public function updateCMSFields(FieldSet &$fields) {
                $fields->addFieldToTab('Root.Main', new TextField('GoogleAnalyticsAccountID', 'Google Analytics Code (Example: UA-XXXXXXXX-X)', '', 13));
        }
        
        function contentControllerInit($controller) {
        }
        
}

 

It basically just extends the SiteConfig with a DataObjectDecorator to include a GoogleAnalyticsAccountID, then updates the CMS fields so you can set it and save it. In retrospect, it would probably be nice to have a validator on that field that only accepts an appropriately formatted ID, but we'll keep it simple for now.

Next, you need something that extends your pages to include the Javascript with the Analytics code in it, so Google can keep track of your Page Views, Bounces, and all that other important data you crave!

GoogleAnalytics/code/GoogleAnalyticsExtender.php

<?php
	
	class GoogleAnalyticsExtender extends DataObjectDecorator
	{
	        function contentControllerInit($controller) {
	                                
	                $accountId = $this->owner->SiteConfig->GoogleAnalyticsAccountID;
	                                
	                if(preg_match("/UA-[0-9]{7,}-[0-9]{1,}/", $accountId)) {
	                
	                        Requirements::customScript(<<<JS
	                          var _gaq = _gaq || [];
	                          _gaq.push(['_setAccount', '$accountId']);
	                          _gaq.push(['_trackPageview']);
	                        
	                          (function() {
	                            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
	                            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
	                            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
	                          })();
	JS
	);
	
	                
	                }
	                
	        }
	}

 

This basically says "If the site ID is a (relatively, I'm terrible at regular expressions, and any improvements are welcome!) valid GoogleAccountID, then add the custom Javascript to anything that is, or extends from a Page class. So all of you custom pages, like Staff Page, or EventPage, or BlogEntry will all get the analytics JS as well.

Lastly, you need to tell SilverStripe to add this functionality to the two objects: Page, and SiteConfig. You can do this in your _config.php file.

GoogleAnalytics/_config.php

	<?php
	
	Object::add_extension('SiteConfig', 'GoogleAnalytics');
	Object::add_extension('Page', 'GoogleAnalyticsExtender');
	

And you're done! You should now have a brand new field in your SiteConfig where you can set and save your GoogleAnalyticsAccountID, saving you all that agitating time adding it to your Page_Controller manually. Plus, you've got a module you can reuse on any SilverStripe site!