jammer_generic.module in Jammer 6

Remove configured form elements from forms.

File

jammer_generic.module

<?php

/**
 * @file
 * Remove configured form elements from forms.
 */

/**
 * Implementation of hook_menu().
 */
function jammer_generic_menu() {
  $items['admin/settings/jammer/generic'] = array(
    'title' => 'Generic Jammer',
    'description' => 'Remove any item from any forms.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      '_jammer_generic_admin_settings',
    ),
    'access arguments' => array(
      'administer site configuration',
    ),
  );
  $items['admin/settings/jammer/generic/delete/%jammer_generic'] = array(
    'title' => 'Delete generic jammer element',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'jammer_generic_confirm_delete',
      5,
    ),
    'access arguments' => array(
      'administer site configuration',
    ),
    'type' => MENU_CALLBACK,
  );
  return $items;
}
function jammer_generic_load($key) {
  $current_settings = variable_get('jammer_generic_elements', array());
  return isset($current_settings[$key]) ? $key : FALSE;
}

/**
 * Implementation of menu callback.
 */
function _jammer_generic_admin_settings() {
  $form = array();
  $form['jammer_generic_element_id_info'] = array(
    '#type' => 'item',
    '#value' => t('Before you use this module, please be sure you completely understand what you\'re doing. ' . 'Review the information available at !drupal_url. Generic Jammer will go through each ' . 'part of a form recursively setting !access_url, so make sure you have accounted for any side effects of ' . 'removing the form elements you plan to remove. This includes making sure there are default values for the ' . 'element if needed and removing any dependant javascript that may rely on the element being there. Always test ' . 'before releasing changes to a live production site.', array(
      '!drupal_url' => l('Form API Quickstart Guide', 'http://drupal.org/node/751826'),
      '!access_url' => l('#access', 'http://api.drupal.org/api/drupal/developer--topics--forms_api_reference.html#access'),
    )),
  );
  $form['jammer_generic_form_id'] = array(
    '#type' => 'textfield',
    '#title' => t('Form id'),
    '#required' => TRUE,
    '#description' => t('The form id containing the element you want to remove. Node form ids are of format: nodetypename_node_form'),
  );
  $form['jammer_generic_element_id'] = array(
    '#type' => 'textfield',
    '#title' => t('Element id'),
    '#required' => TRUE,
    '#description' => t('The element id of the element you want to remove.'),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => 'Jam element',
  );
  $current_settings = variable_get('jammer_generic_elements', array());
  $headers = array(
    t('Form ID'),
    t('Element ID'),
    t('Delete'),
  );
  $data = array();
  foreach ($current_settings as $key => $value) {
    $data[] = array(
      $value['jammer_generic_form_id'],
      $value['jammer_generic_element_id'],
      l(t('Delete'), 'admin/settings/jammer/generic/delete/' . $key),
    );
  }
  if (!empty($data)) {
    $form['configured'] = array(
      '#type' => 'fieldset',
      '#title' => 'Jammed form elements',
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    $form['configured']['table'] = array(
      '#type' => 'item',
      '#value' => theme('table', $headers, $data),
    );
  }
  return $form;
}

/**
 * Implementation of submit for form.
 */
function _jammer_generic_admin_settings_submit($form, &$form_state) {
  $form_values = $form_state['values'];
  if ($form_values['jammer_generic_form_id'] == '-jammer-generic-admin-settings') {
    drupal_set_message(t('You cannot jam elements of the generic jammer form.'));
    return;
  }
  $current_settings = variable_get('jammer_generic_elements', array());
  foreach ($current_settings as $key => $value) {
    if ($value['jammer_generic_form_id'] == $form_values['jammer_generic_form_id'] && $value['jammer_generic_element_id'] == $form_values['jammer_generic_element_id']) {
      drupal_set_message(t('Setting saved.'));

      // Setting was already set, not going to repeat it.
      return;
    }
  }
  $current_settings[] = array(
    'jammer_generic_form_id' => $form_values['jammer_generic_form_id'],
    'jammer_generic_element_id' => $form_values['jammer_generic_element_id'],
  );
  variable_set('jammer_generic_elements', $current_settings);
  drupal_set_message(t('Setting saved.'));
}

/**
 * Returns a confirmation page for deleting a jammed element.
 *
 * @return array
 */
function jammer_generic_confirm_delete(&$form_state, $key) {
  $confirm_form['key'] = array(
    '#type' => 'value',
    '#value' => $key,
  );
  return confirm_form($confirm_form, t('Are you sure you want to un-jam this form element?'), 'admin/settings/jammer/generic', t('Deleting this setting will cause previously hidden form elements to display again. To review the settings on this jammed form element, please visit <a href="@content">Generic Jammer administration</a> first. This action cannot be undone.', array(
    '@content' => url('admin/settings/jammer/generic'),
  )), t('Delete'), t('Cancel'));
}

/**
 * Deletes settings that would jam form elements.
 */
function jammer_generic_confirm_delete_submit($form, &$form_state) {
  $current_settings = variable_get('jammer_generic_elements', array());
  unset($current_settings[$form_state['values']['key']]);
  variable_set('jammer_generic_elements', $current_settings);
  $form_state['redirect'] = 'admin/settings/jammer/generic';
}

/**
 * Implementation of hook_form_alter().
 */
function jammer_generic_form_alter(&$form, $form_state, $form_id) {
  if ($form['#id'] != '-jammer-generic-admin-settings') {
    $current_settings = variable_get('jammer_generic_elements', array());
    foreach ($current_settings as $key => $value) {
      if ($value['jammer_generic_form_id'] == $form_id) {
        $element_id = $value['jammer_generic_element_id'];

        // Crawl the form for this element to remove it.
        foreach (element_children($form) as $key) {
          $form[$key] = _jammer_generic_remove_element($form[$key], $key, $element_id);

          // Recursive.
        }
      }
    }
  }
}

/**
 * Helper function, recursive.
 */
function _jammer_generic_remove_element($value_array, $key, $element_id) {
  if ($key == $element_id) {
    $value_array['#access'] = FALSE;
  }
  foreach (element_children($value_array) as $value_key) {
    $value_array[$value_key] = _jammer_generic_remove_element($value_array[$value_key], $value_key, $element_id);

    // Recursive.
  }
  return $value_array;
}

Functions

Name	Description
jammer_generic_confirm_delete	Returns a confirmation page for deleting a jammed element.
jammer_generic_confirm_delete_submit	Deletes settings that would jam form elements.
jammer_generic_form_alter	Implementation of hook_form_alter().
jammer_generic_load
jammer_generic_menu	Implementation of hook_menu().
_jammer_generic_admin_settings	Implementation of menu callback.
_jammer_generic_admin_settings_submit	Implementation of submit for form.
_jammer_generic_remove_element	Helper function, recursive.