You are here

Home » API reference » GoogleTagManager 7.2

settings.inc in GoogleTagManager 7.2

Same filename in this branch
  1. 7.2 includes/entity/settings.inc
  2. 7.2 includes/form/settings.inc

Contains the settings form callbacks.

@author Jim Berry ("solotandem", http://drupal.org/user/240748)

File

includes/form/settings.inc
View source 
<?php

/**
 * @file
 * Contains the settings form callbacks.
 *
 * @author Jim Berry ("solotandem", http://drupal.org/user/240748)
 */

/**
 * Form constructor for the container form.
 *
 * @see google_tag_settings_form_validate()
 * @see google_tag_settings_form_submit()
 *
 * @ingroup forms
 */
function google_tag_settings_form($form, &$form_state) {
  module_load_include('inc', 'google_tag', 'includes/variable');

  // module_load_include('inc', 'ctools', 'includes/export');
  // Gather data.
  // @todo Set this on validation errors.
  $default_tab = !empty($form_state['default_tab']) ? $form_state['default_tab'] : '';

  // @todo always add default keys in case of no update hook being run.
  $config = \GTMSettings::getInstance();
  $export_type = EXPORT_IN_DATABASE;
  if (empty($config
    ->get('uri'))) {

    // @todo This appears somewhat circular as variables_get() uses
    // \GTMSettings::getInstance() for default values but does appeal to the
    // variable definition if settings object does not exist.
    $config = (object) GTMContainerExport::variables_get(TRUE);
    $export_type = NULL;
  }
  $form_state['item'] = $config;

  // Build form elements.
  // Module settings.
  $description = t('<br />After configuring the module settings and default properties for a new container, <strong>add a container</strong> on the <a href="!url">container management page</a>.', array(
    '!url' => url('admin/config/system/google_tag'),
  ));
  $form['instruction'] = array(
    '#type' => 'markup',
    '#markup' => $description,
  );
  $groups = array(
    'settings' => array(
      'title' => t('Module settings'),
      'description' => t('The settings that apply to all containers.'),
      'collapse' => FALSE,
    ),
  );
  foreach ($groups as $group => $items) {
    $form['settings'] = google_tag_fieldset($group, $items, $form_state['item']);
  }

  // Default container settings.
  $text = t('The default container settings that apply to a new container.');
  $suffix = '<div id="edit-default--description" class="description">' . $text . '</div>';
  $groups = array(
    // 'general' => array('title' => t('General'), 'collapse' => FALSE),
    'advanced' => array(
      'title' => t('Advanced'),
    ),
  );
  $form['default'] = array(
    '#type' => 'vertical_tabs',
    '#attributes' => array(
      'class' => array(
        'google-tag',
      ),
    ),
    '#prefix' => '<strong>' . t('Default container settings') . '</strong>',
    '#suffix' => $suffix,
  );
  foreach ($groups as $group => $items) {
    $form['default'][$group] = google_tag_fieldset($group, $items, $form_state['item']);
  }

  // Default insertion condition.
  $description = t('On this and the following tabs, specify the conditions on which the GTM JavaScript snippet will either be inserted on or omitted from the page response, thereby enabling or disabling tracking and other analytics. All conditions must be satisfied for the snippet to be inserted. The snippet will be omitted if any condition is not met.');
  $text = t('The default snippet insertion conditions that apply to a new container.');
  $suffix = '<div id="edit-default--description" class="description">' . $text . '</div>';
  $groups = array(
    'path' => array(
      'title' => t('Request path'),
      'description' => $description,
    ),
    'role' => array(
      'title' => t('User role'),
    ),
    'status' => array(
      'title' => t('Response status'),
    ),
  );

  // Use prefix and suffix as title and description are not rendered.
  $form['conditions'] = array(
    '#type' => 'vertical_tabs',
    '#title' => t('Default insertion conditions'),
    '#description' => t('The default snippet insertion conditions that apply to a new container.'),
    '#default_tab' => $default_tab ? $default_tab : 'edit-path',
    '#attributes' => array(
      'class' => array(
        'google-tag',
      ),
    ),
    '#attached' => array(
      'css' => array(
        drupal_get_path('module', 'google_tag') . '/css/google_tag.admin.css',
      ),
      'js' => array(
        drupal_get_path('module', 'google_tag') . '/js/google_tag.admin.js',
      ),
    ),
    '#prefix' => '<strong>' . t('Default insertion conditions') . '</strong>',
    '#suffix' => $suffix,
  );
  foreach ($groups as $group => $items) {
    $form['conditions'][$group] = google_tag_fieldset($group, $items, $form_state['item']);
  }
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
  );
  $form['export_type'] = array(
    '#type' => 'value',
    '#value' => $export_type,
  );
  return $form;
}

/**
 * Fieldset builder for the module settings form.
 */
function google_tag_fieldset($group, array $items, $container) {

  // Gather data.
  $function = "_google_tag_variable_info_{$group}";
  $variables = $function(array());
  $items += array(
    'description' => '',
    'collapse' => TRUE,
  );

  // Build form elements.
  $fieldset = array(
    '#type' => 'fieldset',
    '#title' => $items['title'],
    '#description' => $items['description'],
    '#collapsible' => $items['collapse'],
    '#collapsed' => $items['collapse'],
    '#tree' => FALSE,
  );
  $fieldset += google_tag_form_elements($variables, $container);
  return $fieldset;
}

/**
 * Returns form elements from variable definitions.
 *
 * @param array $variables
 *   Associative array of variable definitions.
 * @param object $container
 *   The container configuration object.
 *
 * @return array
 *   Associative array of form elements.
 */
function google_tag_form_elements(array $variables, $container) {
  static $keys = array(
    'type' => '#type',
    'title' => '#title',
    'description' => '#description',
    'options' => '#options',
    'default' => '#default_value',
  );
  $elements = array();
  foreach ($variables as $name => $variable) {
    $element = array();
    foreach ($keys as $key => $property) {
      if (isset($variable[$key])) {
        $element[$property] = $variable[$key];
      }
    }
    $element['#type'] = google_tag_form_element_type($element['#type']);
    $element['#default_value'] = $container->{$name};
    $element += isset($variable['element']) ? $variable['element'] : array();
    $elements[$name] = $element;
  }
  return $elements;
}

/**
 * Converts variable type to form element type.
 *
 * @param string $type
 *   Variable type.
 *
 * @return string
 *   Form element type.
 */
function google_tag_form_element_type($type) {
  static $keys = array(
    'string' => 'textfield',
    'select' => 'radios',
    'text' => 'textarea',
    'options' => 'checkboxes',
    'boolean' => 'checkbox',
    'weight' => 'weight',
  );
  return isset($keys[$type]) ? $keys[$type] : 'textfield';
}

/**
 * Form validation handler for google_tag_settings_form().
 */
function google_tag_settings_form_validate($form, &$form_state) {
  $values =& $form_state['values'];

  // Trim the text values.
  // $values['container_id'] = trim($values['container_id']);
  $values['uri'] = trim($values['uri']);
  $values['environment_id'] = trim($values['environment_id']);
  $values['data_layer'] = trim($values['data_layer']);
  google_tag_text_clean($values['path_list']);
  google_tag_text_clean($values['status_list']);
  google_tag_text_clean($values['whitelist_classes']);
  google_tag_text_clean($values['blacklist_classes']);

  // Replace all types of dashes (n-dash, m-dash, minus) with a normal dash.
  // $values['container_id'] = str_replace(array('–', '—', '−'), '-', $values['container_id']);
  $values['environment_id'] = str_replace(array(
    '–',
    '—',
    '−',
  ), '-', $values['environment_id']);
  $values['role_list'] = array_filter($values['role_list']);

  /*
    if (!preg_match('/^GTM-\w{4,}$/', $values['container_id'])) {
      // @todo Is there a more specific regular expression that applies?
      // @todo Is there a way to "test the connection" to determine a valid ID for
      // a container? It may be valid but not the correct one for the website.
      form_set_error('container_id', t('A valid container ID is case sensitive and formatted like GTM-xxxxxx.'));
    }
  */
  if ($values['include_environment'] && !preg_match('/^env-\\d{1,}$/', $values['environment_id'])) {
    form_set_error('environment_id', t('A valid environment ID is case sensitive and formatted like env-x.'));
  }
  if ($message = _google_tag_data_layer_verify($values['data_layer'])) {
    form_set_error('data_layer', $message);
  }
  if ($values['include_classes']) {
    if (empty($values['whitelist_classes']) && empty($values['blacklist_classes'])) {
      form_set_error('include_classes', t('Enter listed classes in at least one field, or uncheck the box.'));
      form_set_error('whitelist_classes', '');
      form_set_error('blacklist_classes', '');
    }
  }
  $directory = $values['uri'];
  if (substr($directory, -3) == '://') {
    $args = array(
      '%directory' => $directory,
    );
    $message = 'The snippet parent uri %directory is invalid. Enter a single trailing slash to specify a plain stream wrapper.';
    form_set_error('uri', t($message, $args));
  }

  // Allow for a plain stream wrapper with one trailing slash.
  $directory .= substr($directory, -2) == ':/' ? '/' : '';
  if (!is_dir($directory) || !_google_tag_is_writable($directory) || !_google_tag_is_executable($directory)) {
    $args = array(
      '%directory' => $directory,
    );
    $message = 'The snippet parent uri %directory is invalid, possibly due to file system permissions. The directory either does not exist, or is not writable or searchable.';
    form_set_error('uri', t($message, $args));
  }
}

/**
 * Form submission handler for google_tag_settings_form().
 */
function google_tag_settings_form_submit($form, &$form_state) {
  module_load_include('inc', 'ctools', 'includes/export');

  // @todo Just like fields that change the 'value' during load-save,
  // backup the current form_state 'item' and restore it after save.
  // @todo Add the status property to data.
  $variables = GTMContainerExport::variables_get(TRUE);

  // Set name and label so we can load all rows in config table and then remove
  // the settings item before building the container list page.
  // See google_tag_export_load().
  $values =& $form_state['values'];
  $data['name'] = 'settings';
  $data['label'] = 'Module settings';

  // @todo ctools seems to store this in the variable table for all objects???
  // It relies on config.export.status key
  $data['status'] = TRUE;
  $data += array_intersect_key($form_state['values'], $variables);
  $clone['name'] = 'google_tag.settings';
  $clone['data'] = $data;
  $clone['export_type'] = isset($values['export_type']) ? $values['export_type'] : NULL;
  $clone = (object) $clone;
  $result = ctools_export_crud_save('gtag_config', $clone);

  // @todo If the uri changes, then could rebuild snippets. But let user invoke.
}

// Next two functions are in two files: this and form/container.inc
// For code in php cache does this cause issue? It works on php 7.3.

/**
 * Cleans a string representing a list of items.
 *
 * @param string $text
 *   The string to clean.
 * @param string $format
 *   The final format of $text, either 'string' or 'array'.
 */
function google_tag_text_clean(&$text, $format = 'string') {
  $text = explode("\n", $text);
  $text = array_map('trim', $text);
  $text = array_filter($text, 'trim');
  if ($format == 'string') {
    $text = implode("\n", $text);
  }
}

/**
 * Verifies presence of dataLayer module and compares name of data layer.
 *
 * @return bool|null
 *   Whether data layer name is incompatible with dataLayer module, if present.
 */
function _google_tag_data_layer_verify($value) {
  if (module_exists('datalayer') && $value != 'dataLayer') {

    // @todo Setting form error does not allow user to save a different name,
    // i.e. to do what message text says.
    return t('The 1.1 release of the dataLayer module does not support a data layer name other than "dataLayer." If you need a different layer name, then either disable the dataLayer module or alter the JavaScript added to the page response.');
  }
}

Functions

Namesort descending Description
google_tag_fieldset Fieldset builder for the module settings form.
google_tag_form_elements Returns form elements from variable definitions.
google_tag_form_element_type Converts variable type to form element type.
google_tag_settings_form Form constructor for the container form.
google_tag_settings_form_submit Form submission handler for google_tag_settings_form().
google_tag_settings_form_validate Form validation handler for google_tag_settings_form().
google_tag_text_clean Cleans a string representing a list of items.
_google_tag_data_layer_verify Verifies presence of dataLayer module and compares name of data layer.