adding convienence functions for setting custom campaign property key…

…s in JS and PHP Trackers. fixed php4 style variable referencing warnings.
jmturner · Nov 10, 2011 · e8c6b5d · e8c6b5d
1 parent a6d08ca
commit e8c6b5d
Show file tree

Hide file tree

Showing 6 changed files with 94 additions and 20 deletions.
diff --git a/modules/base/classes/client.php b/modules/base/classes/client.php
@@ -522,32 +522,75 @@ public function createSiteId($value) {
 		return md5($value);
 	}
 
+	public function setCampaignNameKey( $key ) {
+
+		$campaign_params = owa_coreAPI::getSetting( 'base', 'campaign_params' );
+		$campaign_params[ 'campaign' ] = $key;
+		owa_coreAPI::setSetting('base', 'campaign_params', $campaign_params);
+	}
+
+	public function setCampaignMediumKey( $key ) {
+
+		$campaign_params = owa_coreAPI::getSetting( 'base', 'campaign_params' );
+		$campaign_params[ 'medium' ] = $key;
+		owa_coreAPI::setSetting('base', 'campaign_params', $campaign_params);
+	}
+
+	public function setCampaignSourceKey( $key ) {
+
+		$campaign_params = owa_coreAPI::getSetting( 'base', 'campaign_params' );
+		$campaign_params[ 'source' ] = $key;
+		owa_coreAPI::setSetting('base', 'campaign_params', $campaign_params);
+	}
+
+	public function setCampaignSearchTermsKey( $key ) {
+
+		$campaign_params = owa_coreAPI::getSetting( 'base', 'campaign_params' );
+		$campaign_params[ 'search_terms' ] = $key;
+		owa_coreAPI::setSetting('base', 'campaign_params', $campaign_params);
+	}
+
+	public function setCampaignAdKey( $key ) {
+
+		$campaign_params = owa_coreAPI::getSetting( 'base', 'campaign_params' );
+		$campaign_params[ 'ad' ] = $key;
+		owa_coreAPI::setSetting('base', 'campaign_params', $campaign_params);
+	}
+
+	public function setCampaignAdTypeKey( $key ) {
+
+		$campaign_params = owa_coreAPI::getSetting( 'base', 'campaign_params' );
+		$campaign_params[ 'ad_type' ] = $key;
+		owa_coreAPI::setSetting('base', 'campaign_params', $campaign_params);
+	}
+
 	function getCampaignProperties( $event ) {
 
 		$campaign_params = owa_coreAPI::getSetting( 'base', 'campaign_params' );
 		$campaign_properties = array();
 		$campaign_state = array();
-		foreach ($campaign_params as $k => $param) {
+		$request = owa_coreAPI::getRequest();
+		foreach ( $campaign_params as $k => $param ) {
 			//look for property on the event
-			$property = $event->get($param);
+			$property = $event->get( $param );
 
 			// look for property on the request scope.
 			if ( ! $property ) {
-				$property = owa_coreAPI::getRequestParam($param);	
+				$property = $request->getRequestParam( $param );	
 			}
 			if ( $property ) {
-				$campaign_properties[$k] = $property;
+				$campaign_properties[ $k ] = $property;
 			}
 		}
 
 		// backfill values for incomplete param combos
 
-		if (array_key_exists('at', $campaign_properties) && !array_key_exists('ad', $campaign_properties)) {
+		if (array_key_exists('ad_type', $campaign_properties) && !array_key_exists('ad', $campaign_properties)) {
 			$campaign_properties['ad'] = '(not set)';
 		}
 
-		if (array_key_exists('ad', $campaign_properties) && !array_key_exists('at', $campaign_properties)) {
-			$campaign_properties['at'] = '(not set)';
+		if (array_key_exists('ad', $campaign_properties) && !array_key_exists('ad_type', $campaign_properties)) {
+			$campaign_properties['ad_type'] = '(not set)';
 		}
 
 		if (!empty($campaign_properties)) {
@@ -566,7 +609,7 @@ private function setCampaignSessionState( $properties ) {
 
 			if (array_key_exists( $k, $properties ) ) {
 
-				owa_coreAPI::setState( 's', $v, $properties[$k] );
+				owa_coreAPI::setState( 's', $k, $properties[$k] );
 			}
 		}
 	}
@@ -686,10 +729,10 @@ function setTrafficAttribution( &$event ) {
 		$campaign_params = owa_coreAPI::getSetting('base', 'campaign_params');
 		foreach( $campaign_params as $k => $v ) {
 
-			$value = owa_coreAPI::getState( 's', $v );
+			$value = owa_coreAPI::getState( 's', $k );
 
 			if ( $value ) { 
-				$this->setGlobalEventProperty( $v, $value );
+				$this->setGlobalEventProperty( $k, $value );
 			}
 		}
 

diff --git a/modules/base/classes/settings.php b/modules/base/classes/settings.php
@@ -662,12 +662,12 @@ function getDefaultSettingsArray() {
 				'nonce_expiration_period'			=> 43200,
 				'max_prior_campaigns'				=> 5,
 				'campaign_params'					=> array(
-						'cn'	=> 'campaign',
-						'md'	=> 'medium',
-						'sr'	=> 'source',
-						'tr'	=> 'search_terms',
-						'ad'	=> 'ad',
-						'at'	=> 'ad_type'),
+						'campaign'		=> 'owa_campaign',
+						'medium'		=> 'owa_medium',
+						'source'		=> 'owa_source',
+						'search_terms'	=> 'owa_search_terms',
+						'ad'			=> 'owa_ad',
+						'ad_type'		=> 'owa_ad_type'),
 				'trafficAttributionMode'			=> 'direct',
 				'campaignAttributionWindow'			=> 60,
 				'capabilities'						=> array(

diff --git a/modules/base/js/owa.tracker-combined-min.js b/modules/base/js/owa.tracker-combined-min.js
diff --git a/modules/base/js/owa.tracker.js b/modules/base/js/owa.tracker.js
@@ -1554,6 +1554,37 @@ OWA.tracker.prototype = {
 
 	},
 
+	setCampaignMediumKey : function ( key ) {
+
+		this.options.campaignKeys[0].public = key;
+	},
+
+	setCampaignNameKey : function ( key ) {
+
+		this.options.campaignKeys[1].public = key;
+	},
+
+	setCampaignSourceKey : function ( key ) {
+
+		this.options.campaignKeys[2].public = key;
+	},
+
+	setCampaignSearchTermsKey : function ( key ) {
+
+		this.options.campaignKeys[3].public = key;
+	},
+
+	setCampaignAdKey : function ( key ) {
+
+		this.options.campaignKeys[4].public = key;
+	},
+
+	setCampaignAdTypeKey : function ( key ) {
+
+		this.options.campaignKeys[5].public = key;
+	},
+
+
 	setTrafficAttribution : function( event ) {
 
 		var campaignState = OWA.getState( 'c', 'attribs' );

diff --git a/owa_base.php b/owa_base.php
@@ -74,7 +74,7 @@ class owa_base {
 	 */	
 	function __construct() {
 		owa_coreAPI::profile($this, __FUNCTION__, __LINE__);
-		$this->e = &owa_coreAPI::errorSingleton();
+		$this->e = owa_coreAPI::errorSingleton();
 		$this->c = &owa_coreAPI::configSingleton();
 		$this->config = $this->c->fetch('base');
 	}

diff --git a/owa_coreAPI.php b/owa_coreAPI.php
@@ -413,7 +413,7 @@ public static function subViewFactory($subview, $params = array()) {
 
 	public static function supportClassFactory($module, $class, $params = array(),$class_ns = 'owa_') {
 
-		$obj = &owa_lib::factory(OWA_BASE_DIR.'/'.'modules'.'/'.$module.'/'.'classes'.'/', $class_ns, $class, $params);
+		$obj = owa_lib::factory(OWA_BASE_DIR.'/'.'modules'.'/'.$module.'/'.'classes'.'/', $class_ns, $class, $params);
 		$obj->module = $module;
 
 		return $obj;