global_filter.rangewidget.inc in Views Global Filter 8

global_filter.rangewidget.inc

Requires module contextual_range_filter.

File

widgets/global_filter.rangewidget.inc

<?php

/**
 * @file
 * global_filter.rangewidget.inc
 *
 * Requires module contextual_range_filter.
 */

/**
 * Called via hook_field_widget_form_alter().
 *
 * Turns slider widget into a slider range widget...
 * ...provided this was requested on the Global Filter block configuration
 * ...provided Contextual Range Filter module is enabled.
 */
function global_filter_field_slider_widget_form_alter(&$element, &$form_state, $context) {

  // Or $context['instance']['field_name']; ?
  $name = $element['#field_name'];
  $filter_key = global_filter_key_by_name($name);
  $convert_to_range = global_filter_get_parameter($filter_key, 'convert_to_range');
  $autosubmit = global_filter_get_parameter($filter_key, 'set_on_select');
  $slider_settings =& $element['value']['#attached']['js']['0']['data']['slider'];
  $lang = $form_state['language'];

  // Normally loops only once.
  foreach ($slider_settings as &$settings) {
    $settings['autosubmit'] = $autosubmit;

    // Only convert slider to range slider if we can support ranges via module
    // Contextual Range Filter. Maybe we should also check if this field is
    // actually enabled as a CRF ?
    if ($convert_to_range && module_exists('contextual_range_filter')) {
      $settings['range'] = TRUE;

      // Remove validation and ease maxlength restriction on textfield when
      // it's a range.
      unset($element['value']['#element_validate']);

      // #maxlength is used in _form_validate() (form.inc)
      if (isset($element['value']['#maxlength'])) {

        // Add 2 for delimiter.
        $element['value']['#maxlength'] = 2 * $element['value']['#maxlength'] + 2;
      }
      if (empty($form_state['input'][$name][$lang][0])) {
        $range = global_filter_get_session_value($name);
      }
      else {
        $range = reset($form_state['input'][$name][$lang][0]);
      }
      list($from, $to) = contextual_range_filter_split(is_array($range) ? reset($range) : $range);
      $settings['values'] = array(
        empty($from) ? $settings['min'] : $from,
        empty($to) ? $settings['max'] : $to,
      );
      unset($settings['value']);
    }
  }
}

/**
 * Create range widget.
 */
function global_filter_create_range_widget($filter_key, &$form, &$form_state) {
  if (!module_exists('contextual_range_filter')) {

    // Revert to single textfield.
    $form_state['global_filters'][$filter_key]['widget'] = 'textfield';
    global_filter_create_simple_widget($filter_key, NULL, $form, $form_state);
    return;
  }
  $name = $form_state['global_filters'][$filter_key]['name'];
  list($from, $to) = contextual_range_filter_split(global_filter_get_session_value($name));
  if (isset($form_state['input'][$name . '_from'])) {
    $from = $form_state['input'][$name . '_from'];
  }
  if (isset($form_state['input'][$name . '_to'])) {
    $to = $form_state['input'][$name . '_to'];
  }
  $form[$name] = array(
    '#type' => 'fieldset',
    '#element_validate' => array(
      'global_filter_range_widget_validate',
    ),
  );
  $form[$name][$name . '_from'] = array(
    '#title' => t('From'),
    '#type' => 'textfield',
    '#size' => 8,
    '#maxlength' => 32,
    '#default_value' => $from,
    '#description' => t('May be left blank.'),
  );
  $form[$name][$name . '_to'] = array(
    '#title' => t('To'),
    '#type' => 'textfield',
    '#size' => 8,
    '#maxlength' => 32,
    // Because $to could be FALSE.
    '#default_value' => empty($to) ? '' : $to,
    '#description' => t('May be left blank.'),
  );
}

/**
 * Validate the range widget.
 */
function global_filter_range_widget_validate($form, &$form_state) {
  $filter = reset($form_state['global_filters']);
  $name = $filter['name'];
  $from = $form_state['values'][$name . '_from'];
  $to = $form_state['values'][$name . '_to'];

  // Only validate numbers as PHP char order may not be order used by database.
  if (is_numeric($from) && is_numeric($to) && $from > $to) {
    form_set_error($name . '_from', t('"from" value must not be greater than "to" value.'));
    form_set_error($name . '_to');
  }
}

/**
 * Convert "from" and "to" values on the form to a single range string.
 *
 * @param array $form_state
 *   the form state
 *
 * @return string
 *   range in the format from--to, from-- or --to
 */
function global_filter_extract_alphanumeric_range($form_state, $name) {
  $from = $form_state['values'][$name . '_from'];
  $to = $form_state['values'][$name . '_to'];
  return $from === $to ? $from : "{$from}--{$to}";
}

Functions

Name	Description
global_filter_create_range_widget	Create range widget.
global_filter_extract_alphanumeric_range	Convert "from" and "to" values on the form to a single range string.
global_filter_field_slider_widget_form_alter	Called via hook_field_widget_form_alter().
global_filter_range_widget_validate	Validate the range widget.