redhen.forms.inc in RedHen CRM 7

Defines forms shared across the Redhen CRM.

File

includes/redhen.forms.inc

<?php

/**
 * @file
 * Defines forms shared across the Redhen CRM.
 */

/**
 * Returns the form to filter redhen entity lists.
 */
function redhen_filter_form($form, &$form_state, $entity_type) {
  drupal_add_library('system', 'ui.datepicker');
  drupal_add_js(drupal_get_path('module', 'redhen') . '/misc/redhen.forms.js');
  $property_info = entity_get_all_property_info($entity_type);
  if (!empty($property_info)) {
    $form['filter_fieldset'] = array(
      '#type' => 'fieldset',
      '#title' => t('Filters'),
      '#collapsible' => TRUE,
      '#collapsed' => empty($_GET['properties']) && empty($_GET['fields']) && empty($_GET['bundle']),
    );
    $form['filter_fieldset']['filters'] = array(
      '#type' => 'container',
      '#tree' => TRUE,
    );
    $form['filter_fieldset']['filters']['properties'] = array(
      '#type' => 'container',
    );

    // Add a form field for each property.
    foreach ($property_info as $key => $prop) {
      if (isset($prop['filter']) && $prop['filter']) {
        $field_type = isset($prop['field_type']) ? $prop['field_type'] : $prop['type'];

        // Convert datetime defaults to date strings.
        $default_value = isset($_GET['properties'][$key]) ? $_GET['properties'][$key] : NULL;
        if ($prop['type'] == 'date' && !empty($default_value)) {
          $default_value['from'] = $default_value['from'] == '' ? '' : format_date(strtotime($default_value['from']));
          $default_value['to'] = $default_value['to'] == '' ? '' : format_date(strtotime($default_value['to']));
        }
        if ($prop['type'] == 'date') {
          $form['filter_fieldset']['filters']['properties'][$key]['from'] = array(
            '#type' => $field_type,
            '#title' => t('@label from', array(
              '@label' => $prop['label'],
            )),
            '#attributes' => array(
              'class' => array(
                "redhen-field-type-{$prop['type']}",
              ),
            ),
            '#default_value' => $default_value['from'],
          );
          $form['filter_fieldset']['filters']['properties'][$key]['to'] = array(
            '#type' => $field_type,
            '#title' => t('@label to', array(
              '@label' => $prop['label'],
            )),
            '#attributes' => array(
              'class' => array(
                "redhen-field-type-{$prop['type']}",
              ),
            ),
            '#default_value' => $default_value['to'],
          );
        }
        else {
          $form['filter_fieldset']['filters']['properties'][$key] = array(
            '#type' => $field_type,
            '#title' => check_plain($prop['label']),
            '#attributes' => array(
              'class' => array(
                "redhen-field-type-{$prop['type']}",
              ),
            ),
            '#default_value' => $default_value,
          );
        }
        if ($field_type == 'select' && isset($prop['options list'])) {
          $select_options = array(
            '' => t('-- Any --'),
          ) + call_user_func($prop['options list']);
          $form['filter_fieldset']['filters']['properties'][$key]['#options'] = $select_options;
        }
      }
    }

    // Add bundles; will load additional field filters on change.
    $type_options = array(
      '' => t('-- Any --'),
    );
    $entity_info = entity_get_info($entity_type);
    foreach ($entity_info['bundles'] as $key => $bundle) {
      if ($entity_type == 'message' && strpos($key, 'redhen') === FALSE) {
        continue;
      }
      $type_options[$key] = $bundle['label'];
    }

    // Single bundle, just load fields.
    if (count($entity_info['bundles']) == 1) {
      $bundle = array_keys($entity_info['bundles']);
      $bundle = $bundle[0];
      redhen_filter_form_fields($form, $form_state, $entity_type, $bundle);
    }
    else {
      $form['filter_fieldset']['filters']['bundle'] = array(
        '#type' => 'select',
        '#title' => t('@type types', array(
          '@type' => $entity_info['label'],
        )),
        '#options' => $type_options,
        '#default_value' => isset($_GET['bundle']) ? $_GET['bundle'] : NULL,
        '#ajax' => array(
          'callback' => 'redhen_filter_fields_callback',
          'wrapper' => 'redhen_filter_fields_container',
          'method' => 'replace',
          'effect' => 'fade',
          'progress' => array(
            'type' => 'throbber',
            'message' => t('Retrieving fields for this @entity_type type.', array(
              '@entity_type' => $entity_info['label'],
            )),
          ),
        ),
      );
      $form['filter_fieldset']['filters']['fields'] = array(
        '#prefix' => '<div id="redhen_filter_fields_container">',
        '#suffix' => '</div>',
      );
    }
    $form['filter_fieldset']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Apply'),
    );
    $form['filter_fieldset']['reset'] = array(
      '#type' => 'submit',
      '#value' => t('Reset'),
      '#limit_validation_errors' => array(),
      '#submit' => array(
        'redhen_filter_form_reset',
      ),
    );
  }

  // Add the fields on an ajax type change event or if a filter is being passed.
  if (!empty($form_state['values']['filters']['bundle']) || isset($_GET['bundle'])) {
    $bundle = !empty($form_state['values']['filters']['bundle']) ? $form_state['values']['filters']['bundle'] : $_GET['bundle'];
    redhen_filter_form_fields($form, $form_state, $entity_type, $bundle);
  }
  return $form;
}

/**
 * AJAX callback to return fields for a given type.
 */
function redhen_filter_fields_callback($form, $form_state) {
  return $form['filter_fieldset']['filters']['fields'];
}

/**
 * Validation callback for filter form.
 */
function redhen_filter_form_validate($form, &$form_state) {

  // Todo: Date validation?
}

/**
 * Submit handler for redhen_contact_filter_form().
 */
function redhen_filter_form_submit($form, &$form_state) {
  $filters = $form_state['values']['filters'];
  $form_state['redirect'] = array(
    $_GET['q'],
    array(
      'query' => $filters,
    ),
  );
}

/**
 * Submit handler to reset the filter form.
 */
function redhen_filter_form_reset($form, &$form_state) {
  $form_state['redirect'] = array(
    $_GET['q'],
  );
}

/**
 * Populate a form array with field filters for given bundle.
 *
 * @param array $form
 *   Form to alter.
 * @param array $form_state
 *   Form state to alter.
 * @param string $entity_type
 *   Entity type.
 * @param string $bundle
 *   Bundle.
 */
function redhen_filter_form_fields(&$form, &$form_state, $entity_type, $bundle) {
  $fields = field_info_instances($entity_type, $bundle);
  $form['filter_fieldset']['filters']['fields'] = array(
    '#id' => 'redhen_filter_fields_container',
  );

  // If there are multiple bundle types, show which one is current.
  if (isset($form['filter_fieldset']['filters']['bundle'])) {
    $form['filter_fieldset']['filters']['fields']['#type'] = 'fieldset';
    $form['filter_fieldset']['filters']['fields']['#title'] = t('Filter by %bundle specific fields', array(
      '%bundle' => $bundle,
    ));
  }
  else {
    $form['filter_fieldset']['filters']['fields']['#type'] = 'container';
  }
  $filters_count = 0;
  if (!empty($fields)) {
    if (!isset($form_state['field'])) {
      $form_state['field'] = array();
    }

    // Loop through each field adding a filter.
    $filters_count = 0;
    foreach ($fields as $field => $instance) {
      $field_info = field_info_field($instance['field_name']);
      $filters_count++;

      // Insert the widget.
      // field_default_form() assumes the $form has a #parents property.
      $element = array(
        '#parents' => array(),
      );

      // Because of the redirect in redhen_filter_form_submit(), $form_state
      // has no values. Instead, read directly from $_GET.
      $items = isset($_GET['fields'][$field]) ? $_GET['fields'][$field] : array(
        LANGUAGE_NONE => array(),
      );
      $instance['required'] = FALSE;
      $instance['description'] = '';
      $field_info['cardinality'] = 1;

      // Filter out field types we know break the filter form.
      $black_list = redhen_filter_form_blacklist();
      if (in_array($field_info['type'], $black_list)) {
        continue;
      }

      // Set up specific field types.
      switch ($field_info['type']) {

        // Set up date fields.
        case 'date':
        case 'datestamp':
        case 'datetime':

          // Ensure we have a 'to' date.
          $field_info['settings']['todate'] = 'required';

          // In case date repeat is present, disable it.
          $field_info['settings']['repeat'] = FALSE;
          break;
      }

      // The last argument to field_default_form() fetches a single delta.
      $additions = field_default_form($entity_type, NULL, $field_info, $instance, LANGUAGE_NONE, $items[LANGUAGE_NONE], $element, $form_state, 0);
      foreach ($additions as $field_name => $addition) {

        // Remove label and other options from RedHen email fields.
        // TODO: Explore having these available as filters.
        if ($field_info['type'] == 'redhen_email') {
          unset($addition[LANGUAGE_NONE][0]['options']);
          unset($addition[LANGUAGE_NONE][0]['#attached']);
        }

        // TODO: Handle country ajax post back. It currently corrupts the form.
        if ($field_info['type'] == 'addressfield') {

          // This hack sets up the form with the default country.
          $addition[LANGUAGE_NONE][0]['country']['#access'] = FALSE;
        }

        // Append an explanation on the handling of boolean values.
        if ($field_info['type'] == 'list_boolean') {
          $addition[LANGUAGE_NONE]['#type'] = 'radios';
          $addition[LANGUAGE_NONE]['#options'] = array(
            0 => t('False'),
            1 => t('True'),
            'skip' => t('Skip'),
          );
          $addition[LANGUAGE_NONE]['#description'] = $addition[LANGUAGE_NONE]['#description'] . t('This boolean checkbox has been converted to radio buttons to allow filtering for false as well as skipping non-required fields. .');
        }
        $form['filter_fieldset']['filters']['fields'][$field_name] = $addition;
      }
    }
  }

  // Show a message if there is more than one bundle and this one has no
  // applicable fields.
  if (!$filters_count && isset($form['filter_fieldset']['filters']['bundle'])) {
    $form['filter_fieldset']['filters']['fields']['message'] = array(
      '#markup' => t('There are no additional fields for %bundle.', array(
        '%bundle' => $bundle,
      )),
    );
  }
}

Functions

Name	Description
redhen_filter_fields_callback	AJAX callback to return fields for a given type.
redhen_filter_form	Returns the form to filter redhen entity lists.
redhen_filter_form_fields	Populate a form array with field filters for given bundle.
redhen_filter_form_reset	Submit handler to reset the filter form.
redhen_filter_form_submit	Submit handler for redhen_contact_filter_form().
redhen_filter_form_validate	Validation callback for filter form.