floating_block.admin.inc in Floating block 6

Admin page callbacks for the floating_block module.

File

floating_block.admin.inc

<?php

/**
 * @file
 * Admin page callbacks for the floating_block module.
 */

/**
 * Form to config floating block settings.
 */
function floating_block_admin() {
  $form = array();
  $form['floating_blocks'] = array(
    '#type' => 'textarea',
    '#title' => t('Floating block settings'),
    '#default_value' => _floating_block_admin_convert_array_to_text(variable_get('floating_blocks', array())),
    '#description' => t('Floating block configurations, one per line in the formation <code>[css selector]|[extra settings]</code>.'),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
  );
  return $form;
}
function floating_block_admin_validate($form, &$form_state) {
  $array = _floating_block_admin_convert_text_to_array($form_state['values']['floating_blocks']);
  $string = _floating_block_admin_convert_array_to_text($array);

  // Compare that floating block settings string to array conversion is
  // idempotent. New line characters \n and \r get make comparison difficult.
  if (str_replace(array(
    "\n",
    "\r",
  ), '', $string) != str_replace(array(
    "\n",
    "\r",
  ), '', $form_state['values']['floating_blocks'])) {
    form_set_error('floating_blocks', t('Each line must of the format: <code>selector|setting_key=setting_value,setting_key=setting_value,...</code>'));
  }
}

/**
 * Submit handler for floating_block admin form.
 *
 * Saves floating_blocks variable.
 */
function floating_block_admin_submit($form, &$form_state) {
  variable_set('floating_blocks', _floating_block_admin_convert_text_to_array($form_state['values']['floating_blocks']));
  drupal_set_message(t('The configuration options have been saved.'));
}

/**
 * Converts a string representation of floating block settings to an array.
 *
 * @param $floating_blocks
 *   A string representation of floating block settings.
 *
 * @return
 *   An array representation of floating block settings.
 */
function _floating_block_admin_convert_text_to_array($floating_blocks) {
  $floating_blocks = preg_split("/(\r\n|\n)/", $floating_blocks, NULL, PREG_SPLIT_NO_EMPTY);
  $output = array();
  foreach ($floating_blocks as $floating_block) {
    $settings = explode('|', $floating_block);
    $output[$settings[0]] = array();
    if (isset($settings[1])) {
      preg_match_all("/([^=|,]*)=([^=|,]*),?/", $settings[1], $matches, PREG_SET_ORDER);
      foreach ($matches as $match) {
        $output[$settings[0]][$match[1]] = $match[2];
      }
    }
  }
  return $output;
}

/**
 * Converts an array representation of floating block settings to a string.
 *
 * @param $floating_blocks
 *   An array representation of floating block settings.
 *
 * @return
 *   A string representation of floating block settings.
 */
function _floating_block_admin_convert_array_to_text($floating_blocks) {
  $output = array();
  foreach ($floating_blocks as $selector => $settings) {
    $output_line = $selector;
    if (count($settings)) {
      $settings_line = array();
      foreach ($settings as $key => $value) {
        $settings_line[] = $key . '=' . $value;
      }
      $output_line .= '|' . implode(',', $settings_line);
    }
    $output[] = $output_line;
  }
  return implode("\n", $output);
}

Functions

Name	Description
floating_block_admin	Form to config floating block settings.
floating_block_admin_submit	Submit handler for floating_block admin form.
floating_block_admin_validate
_floating_block_admin_convert_array_to_text	Converts an array representation of floating block settings to a string.
_floating_block_admin_convert_text_to_array	Converts a string representation of floating block settings to an array.