ga_push.datalayer.inc in GA Push 7

Universal Datalayer js: method and functions.

File

inc/ga_push.datalayer.inc

<?php

/**
 * @file
 * Universal Datalayer js: method and functions.
 */

/**
 * GA Push Method callback: Datalayer (js).
 */
function ga_push_method_datalayer($push, $type, $options) {
  $push_info = array(
    'push' => $push,
    'type' => $type,
  );
  $_SESSION['ga_push_' . GA_PUSH_METHOD_DATALAYER_JS][] = $push_info;
}

/**
 * Send the ga push to JS on page load using Universal Analytics Event Tracking.
 */
function ga_push_method_datalayer_push() {
  $session_key = 'ga_push_' . GA_PUSH_METHOD_DATALAYER_JS;
  if (isset($_SESSION[$session_key])) {
    $script = "var dataLayer = dataLayer || [];\n";

    // Process each push data that needs to be sent to Google Analytics.
    foreach ($_SESSION[$session_key] as $queued) {
      $push = $queued['push'];
      $type = $queued['type'];
      $script .= ga_push_method_datalayer_js_push_script($push, $type);
    }
    _ga_push_method_datalayer_js_add_script($script);
    unset($_SESSION[$session_key]);
  }
}

/**
 * Generate the GA Push script code by type.
 *
 * @param array $push
 *   Push data.
 * @param string $type
 *   Push type
 *
 * @return string
 *   Script code.
 */
function ga_push_method_datalayer_js_push_script($push, $type) {
  switch ($type) {
    case GA_PUSH_TYPE_EVENT:
      $script = _ga_push_method_datalayer_js_push_event_script($push);
      break;
    default:
      $script = NULL;
  }
  return $script;
}

/**
 * Generates the ga JS code for pushing an event to GA.
 *
 * @param array $push
 *   Event data.
 *
 * @return string
 *   JS code with push code.
 */
function _ga_push_method_datalayer_js_push_event_script($push) {

  // Optional: default values.
  $push += array(
    'event' => '',
  );

  // Convert to JS function.
  $script = _ga_push_method_datalayer_js_push_send_script($push);
  return $script;
}

/**
 * Generates the datalayer send JS code.
 *
 * @param array $push
 *   Data.
 *
 * @return string
 *   JS code with push code.
 */
function _ga_push_method_datalayer_js_push_send_script($push) {

  // Remove empty parameters:
  $push = array_filter($push);

  // Convert to JS function.
  $script = "dataLayer.push(" . json_encode($push) . ");\n";
  return $script;
}

/**
 * Adds generated script with push data.
 *
 * Used by ga_push_method_datalayer_js_push.
 *
 * @see ga_push_method_datalayer_js_push()
 *
 * @param string $script
 *   Generated script code to add.
 */
function _ga_push_method_datalayer_js_add_script($script) {
  $options = array(
    'type' => 'inline',
    'scope' => 'header',
  );
  drupal_add_js($script, $options);
}

Functions

Name	Description
ga_push_method_datalayer	GA Push Method callback: Datalayer (js).
ga_push_method_datalayer_js_push_script	Generate the GA Push script code by type.
ga_push_method_datalayer_push	Send the ga push to JS on page load using Universal Analytics Event Tracking.
_ga_push_method_datalayer_js_add_script	Adds generated script with push data.
_ga_push_method_datalayer_js_push_event_script	Generates the ga JS code for pushing an event to GA.
_ga_push_method_datalayer_js_push_send_script	Generates the datalayer send JS code.