google_adwords.module in Google AdWords Conversion Tracking 7

Google Adwords Conversion Tracking Module

File

google_adwords.module

<?php

/**
 * @file
 * Google Adwords Conversion Tracking Module
 */

// User permissions
define('GOOGLE_ADWORDS_ADMIN_PERM', 'administer google adwords module');
define('GOOGLE_ADWORDS_TRACK_PERM', 'track role with google adword');

/**
 * Implementation of hook_permission().
 *
 */
function google_adwords_permission() {
  return array(
    GOOGLE_ADWORDS_ADMIN_PERM => array(
      'title' => t('Administer google adwords module.'),
      'description' => t('Perform administration tasks for google adwords.'),
    ),
    GOOGLE_ADWORDS_TRACK_PERM => array(
      'title' => t('Track role with google adwords.'),
      'description' => t('Selected roles will have the google adwords code displayed if available.'),
    ),
  );
}

/**
 * Implements hook_menu().
 */
function google_adwords_menu() {
  $items['admin/config/system/google_adwords'] = array(
    'title' => t('Google AdWords'),
    'description' => t('Google AdWords Settings page.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'google_adwords_admin_settings',
    ),
    'access arguments' => array(
      GOOGLE_ADWORDS_ADMIN_PERM,
    ),
    'file' => 'google_adwords.admin.inc',
  );
  return $items;
}

/**
 * Implements hook_theme().
 */
function google_adwords_theme() {
  return array(
    'google_adwords_tracking' => array(
      'variables' => array(),
    ),
  );
}

/**
 * Implements hook_field_info().
 */
function google_adwords_field_info() {
  return array(
    'google_adwords_tracking' => array(
      'label' => 'Google Adwords Field',
      'description' => t('This field stores Google Adwords conversion tracking parameter.'),
      'default_widget' => 'text_textfield',
      'default_formatter' => 'default',
      'property_type' => 'text',
    ),
  );
}

/**
 * Implements hook_field_validate().
 */
function google_adwords_field_validate($obj_type, $object, $field, $instance, $langcode, $items, &$errors) {
  foreach ($items as $delta => $item) {
    if (!empty($item['conversion_id']) && (!is_numeric($item['conversion_id']) || (int) $item['conversion_id'] != $item['conversion_id'])) {
      $error = t('%name: The ID value has to be numeric.', array(
        '%name' => $instance['label'],
      ));
      $errors[$field['field_name']][$langcode][$delta][] = array(
        'error' => $error,
        'message' => $error,
      );
    }
  }
  return;
}

/**
 * Implements hook_field_is_empty().
 */
function google_adwords_field_is_empty($item, $field) {

  // It makes no sense to store stuff without a conversion id.
  return empty($item['conversion_id']);
}

/**
 * Implements hook_field_formatter_info().
 */
function google_adwords_field_formatter_info() {
  $formats = array(
    'google_adwords_default' => array(
      'label' => t('Default'),
      'field types' => array(
        'google_adwords_tracking',
      ),
    ),
  );
  return $formats;
}

/**
 * Implements hook_field_formatter_view().
 */
function google_adwords_field_formatter_view($object_type, $object, $field, $instance, $langcode, $items, $display) {
  global $user;
  $element = array();

  // Get available permissions
  $permission = user_roles(FALSE, GOOGLE_ADWORDS_TRACK_PERM);
  $track = FALSE;

  // Make sure the user is being tracked
  foreach ($user->roles as $rid) {
    if (in_array($rid, $permission)) {
      $track = TRUE;
    }
  }
  if ($track) {
    foreach ($items as $delta => $item) {
      switch ($display['type']) {
        case 'google_adwords_default':
          $element[$delta]['#markup'] = theme('google_adwords_tracking', $item);
          break;
      }
    }
  }
  return $element;
}

/**
 * Implements hook_field_widget_info().
 */
function google_adwords_field_widget_info() {
  return array(
    'google_adwords_tracking' => array(
      'label' => t('Google Adwords Tracking Field'),
      'field types' => array(
        'google_adwords_tracking',
      ),
    ),
  );
}

/**
 * Implements hook_field_presave().
 */
function google_adwords_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {

  // Make sure nothing evil can bypass
  foreach ($items as $delta => &$item) {
    $item['conversion_id'] = (int) $item['conversion_id'];
    $item['label'] = filter_xss($item['label']);
    $item['value'] = filter_xss($item['value']);
    $item['language'] = filter_xss($item['language']);
    $item['color'] = filter_xss($item['color']);
    $item['format'] = filter_xss($item['format']);
  }
  return $items;
}

/**
 * Implements hook_field_widget_form().
 *
 * @todo Create a nicer form element.
 */
function google_adwords_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $base) {
  $fields = array(
    'conversion_id' => array(
      '#title' => 'Conversion Id',
    ),
    'label' => array(
      '#title' => 'Label',
    ),
    'value' => array(
      '#title' => 'Value',
    ),
    'language' => array(
      '#title' => 'Language',
    ),
    'color' => array(
      '#title' => 'Color',
      '#description' => t('<i><b>Note:</b> Enter the HEX value for the color without the hash (#) symbol.</i>'),
    ),
    'format' => array(
      '#title' => 'Format',
      '#description' => t('<i><b>Usage:</b> 1 = Single line, 2 = Two lines, 3 = Not displayed</i>'),
    ),
  );
  $element = $base + array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  foreach ($fields as $field_name => $options) {
    $element[$field_name] = $options + array(
      '#type' => 'textfield',
      '#default_value' => isset($items[$delta][$field_name]) ? $items[$delta][$field_name] : NULL,
      '#size' => 60,
    );
  }
  return $element;
}

/**
 * Register a new conversion tracking.
 *
 * The rules integration calls this function.
 * Use this to set a custom tracking not related to a entity.
 *
 * @param integer $conversion_id
 * @param string $label
 * @param string $value
 * @param string $language
 * @param integer $color
 * @param integer $format
 */
function google_adwords_add_tracking($conversion_id, $label = NULL, $value = NULL, $language = NULL, $color = NULL, $format = NULL) {
  $cache =& drupal_static(__FUNCTION__, array());
  $label = $label ? $label : base64_encode($conversion_id);
  $language = $language ? $language : 'en';
  $color = $color ? $color : 'FFFFFF';
  $format = $format ? $format : 1;
  $cache[$conversion_id] = array(
    'conversion_id' => $conversion_id,
    'label' => $label,
    'language' => $language,
    'color' => $color,
    'format' => $format,
    'value' => $value,
  );
}

/**
 * Get defined conversion trackings for this page.
 * Returns only the trackings set by rules or other modules using the function
 * google_adwords_add_tracking().
 *
 * @see google_adwords_add_tracking()
 *
 * @return array
 */
function google_adwords_get_tracking() {
  return drupal_static('google_adwords_add_tracking', array());
}

/**
 * Implements hook_page_build().
 * @param array $page
 *
 * @todo Do we need a setting to define in which area the code has to appear?
 */
function google_adwords_page_build(&$page) {
  $trackings = google_adwords_get_tracking();
  foreach ($trackings as $tracking) {
    $page['content']['system_main']['google_adwords'][$tracking['conversion_id']]['#markup'] = theme('google_adwords_tracking', $tracking);
  }
}

/**
 * Creates the code snipped for the tracking.
 * @param array $variables
 * @return markup
 */
function theme_google_adwords_tracking($variables) {
  $value_js = NULL;
  $value_param = NULL;
  if (strlen($variables['value'])) {
    $value_js = '  var google_conversion_value = "' . $variables['value'] . '";' . PHP_EOL;
    $value_param = '&value=' . rawurlencode($variables['value']);
  }
  return '<!-- Google Code for Purchase Conversion Page -->' . PHP_EOL . '<script language="JavaScript" type="text/javascript">' . PHP_EOL . '<!--' . PHP_EOL . '  var google_conversion_id = ' . $variables['conversion_id'] . ';' . PHP_EOL . '  var google_conversion_language = "' . $variables['language'] . '";' . PHP_EOL . '  var google_conversion_format = "' . $variables['format'] . '";' . PHP_EOL . '  var google_conversion_color = "' . $variables['color'] . '";' . PHP_EOL . '  var google_conversion_label = "' . $variables['label'] . '";' . PHP_EOL . $value_js . '//-->' . PHP_EOL . '</script>' . PHP_EOL . '<script language="JavaScript" src="https://www.googleadservices.com/pagead/conversion.js">' . PHP_EOL . '</script>' . PHP_EOL . '<noscript>' . PHP_EOL . '  <img height=1 width=1 border=0 src="https://www.googleadservices.com/pagead/conversion/' . $variables['conversion_id'] . '/?script=0' . $value_param . '&label=' . $variables['label'] . '">' . PHP_EOL . '</noscript>' . PHP_EOL;
}

Functions

Name	Description
google_adwords_add_tracking	Register a new conversion tracking.
google_adwords_field_formatter_info	Implements hook_field_formatter_info().
google_adwords_field_formatter_view	Implements hook_field_formatter_view().
google_adwords_field_info	Implements hook_field_info().
google_adwords_field_is_empty	Implements hook_field_is_empty().
google_adwords_field_presave	Implements hook_field_presave().
google_adwords_field_validate	Implements hook_field_validate().
google_adwords_field_widget_form	Implements hook_field_widget_form().
google_adwords_field_widget_info	Implements hook_field_widget_info().
google_adwords_get_tracking	Get defined conversion trackings for this page. Returns only the trackings set by rules or other modules using the function google_adwords_add_tracking().
google_adwords_menu	Implements hook_menu().
google_adwords_page_build	Implements hook_page_build().
google_adwords_permission	Implementation of hook_permission().
google_adwords_theme	Implements hook_theme().
theme_google_adwords_tracking	Creates the code snipped for the tracking.

Constants

Name	Description
GOOGLE_ADWORDS_ADMIN_PERM
GOOGLE_ADWORDS_TRACK_PERM