Added an ability to track user id

Author: viteksafronov

event/listener.php

@@ -66,6 +66,10 @@ static public function getSubscribedEvents()
 	public function load_google_analytics()
 	{
 		$this->template->assign_var('GOOGLEANALYTICS_ID', $this->config['googleanalytics_id']);
+		if ($this->config['googleanalytics_track_user_id'] && $this->user->data['is_registered'])
+		{
+			$this->template->assign_var('GOOGLEANALYTICS_USER_ID', "ga('set', 'userId', {$this->user->data['user_id']});");
+		}
 	}
 
 	/**
@@ -94,6 +98,12 @@ public function add_googleanalytics_configs($event)
 					'type' => 'text:40:20',
 					'explain' => true,
 				),
+				'googleanalytics_track_user_id' => array(
+					'lang' => 'ACP_GOOGLEANALYTICS_TRACK_USER_ID',
+					'validate' => 'bool',
+					'type' => 'radio:yes_no',
+					'explain' => true,
+				),
 			);
 
 			// Add the new config vars after board_timezone in the display_vars config array

language/en/googleanalytics_acp.php

@@ -38,7 +38,9 @@
 //
 
 $lang = array_merge($lang, array(
-	'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_INVALID'	=> '“%s” is not a valid Google Analytics ID code.<br />It should be in the form “UA-0000000-00”.',
+	'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_INVALID'			=> '“%s” is not a valid Google Analytics ID code.<br />It should be in the form “UA-0000000-00”.',
+	'ACP_GOOGLEANALYTICS_TRACK_USER_ID'			=> 'Track user id',
+	'ACP_GOOGLEANALYTICS_TRACK_USER_ID_EXPLAIN'	=> 'If enabled, Google Analytics will track the unique userId value for each authenticated user.',
 ));

migrations/v10x/m2_track_user_id.php

@@ -0,0 +1,45 @@
+<?php
+/**
+*
+* Google Analytics extension for the phpBB Forum Software package.
+*
+* @copyright (c) 2014 phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+*/
+
+namespace phpbb\googleanalytics\migrations\v10x;
+
+/**
+* Migration stage 2: Add default config value for user id tracking
+*/
+class m2_track_user_id extends \phpbb\db\migration\migration
+{
+	/**
+	* Assign migration file dependencies for this migration
+	*
+	* @return array Array of migration files
+	* @static
+	* @access public
+	*/
+	static public function depends_on()
+	{
+		return array(
+			'\phpbb\db\migration\data\v310\gold',
+			'\phpbb\googleanalytics\migrations\v10x\m1_initial_data'
+		);
+	}
+
+	/**
+	* Add Google Analytics data to the database.
+	*
+	* @return array Array of table data
+	* @access public
+	*/
+	public function update_data()
+	{
+		return array(
+			array('config.add', array('googleanalytics_track_user_id', 0)),
+		);
+	}
+}

styles/all/template/event/overall_header_stylesheets_after.html

@@ -6,6 +6,7 @@
 	})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
 	ga('create', '{GOOGLEANALYTICS_ID}', 'auto');
+	{GOOGLEANALYTICS_USER_ID}
 	<!-- EVENT phpbb_googleanalytics_alter_ga_requirements -->
 	ga('send', 'pageview');
 </script>