Merge pull request #63 from VSEphpbb/feature-usertracking

Feature user id tracking

Author: michaelcullum

event/listener.php

@@ -65,7 +65,10 @@ static public function getSubscribedEvents()
 	*/
 	public function load_google_analytics()
 	{
-		$this->template->assign_var('GOOGLEANALYTICS_ID', $this->config['googleanalytics_id']);
+		$this->template->assign_vars(array(
+			'GOOGLEANALYTICS_ID'		=> $this->config['googleanalytics_id'],
+			'GOOGLEANALYTICS_USER_ID'	=> $this->user->data['user_id'],
+		));
 	}
 
 	/**
@@ -77,27 +80,28 @@ public function load_google_analytics()
 	*/
 	public function add_googleanalytics_configs($event)
 	{
-		// Load language file
-		$this->user->add_lang_ext('phpbb/googleanalytics', 'googleanalytics_acp');
-
-		// Add a config to the settings mode, after board_timezone
-		if ($event['mode'] === 'settings' && isset($event['display_vars']['vars']['board_timezone']))
+		// Add a config to the settings mode, after warnings_expire_days
+		if ($event['mode'] === 'settings' && isset($event['display_vars']['vars']['warnings_expire_days']))
 		{
+			// Load language file
+			$this->user->add_lang_ext('phpbb/googleanalytics', 'googleanalytics_acp');
+
 			// Store display_vars event in a local variable
 			$display_vars = $event['display_vars'];
 
 			// Define the new config vars
 			$ga_config_vars = array(
+				'legend_googleanalytics' => 'ACP_GOOGLEANALYTICS',
 				'googleanalytics_id' => array(
-					'lang' => 'ACP_GOOGLEANALYTICS_ID',
-					'validate' => 'googleanalytics_id',
-					'type' => 'text:40:20',
-					'explain' => true,
+					'lang'		=> 'ACP_GOOGLEANALYTICS_ID',
+					'validate'	=> 'googleanalytics_id',
+					'type'		=> 'text:40:20',
+					'explain'	=> true,
 				),
 			);
 
-			// Add the new config vars after board_timezone in the display_vars config array
-			$insert_after = array('after' => 'board_timezone');
+			// Add the new config vars after warnings_expire_days in the display_vars config array
+			$insert_after = array('after' => 'warnings_expire_days');
 			$display_vars['vars'] = phpbb_insert_config_array($display_vars['vars'], $ga_config_vars, $insert_after);
 
 			// Update the display_vars event with the new array

language/en/googleanalytics_acp.php

@@ -38,7 +38,8 @@
 //
 
 $lang = array_merge($lang, array(
+	'ACP_GOOGLEANALYTICS'				=> 'Google Analytics',
 	'ACP_GOOGLEANALYTICS_ID'			=> 'Google Analytics ID',
-	'ACP_GOOGLEANALYTICS_ID_EXPLAIN'	=> 'Enter your Google Analytics ID code, e.g.: <samp>UA-0000000-00</samp>.',
+	'ACP_GOOGLEANALYTICS_ID_EXPLAIN'	=> 'Enter your Google Analytics ID code, e.g.: <samp>UA-0000000-00</samp>.<br /><br />Google Analytics can track your registered users across multiple devices and sessions, for a more accurate user count in your reports. To enable this enhanced functionality User ID tracking must be configured in your Google Analytics account. <a href="https://support.google.com/analytics/answer/3123666">Click for more information</a>.',
 	'ACP_GOOGLEANALYTICS_ID_INVALID'	=> '“%s” is not a valid Google Analytics ID code.<br />It should be in the form “UA-0000000-00”.',
 ));

styles/all/template/event/overall_header_stylesheets_after.html

@@ -1,12 +1,15 @@
-<!-- IF GOOGLEANALYTICS_ID -->
+{% if GOOGLEANALYTICS_ID %}
 <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', '{GOOGLEANALYTICS_ID}', 'auto');
-	<!-- EVENT phpbb_googleanalytics_alter_ga_requirements -->
+	ga('create', '{{ GOOGLEANALYTICS_ID }}', 'auto');
+	{% if S_REGISTERED_USER -%}
+	ga('set', 'userId', {{ GOOGLEANALYTICS_USER_ID }});
+	{% endif -%}
+	{% EVENT phpbb_googleanalytics_alter_ga_requirements -%}
 	ga('send', 'pageview');
 </script>
-<!-- ENDIF -->
+{% endif %}

tests/event/listener_test.php

@@ -44,6 +44,8 @@ public function setUp()
 		$this->template = $this->getMockBuilder('\phpbb\template\template')
 			->getMock();
 		$this->user = new \phpbb\user('\phpbb\datetime');
+		$this->user->data['user_id'] = 2;
+		$this->user->data['is_registered'] = true;
 	}
 
 	/**
@@ -87,8 +89,11 @@ public function test_load_google_analytics()
 		$this->set_listener();
 
 		$this->template->expects($this->once())
-			->method('assign_var')
-			->with('GOOGLEANALYTICS_ID', $this->config['googleanalytics_id']);
+			->method('assign_vars')
+			->with(array(
+				'GOOGLEANALYTICS_ID'		=> $this->config['googleanalytics_id'],
+				'GOOGLEANALYTICS_USER_ID'	=> $this->user->data['user_id'],
+			));
 
 		$dispatcher = new \Symfony\Component\EventDispatcher\EventDispatcher();
 		$dispatcher->addListener('core.page_header', array($this->listener, 'load_google_analytics'));
@@ -105,13 +110,13 @@ public function add_googleanalytics_configs_data()
 		return array(
 			array( // expected config and mode
 				'settings',
-				array('vars' => array('board_timezone' => array())),
-				array('board_timezone', 'googleanalytics_id'),
+				array('vars' => array('warnings_expire_days' => array())),
+				array('warnings_expire_days', 'legend_googleanalytics', 'googleanalytics_id'),
 			),
 			array( // unexpected mode
 				'foobar',
-				array('vars' => array('board_timezone' => array())),
-				array('board_timezone'),
+				array('vars' => array('warnings_expire_days' => array())),
+				array('warnings_expire_days'),
 			),
 			array( // unexpected config
 				'settings',

tests/functional/google_analytics_test.php

@@ -45,11 +45,11 @@ public function test_set_acp_settings()
 		// Load ACP board settings page
 		$crawler = self::request('GET', 'adm/index.php?i=acp_board&mode=settings&sid=' . $this->sid);
 
-		// Test that GA settings field is found in the correct position (after SYSTEM_TIMEZONE)
+		// Test that GA settings field is found in the correct position (after WARNINGS_EXPIRE)
 		$nodes = $crawler->filter('#acp_board > fieldset > dl > dt > label')->extract(array('_text'));
 		foreach ($nodes as $key => $config_name)
 		{
-			if (strpos($config_name, $this->lang('SYSTEM_TIMEZONE')) !== 0)
+			if (strpos($config_name, $this->lang('WARNINGS_EXPIRE')) !== 0)
 			{
 				continue;
 			}