form_builder.admin.inc in Form Builder 6

Same filename and directory in other branches
form_builder.admin.inc Administrative interface for editing forms.
File

includes/form_builder.admin.inc
View source
<?php

/**
 * @file form_builder.admin.inc
 * Administrative interface for editing forms.
 */

/**
 * Main form building interface. Can be used as a menu callback.
 *
 * @param $form_type
 *   The type of form being edited. Usually the name of the providing module.
 * @param $form_id
 *   The unique identifier for the form being edited with the type.
 */
function form_builder_interface($form_type, $form_id) {
  module_load_include('inc', 'form_builder', 'includes/form_builder.api');
  module_load_include('inc', 'form_builder', 'includes/form_builder.cache');

  // Set the current form type (used for display of the sidebar block).
  form_builder_active_form($form_type, $form_id);

  // Load the current state of the form, or create a new cache if needed.
  $form = form_builder_cache_load($form_type, $form_id);
  if (!$form) {
    $form = form_builder_load_form($form_type, $form_id);
    form_builder_cache_save($form_type, $form_id, $form);
  }
  $output = '';
  $output .= drupal_get_form('form_builder_preview', $form, $form_type, $form_id);
  $output .= drupal_get_form('form_builder_positions', $form, $form_type, $form_id);
  return $output;
}

/**
 * Menu callback for adding a field.
 */
function form_builder_add_page($form_type, $form_id, $element_type) {
  _form_builder_add_element($form_type, $form_id, $element_type);
}

/**
 * Menu callback for cloning a field.
 */
function form_builder_clone_page($form_type, $form_id, $element_id) {
  _form_builder_add_element($form_type, $form_id, NULL, $element_id);
}

/**
 * Menu callback helper for adding or cloning a field.
 *
 * If the $element_id parameter is provided, the new field will be cloned from
 * the corresponding field (and the $element_type parameter will be ignored).
 * Otherwise, a new field of type $element_type will be added from scratch.
 */
function _form_builder_add_element($form_type, $form_id, $element_type, $element_id = NULL) {
  module_load_include('inc', 'form_builder', 'includes/form_builder.api');
  module_load_include('inc', 'form_builder', 'includes/form_builder.cache');
  $fields = form_builder_get_form_type($form_type);
  $cache = form_builder_cache_load($form_type, $form_id);
  $element = NULL;

  // If the field is being cloned, copy the original from the current form
  // structure.
  if (isset($element_id)) {
    $element = form_builder_get_elements($cache, array(
      $element_id,
    ));
    if ($element) {

      // We expect a one-element array since we only passed one element ID to
      // form_builder_get_elements().
      $element = array_shift($element);

      // Remove the key so that a new one will be generated.
      unset($element['#key']);

      // Change the title to avoid confusion, and to avoid duplicate
      // auto-generated machine names.
      if (isset($element['#title'])) {
        $element['#title'] = t('Copy of !title', array(
          '!title' => $element['#title'],
        ));
      }

      // Set the element type to the correct value so it will be used
      // consistently throughout this function.
      $element_type = $element['#type'];
    }
  }
  elseif (isset($fields[$element_type]['default'])) {
    $element = $fields[$element_type]['default'];
  }
  if ($element) {
    $element_id = isset($_REQUEST['element_id']) ? $_REQUEST['element_id'] : 'new_' . time();

    // Set the element ID to a hard-coded value if a unique field type.
    if (isset($fields[$element_type]['unique']) && $fields[$element_type]['unique']) {
      $element_id = $element_type;
    }
    $element['#form_builder']['element_id'] = $element_id;
    $element['#form_builder']['is_new'] = TRUE;
    $element = form_builder_add_default_properties($element, $form_type, $element_id);
    $element['#weight'] = count(element_children($cache));
    drupal_alter('form_builder_add_element', $element, $form_type, $form_id);

    // Save any element ID set by the hook_form_builder_add_element_alter().
    $element_id = $element['#form_builder']['element_id'];
    form_builder_cache_field_save($form_type, $form_id, $element);
    if (isset($_REQUEST['js'])) {
      $element = form_builder_cache_field_load($form_type, $form_id, $element_id);
      $form_cache = form_builder_cache_load($form_type, $form_id);
      $data = array(
        'formType' => $form_type,
        'formId' => $form_id,
        'elementId' => $element_id,
        'html' => form_builder_field_render($form_type, $form_id, $element_id),
        'positionForm' => drupal_get_form('form_builder_positions', $form_cache, $form_type, $form_id),
      );
      form_builder_json_output($data);
      exit;
    }
  }

  // Otherwise return to the previous page.
  drupal_goto();
}

/**
 * Menu callback for configuring a field.
 */
function form_builder_configure_page($form_type, $form_id, $element_id) {
  $output = drupal_get_form('form_builder_field_configure', $form_type, $form_id, $element_id);
  if (isset($_REQUEST['js'])) {

    // Return the newly changed field.
    if (isset($_REQUEST['return'])) {
      form_builder_field_json($form_type, $form_id, $element_id);
    }
    else {
      $data = array(
        'formType' => $form_type,
        'formId' => $form_id,
        'elementId' => $element_id,
        'html' => $output,
        'errors' => form_get_errors(),
      );
      form_builder_json_output($data);
      exit;
    }
  }
  return $output;
}

/**
 * Menu callback for removing a field.
 */
function form_builder_remove_page($form_type, $form_id, $element_id) {
  $output = drupal_get_form('form_builder_field_remove', $form_type, $form_id, $element_id);
  if (isset($_REQUEST['js']) && !isset($_REQUEST['return'])) {

    // This after build function immediately returns the form as JSON.
    $data = array(
      'formType' => $form_type,
      'formId' => $form_id,
      'elementId' => $element_id,
      'html' => $output,
    );
    form_builder_json_output($data);
    exit;
  }
  return $output;
}

/**
 * Render the palette of fields to add to a form.
 */
function form_builder_field_palette() {
  $active = form_builder_active_form();
  $output = NULL;
  if (isset($active)) {
    $fields = form_builder_get_form_type($active['form_type']);
    $groups = module_invoke_all('form_builder_palette_groups');

    // TODO: We shouldn't have to clear the cache here.
    $form = form_builder_cache_load($active['form_type'], $active['form_id'], NULL, TRUE);
    $active_fields = form_builder_get_element_types($form);
    foreach ($fields as $key => $field) {
      if ($field['unique'] && in_array($key, $active_fields)) {
        $fields[$key]['in_use'] = TRUE;
      }
      if ($field['addable'] == FALSE) {
        unset($fields[$key]);
      }
    }
    $output = theme('form_builder_field_palette', $fields, $groups, $active['form_type'], $active['form_id']);
  }
  return $output;
}

/**
 * Form. Given a form array, present it for editing in a preview.
 */
function form_builder_preview(&$form_state, $form, $form_type, $form_id) {

  // Make modifications to all form elements recursively.
  $element_ids = form_builder_preview_prepare($form, $form_type, $form_id);

  // Record all the element IDs within the entire form.
  $form['#form_builder']['element_ids'] = $element_ids;
  $form['#form_builder']['form_type'] = $form_type;
  $form['#form_builder']['form_id'] = $form_id;

  // Add a pre_render to the entire form itself.
  $form['#pre_render'][] = 'form_builder_pre_render_form';
  $form['#form_builder_wrappers'] = array(
    'form_builder_wrapper',
  );
  $form['#post_render'][] = 'form_builder_wrappers';
  return $form;
}

/**
 * Form containing all the current weights and parents of elements.
 */
function form_builder_positions(&$form_state, $form_cache, $form_type, $form_id) {
  $form = array(
    '#tree' => TRUE,
    '#form_builder' => array(
      'form_type' => $form_type,
      'form_id' => $form_id,
      'form' => $form_cache,
    ),
  );
  _form_builder_positions_prepare($form, $form_cache);

  // Drupal MUST have a button to register submissions.
  // Add a button even though the form is only submitted via AJAX.
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Update'),
  );
  return $form;
}

/**
 * Recursive helper for form_builder_positions(). Add weight fields.
 */
function _form_builder_positions_prepare(&$form, $form_cache, $parent_id = FORM_BUILDER_ROOT) {
  foreach (element_children($form_cache) as $key) {

    // Keep record of the current parent ID.
    $previous_parent_id = $parent_id;
    if (isset($form_cache[$key]['#form_builder']['element_id'])) {

      // Set the parent ID for this element.
      $form_cache[$key]['#form_builder']['parent_id'] = $parent_id;
      $element_id = $form_cache[$key]['#form_builder']['element_id'];
      $parent_id = $element_id;
      $form[$element_id]['weight'] = array(
        '#type' => 'hidden',
        '#default_value' => isset($form_cache[$key]['#weight']) ? $form_cache[$key]['#weight'] : 0,
        '#attributes' => array(
          'class' => 'form-builder-weight form-builder-element-' . $element_id,
        ),
      );
      $form[$element_id]['parent'] = array(
        '#type' => 'hidden',
        '#default_value' => $form_cache[$key]['#form_builder']['parent_id'],
        '#attributes' => array(
          'class' => 'form-builder-parent form-builder-element-' . $element_id,
        ),
      );
    }
    _form_builder_positions_prepare($form, $form_cache[$key], $parent_id);
    $parent_id = $previous_parent_id;
  }
}

/**
 * Submit handler for the form_builder_positions form.
 */
function form_builder_positions_submit(&$form, &$form_state) {
  module_load_include('inc', 'form_builder', 'includes/form_builder.api');
  module_load_include('inc', 'form_builder', 'includes/form_builder.cache');
  $form_type = $form['#form_builder']['form_type'];
  $form_id = $form['#form_builder']['form_id'];
  $form_cache = $form['#form_builder']['form'];
  foreach (element_children($form) as $element_id) {

    // Skip items without weight value (like the form token, build_id, etc).
    if (!isset($form[$element_id]['weight'])) {
      continue;
    }

    // Check for changed weights or parents.
    $element = form_builder_get_element($form_cache, $element_id);
    $element['#weight'] = $form_state['values'][$element_id]['weight'];
    $element['#form_builder']['parent_id'] = $form_state['values'][$element_id]['parent'];
    form_builder_set_element($form_cache, $element);
  }

  // Save all the changes made.
  form_builder_cache_save($form_type, $form_id, $form_cache);

  // Don't redirect, which will cause an unnecessary HTTP request.
  $form_state['redirect'] = FALSE;
}

/**
 * Output the wrapper around the form_builder preview.
 *
 * Optionally outputs the field palette if it is not already available as a
 * block.
 */
function theme_form_builder_wrapper($element, $content) {
  $output = '';
  $output .= '<div id="form-builder-wrapper" class="' . ($element['#show_palette'] ? 'with-palette' : 'no-palette') . '">';
  if ($element['#show_palette']) {
    $output .= '<div id="form-builder-fields">';
    $output .= '<div class="block">';
    $output .= form_builder_field_palette();
    $output .= '</div>';
    $output .= '</div>';
  }
  $output .= '<div id="form-builder">';
  if (isset($element['#title'])) {
    $output .= '<h3 class="form-builder-title">' . check_plain($element['#title']) . '</h3>';
  }

  // Add the contents of the form and close the wrappers.
  $output .= $content;
  $output .= '</div>';

  // #form-builder.
  $output .= '</div>';

  // #form-builder-wrapper.
  return $output;
}

/**
 * Output the wrapper around a form_builder element with configure/remove links.
 */
function theme_form_builder_element_wrapper($element, $content) {
  $removable = isset($element['#form_builder']['removable']) ? $element['#form_builder']['removable'] : TRUE;
  $configurable = isset($element['#form_builder']['configurable']) ? $element['#form_builder']['configurable'] : TRUE;
  $cloneable = form_builder_menu_field_access('clone', $element['#form_builder']['form_type'], $element['#form_builder']['form_id'], $element['#form_builder']['element_id']);
  $output = '';
  $output .= '<div class="form-builder-wrapper">';
  if ($removable || $configurable) {
    $output .= '<div class="form-builder-title-bar">';
    $output .= '<span class="form-builder-links">';
    if ($removable) {
      $output .= l('<span class="remove">' . t('Remove') . '</span>', 'admin/build/form-builder/remove/' . $element['#form_builder']['form_type'] . '/' . $element['#form_builder']['form_id'] . '/' . $element['#form_builder']['element_id'], array(
        'html' => TRUE,
        'attributes' => array(
          'class' => 'remove',
          'title' => t('Remove'),
        ),
        'query' => drupal_get_destination(),
      ));
    }
    if ($removable && $configurable) {
      $output .= ' ';
    }
    if ($configurable) {
      $output .= l('<span class="configure">' . t('Configure') . '</span>', 'admin/build/form-builder/configure/' . $element['#form_builder']['form_type'] . '/' . $element['#form_builder']['form_id'] . '/' . $element['#form_builder']['element_id'], array(
        'html' => TRUE,
        'attributes' => array(
          'class' => 'configure',
          'title' => t('Configure'),
        ),
        'query' => drupal_get_destination(),
      ));
    }
    $output .= '</span>';
    $output .= '</div>';
  }
  if ($cloneable) {
    $output .= '<div class="form-builder-bottom-title-bar">';
    $output .= '<span class="form-builder-bottom-links">';
    $output .= l('<span class="clone">' . t('Copy') . '</span>', 'admin/build/form-builder/clone/' . $element['#form_builder']['form_type'] . '/' . $element['#form_builder']['form_id'] . '/' . $element['#form_builder']['element_id'], array(
      'html' => TRUE,
      'attributes' => array(
        'class' => 'clone',
        'title' => t('Copy'),
      ),
      'query' => drupal_get_destination(),
    ));
    $output .= '</span>';
    $output .= '</div>';
  }
  $output .= '<div class="form-builder-element form-builder-element-' . $element['#type'] . '" id="form-builder-element-' . $element['#form_builder']['element_id'] . '">';

  // TODO: Overlay image: good idea or bad idea? Prevents any interaction with
  // form elements in the preview.

  //$output .= theme('image', drupal_get_path('module', 'form_builder') .'/images/blank.gif', '', '', array('width' => '1', 'height' => '1', 'class' => 'form-builder-disable'));
  $output .= $content;
  $output .= '</div></div>';
  return $output;
}

/**
 * Placeholder for an entirely empty form before any fields are added.
 */
function theme_form_builder_empty_form() {
  $output = '';
  $output .= '<div class="form-builder-empty-form form-builder-empty-placeholder">';
  $output .= '<span>' . t('Drag a field from the palette to add it to this form.') . '</span>';
  $output .= '</div>';
  return $output;
}

/**
 * Placeholder for empty fieldsets during drag and drop.
 */
function theme_form_builder_empty_fieldset() {
  $output = '';
  $output .= '<div class="form-builder-wrapper form-builder-empty-placeholder">';
  $output .= '<span>' . t('This fieldset is empty. Drag a form element into it.') . '</span>';
  $output .= '</div>';
  return $output;
}

/**
 * Message shown in custom field configure forms when no field is selected.
 *
 * Note that this message is not displayed using the default field presentation.
 * Modules or themes can set a custom field configuration form location by
 * specifying a Drupal.settings.formBuilder.configureFormSelector value.
 */
function theme_form_builder_no_field_selected() {
  $output = '';
  $output .= '<div class="field-settings-message">';
  $output .= t('No field selected');
  $output .= '</div>';
  return $output;
}

/**
 * Message shown in custom field configure forms when a field is loading.
 *
 * @see theme_form_builder_no_field_selected().
 */
function theme_form_builder_field_loading() {
  $output = '';
  $output .= '<div class="field-settings-message">';
  $output .= t('Loading...');
  $output .= '</div>';
  return $output;
}

/**
 * Block for adding new fields.
 *
 * @param $fields
 *   A list of all fields can be added to the current form type.
 * @param $groups
 *   A list of groups that fields may be sorted into. Each field is assigned
 *   a 'palette_group' property which corresponds to one of these groups.
 * @param $form_type
 *   The form type to which these blocks apply.
 * @param $form_id
 *   The form ID that is being edited.
 */
function theme_form_builder_field_palette($fields, $groups, $form_type, $form_id) {
  $output = '';
  $lists = array();
  foreach ($fields as $field_name => $field) {
    $class = array(
      'field-' . $field_name,
      'form-builder-palette-element',
    );
    $style = '';

    // If a field is unique, add a special class to identify it.
    if ($field['unique']) {
      $class[] = 'form-builder-unique';
      $class[] = 'form-builder-element-' . $field_name;

      // If already in use, do not display it in the list.
      if (!empty($field['in_use'])) {
        $style = 'display: none;';
      }
    }
    $lists[$field['palette_group']]['#weight'] = $groups[$field['palette_group']]['weight'];
    $lists[$field['palette_group']][] = array(
      'data' => l($field['title'], 'admin/build/form-builder/add/' . $form_type . '/' . $form_id . '/' . $field_name, array(
        'query' => drupal_get_destination(),
      )),
      'class' => implode(' ', $class),
      'style' => $style,
    );
  }

  // Sort the lists by weight.
  uasort($lists, 'element_sort');
  $output .= '<div id="form-builder-field-palette">';
  foreach ($lists as $group => $list) {
    unset($list['#weight']);
    $output .= theme('item_list', $list, count($lists) > 1 ? $groups[$group]['title'] : t('Add a field'), 'ul', array(
      'class' => 'form-builder-fields clear-block',
    ));
  }
  $output .= '</div>';
  return $output;
}

/**
 * Take a form structure and add a prebuild function to every element.
 */
function form_builder_pre_render($element) {
  $element['#form_builder_wrappers'][] = 'form_builder_element_wrapper';
  $element['#post_render'][] = 'form_builder_wrappers';
  if ($element['#form_builder']['element_type'] == 'fieldset') {
    $element['#attributes']['class'] = isset($element['#attributes']['class']) ? $element['#attributes']['class'] . ' form-builder-fieldset' : 'form-builder-fieldset';
  }
  if (isset($element['#type']) && $element['#type'] == 'fieldset' && count(element_children($element)) == 0) {
    $element['#children'] = theme('form_builder_empty_fieldset');
  }

  // Allow modules to make modifications to this element.
  drupal_alter('form_builder_preview', $element, $element['#form_builder']['form_type'], $element['#form_builder']['form_id']);
  return $element;
}

/**
 * Pre-render function to alter the form being edited by Form builder.
 *
 * This function modifies the form element itself and sets a #title to label the
 * form preview and an #show_palette property to indicate to the theme wrapper
 * whether the field palette should be added.
 */
function form_builder_pre_render_form($form) {
  global $theme;
  jquery_ui_add(array(
    'ui.draggable',
    'ui.droppable',
    'ui.sortable',
  ));
  drupal_add_js('misc/jquery.form.js');
  drupal_add_js(drupal_get_path('module', 'form_builder') . '/form_builder.js');

  // TODO: This JS file should be loaded dynamically as needed.
  drupal_add_js(drupal_get_path('module', 'options_element') . '/options_element.js');
  drupal_add_js('misc/tabledrag.js');
  drupal_add_js('misc/collapse.js');
  $settings = array(
    'emptyForm' => theme('form_builder_empty_form'),
    'emptyFieldset' => theme('form_builder_empty_fieldset'),
    'noFieldSelected' => theme('form_builder_no_field_selected'),
    'fieldLoading' => theme('form_builder_field_loading'),
  );
  drupal_add_js(array(
    'formBuilder' => $settings,
  ), 'setting');
  drupal_add_css(drupal_get_path('module', 'form_builder') . '/form_builder.css');
  drupal_add_css(drupal_get_path('module', 'options_element') . '/options_element.css');

  // We can't have forms inside of forms, so change this entire form a markup.
  $form['#type'] = 'markup';

  // Set a title for the preview if none exists.
  $form['#title'] = !isset($form['#title']) ? t('Form preview') : $form['#title'];

  // Remove unnecessary FAPI elements.
  unset($form['form_build_id']);
  unset($form['form_token']);
  unset($form['form_builder_preview']);

  // Check if the Form Builder block is enabled.
  // Otherwise make our own columns.
  if (!isset($form['#show_palette'])) {
    if (module_exists('block')) {
      $form['#show_palette'] = !db_result(db_query("SELECT status FROM {blocks} WHERE module = 'form_builder' AND theme = '%s'", $theme));
    }
    else {
      $form['#show_palette'] = TRUE;
    }
  }
  if ($theme == 'garland' || $theme == 'minnelli') {
    drupal_add_css(drupal_get_path('module', 'form_builder') . '/form_builder.garland.css', 'theme');
  }
  return $form;
}
function form_builder_after_build($element) {
  $element['#attributes']['readonly'] = 'readonly';
  foreach (element_children($element) as $key) {
    $element[$key] = form_builder_after_build($element[$key]);
  }
  return $element;
}

/**
 * Before editing a form, modify it slightly to add functionality used in
 * the preview and disable use of the actual form fields in any way.
 *
 * @return
 *   A list of all element_ids currently used within this form.
 */
function form_builder_preview_prepare(&$form, $form_type, $form_id, $parent_id = FORM_BUILDER_ROOT) {
  $element_ids = array();
  foreach (element_children($form) as $key) {

    // Keep record of the current parent ID.
    $previous_parent_id = $parent_id;
    if (isset($form[$key]['#form_builder']['element_id'])) {
      $element_ids[] = $form[$key]['#form_builder']['element_id'];
      $form[$key]['#pre_render'][] = 'form_builder_pre_render';
      $form[$key]['#form_builder']['form_type'] = $form_type;
      $form[$key]['#form_builder']['form_id'] = $form_id;
      $form[$key]['#form_builder']['parent_id'] = $parent_id;
      $parent_id = $form[$key]['#form_builder']['element_id'];
    }

    // Search within this element for further form elements.
    $additional_ids = form_builder_preview_prepare($form[$key], $form_type, $form_id, $parent_id);
    $element_ids = array_merge($element_ids, $additional_ids);
    $parent_id = $previous_parent_id;
  }
  return $element_ids;
}

/**
 * Form for editing a field.
 */
function form_builder_field_configure($form_state, $form_type, $form_id, $element_id) {
  module_load_include('inc', 'form_builder', 'includes/form_builder.api');
  module_load_include('inc', 'form_builder', 'includes/form_builder.cache');
  $element = form_builder_cache_field_load($form_type, $form_id, $element_id);

  // Assemble a form made up of all the configurable properties that this type
  // of form supports.
  $form = array();
  foreach (form_builder_get_element_properties($form_type, $element['#form_builder']['element_type']) as $property => $property_settings) {
    if (isset($property_settings['form']) && function_exists($property_settings['form'])) {
      $function = $property_settings['form'];

      // Set a default value on the property to avoid notices.
      $element['#' . $property] = isset($element['#' . $property]) ? $element['#' . $property] : NULL;
      $form = array_merge($form, $function($form_state, $form_type, $element, $property));
    }
  }
  $form['#form_type'] = $form_type;
  $form['#form_id'] = $form_id;
  $form['#element_id'] = $element_id;
  $form['#element'] = $element;
  $form['#pre_render'][] = 'form_builder_field_configure_pre_render';
  $form['form_builder_submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
    '#access' => !isset($_REQUEST['js']),
    '#weight' => 100,
  );
  return $form;
}

/**
 * Pre-render function for the field configuration form.
 */
function form_builder_field_configure_pre_render($form) {

  // Group the properties into separate fieldsets (converted to tabs later).
  $groups = module_invoke_all('form_builder_property_groups', $form['#form_type']);
  foreach (element_children($form) as $key) {

    // If no group is specified, put the element into the default group.
    if (!isset($form[$key]['#form_builder']['property_group']) || !isset($groups[$form[$key]['#form_builder']['property_group']])) {
      if (!isset($form[$key]['#type']) || isset($form[$key]['#type']) && !in_array($form[$key]['#type'], array(
        'hidden',
        'button',
        'submit',
        'value',
        'token',
      ))) {
        $form[$key]['#form_builder']['property_group'] = 'default';
      }
    }
    if (isset($form[$key]['#form_builder']['property_group'])) {
      $group = $form[$key]['#form_builder']['property_group'];

      // We add "_property_group" to the field key to prevent conflicts of
      // property names and group names.
      if (!isset($form[$group . '_property_group'])) {
        $form[$group . '_property_group'] = array(
          '#type' => 'fieldset',
          '#title' => $groups[$group]['title'],
          '#weight' => $groups[$group]['weight'],
          '#collapsible' => isset($groups[$group]['collapsible']) ? $groups[$group]['collapsible'] : FALSE,
          '#collapsed' => isset($groups[$group]['collapsed']) ? $groups[$group]['collapsed'] : FALSE,
          '#attributes' => array(
            'class' => 'form-builder-group',
          ),
        );
      }
      $form[$group . '_property_group'][$key] = $form[$key];
      unset($form[$key]);
    }
  }
  return $form;
}
function form_builder_field_configure_submit(&$form, &$form_state) {
  $form_type = $form['#form_type'];
  $form_id = $form['#form_id'];
  $element_id = $form['#element_id'];
  $element = $form['#element'];

  // Allow each element to do any necessary submission handling.
  foreach (form_builder_get_element_properties($form_type, $element['#form_builder']['element_type']) as $property => $property_settings) {
    if (isset($property_settings['submit'])) {
      foreach ($property_settings['submit'] as $function) {
        if (function_exists($function)) {
          $function($form, $form_state);
        }
      }
    }
  }

  // Allow the element to be updated in a hard-coded fashion by altering the
  // $form['#element'] item. Using this approach skips the property check.
  $element = $form['#element'];

  // Update the field according to the settings in $form_state['values'].
  $saveable = form_builder_get_saveable_properties($form_type, $element);
  foreach ($form_state['values'] as $property => $value) {
    if (in_array($property, $saveable)) {

      // Remove empty properties entirely.
      if ($value === '' || is_null($value)) {
        unset($element['#' . $property]);
      }
      else {
        $element['#' . $property] = $value;
      }
    }
  }

  // Update the form builder cache.
  form_builder_cache_field_save($form_type, $form_id, $element);
  if (isset($_GET['js'])) {

    // Option A: Use the destination variable to do a drupal_goto(). Allows
    // other submit handlers to add on extra functionality.
    // The destination variable takes precedence over $form_state['redirect'].

    //$_REQUEST['destination'] = 'admin/build/form-builder/json/' . $form_type . '/' . $form_id . '/' . $element_id;

    // Option B: Immediately print the JSON and exit. Faster and requires only
    // one HTTP request instead of two. Other submit handlers must be before
    // this on.
    form_builder_field_json($form_type, $form_id, $element_id);
  }
}

/**
 * Form for removing a field.
 */
function form_builder_field_remove($form_state, $form_type, $form_id, $element_id) {
  module_load_include('inc', 'form_builder', 'includes/form_builder.api');
  module_load_include('inc', 'form_builder', 'includes/form_builder.cache');
  $element = form_builder_cache_field_load($form_type, $form_id, $element_id);
  $form = array();
  $form['#form_type'] = $form_type;
  $form['#form_id'] = $form_id;
  $form['#element_id'] = $element_id;
  $question = t('Remove the field %title?', array(
    '%title' => $element['#title'],
  ));
  $path = isset($_GET['destination']) ? $_GET['destination'] : NULL;
  $description = t('Remove the field %title? This field will not be permanently removed until the form configuration is saved.', array(
    '%title' => isset($element['#title']) ? $element['#title'] : $element['#form_builder']['element_id'],
  ));
  $yes = t('Remove');
  return confirm_form($form, $question, $path, $description, $yes);
}
function form_builder_field_remove_submit(&$form, &$form_state) {
  $form_type = $form['#form_type'];
  $form_id = $form['#form_id'];
  $element_id = $form['#element_id'];

  // Update the form builder cache.
  form_builder_cache_field_delete($form_type, $form_id, $element_id);
  if (isset($_GET['js'])) {

    // See form_builder_field_configure_submit() for comparison between using
    // redirect and immediately printing the JSON.

    //$form_state['redirect'] = 'admin/build/form-builder/json/' . $form_type . '/' . $form_id . '/' . $element_id;
    form_builder_field_json($form_type, $form_id, $element_id);
  }
}

/**
 * Render a single field independent of other settings.
 */
function form_builder_field_render($form_type, $form_id, $element_id, $wrapper = FALSE) {
  module_load_include('inc', 'form_builder', 'includes/form_builder.api');
  module_load_include('inc', 'form_builder', 'includes/form_builder.cache');

  // Load the current state of the form and prepare it for rendering.
  $form = form_builder_cache_load($form_type, $form_id);
  $form_state = array(
    'submitted' => FALSE,
  );
  $form = drupal_retrieve_form('form_builder_preview', $form_state, $form, $form_type, $form_id);
  drupal_prepare_form('form_builder_preview', $form, $form_state);
  $form['#post'] = array();
  $form = form_builder('form_builder_preview', $form, $form_state);

  // Get only the element wanted and render it.
  $element = form_builder_get_element($form, $element_id);
  if ($wrapper) {
    $element['#form_builder_wrappers'][] = 'form_builder_element_wrapper';
    $element['#post_render'][] = 'form_builder_wrappers';
  }
  return drupal_render($element);
}

/**
 * Menu callback to display a field as a JSON string.
 */
function form_builder_field_json($form_type, $form_id, $element_id) {
  module_load_include('inc', 'form_builder', 'includes/form_builder.api');
  module_load_include('inc', 'form_builder', 'includes/form_builder.cache');
  $element = form_builder_cache_field_load($form_type, $form_id, $element_id);
  $data = array(
    'formType' => $form_type,
    'formId' => $form_id,
    'elementId' => $element_id,
    'html' => !empty($element) ? form_builder_field_render($form_type, $form_id, $element_id) : '',
    'errors' => form_get_errors(),
  );
  form_builder_json_output($data);
  exit;
}

/**
 * Generic function for outputing Form Builder JSON return responses.
 *
 * Adds status messages, settings, and timestamp to a form builder JSON response
 * and outputs it.
 */
function form_builder_json_output($data) {
  if (!isset($data['messages'])) {
    $data['messages'] = theme('status_messages');
  }
  if (!isset($data['settings'])) {
    $scripts = drupal_add_js();
    if (!empty($scripts['setting'])) {
      $data['settings'] = call_user_func_array('array_merge_recursive', $scripts['setting']);
    }
  }
  if (!isset($data['time'])) {
    $data['time'] = time();
  }
  drupal_json($data);
}
Functions

Name	Description
form_builder_add_page	Menu callback for adding a field.
form_builder_after_build
form_builder_clone_page	Menu callback for cloning a field.
form_builder_configure_page	Menu callback for configuring a field.
form_builder_field_configure	Form for editing a field.
form_builder_field_configure_pre_render	Pre-render function for the field configuration form.
form_builder_field_configure_submit
form_builder_field_json	Menu callback to display a field as a JSON string.
form_builder_field_palette	Render the palette of fields to add to a form.
form_builder_field_remove	Form for removing a field.
form_builder_field_remove_submit
form_builder_field_render	Render a single field independent of other settings.
form_builder_interface	Main form building interface. Can be used as a menu callback.
form_builder_json_output	Generic function for outputing Form Builder JSON return responses.
form_builder_positions	Form containing all the current weights and parents of elements.
form_builder_positions_submit	Submit handler for the form_builder_positions form.
form_builder_preview	Form. Given a form array, present it for editing in a preview.
form_builder_preview_prepare	Before editing a form, modify it slightly to add functionality used in the preview and disable use of the actual form fields in any way.
form_builder_pre_render	Take a form structure and add a prebuild function to every element.
form_builder_pre_render_form	Pre-render function to alter the form being edited by Form builder.
form_builder_remove_page	Menu callback for removing a field.
theme_form_builder_element_wrapper	Output the wrapper around a form_builder element with configure/remove links.
theme_form_builder_empty_fieldset	Placeholder for empty fieldsets during drag and drop.
theme_form_builder_empty_form	Placeholder for an entirely empty form before any fields are added.
theme_form_builder_field_loading	Message shown in custom field configure forms when a field is loading.
theme_form_builder_field_palette	Block for adding new fields.
theme_form_builder_no_field_selected	Message shown in custom field configure forms when no field is selected.
theme_form_builder_wrapper	Output the wrapper around the form_builder preview.
_form_builder_add_element	Menu callback helper for adding or cloning a field.
_form_builder_positions_prepare	Recursive helper for form_builder_positions(). Add weight fields.
You are here

form_builder.admin.inc in Form Builder 6

File

Functions

API Navigation
