rules_forms.admin.inc in Rules Forms Support 7

Administrative forms for Rules Forms module.

File

includes/rules_forms.admin.inc

<?php

/**
 * @file
 * Administrative forms for Rules Forms module.
 */

/**
 * Defines the forms events settings form.
 */
function rules_forms_admin_events($form, &$form_state) {
  $form = array();
  $form['general_settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('General settings'),
    '#collapsible' => TRUE,
  );
  $form['general_settings']['enable_form_activation_message'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable event activation messages on forms'),
    '#default_value' => isset($_SESSION['rules_forms_message']) ? $_SESSION['rules_forms_message'] : FALSE,
    '#description' => t('When checked, a message is shown on every form containing a link to activate events for that form. This message will only be visible for this session.'),
  );
  $form['general_settings']['enable_form_element_info'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable form element inspection tool'),
    '#default_value' => isset($_SESSION['rules_forms_element_info']) ? $_SESSION['rules_forms_element_info'] : FALSE,
    '#description' => t('If checked, the information about each form element will be displayed in popups on active forms. This tool can be used to inspect existing attributes of form elements for determining what actions to take in your rules. Only visible for your currently logged in user account.'),
  );
  $form['general_settings']['settings_submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save settings'),
    '#submit' => array(
      'rules_forms_settings_submit',
    ),
  );
  $form_info = rules_forms_get_form_info();
  if (!empty($form_info)) {
    $options = array();
    foreach ($form_info as $form_id => $info) {
      $options[$form_id] = $info['label'];
    }
    $form['active_forms'] = array(
      '#type' => 'fieldset',
      '#title' => t('Active forms'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['active_forms']['form_events'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Events enabled forms'),
      '#options' => $options,
      '#description' => t('Forms currently changeable by associated events. You may prevent associated events from changing forms by selecting them and clicking on "Deactivate events".'),
    );
    $form['active_forms']['events_deactivate'] = array(
      '#type' => 'submit',
      '#value' => t('Deactivate events'),
      '#submit' => array(
        'rules_forms_events_deactivate_submit',
      ),
    );
    $form['form_elements'] = array(
      '#type' => 'fieldset',
      '#title' => t('Form elements'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#description' => t('Rules Forms Support stores information about the elements native to active forms. To rebuild the stored information about a form, select a form the select list below.'),
    );
    $form['form_elements']['reset_form'] = array(
      '#type' => 'select',
      '#title' => t('Rebuild form elements'),
      '#options' => $options,
    );
    $form['form_elements']['reset_elements'] = array(
      '#type' => 'submit',
      '#value' => t('Rebuild'),
      '#submit' => array(
        'rules_forms_elements_rebuild',
      ),
    );
  }
  else {
    drupal_set_message(t('To start creating form rules enable the "Enable event activation messages on forms" setting below and navigate to the form you would like to activate events for.'), 'status', FALSE);
  }
  return $form;
}

/**
 * Submit handler to save settings.
 */
function rules_forms_settings_submit($form_id, $form_state) {
  $_SESSION['rules_forms_message'] = (bool) $form_state['values']['enable_form_activation_message'];
  $_SESSION['rules_forms_element_info'] = (bool) $form_state['values']['enable_form_element_info'];
  drupal_set_message(t('The configuration options have been saved.'));
}

/**
 * Submit handler to deactivate form events.
 */
function rules_forms_events_deactivate_submit($form_id, $form_state) {
  $deactivate_events = array_filter($form_state['values']['form_events']);
  foreach ($deactivate_events as $key => $value) {
    rules_forms_deactivate_form($key);
  }
  drupal_set_message(t('The configuration options have been saved.'));
}

/**
 * Submit handler to rebuild form elements.
 */
function rules_forms_elements_rebuild($form_id, $form_state) {
  $form_info = rules_forms_get_form_info($form_state['values']['reset_form']);
  $form_info['reset'] = TRUE;
  rules_forms_save_form_info($form_state['values']['reset_form'], $form_info);
  drupal_set_message(t('Please revisit %form so that Rules forms Support can re-evaluate the elements information.', array(
    '%form' => $form_info['label'],
  )));
  if (isset($form_info['path']) && drupal_lookup_path($form_info['path']) !== FALSE) {
    drupal_goto($form_info['path']);
  }
}

/**
 * Activation page for a form ID.
 *
 * @param string $form_id_activate
 *   The form ID of the form to be activated.
 * @param string $form_page
 *   The encoded URI of the page on which the form was activated. This is used
 *   for redirecting the user back to that page once activation is completed.
 */
function rules_forms_activate($form_id_activate, $form_page) {
  $form_info = rules_forms_get_form_info();
  if (isset($form_info[$form_id_activate])) {
    return t('Events for %form_id have already been activated.', array(
      '%form_id' => $form_id_activate,
    ));
  }
  return drupal_get_form('rules_forms_activate_confirm_form', $form_id_activate, $form_page);
}

/**
 * Confirmation form to activate events on a form.
 */
function rules_forms_activate_confirm_form($form, &$form_state, $form_id_activate, $form_page) {
  $default_form_label = drupal_ucfirst(str_replace('_', ' ', $form_id_activate));
  $form = array();
  $form['form_id_label'] = array(
    '#type' => 'textfield',
    '#title' => t('Custom form label'),
    '#default_value' => $default_form_label,
    '#required' => TRUE,
    '#description' => t('Enter a custom label for use in the administration user interface.'),
  );
  $form['button_validate_submit'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable button level validate/submit events'),
    '#default_value' => FALSE,
    '#description' => t('Select this option to activate validate and submit events for cases where general form validate and submit events are not properly invoked.'),
  );
  $form_state['form_id_activate'] = $form_id_activate;
  $form_state['form_page'] = $form_page;
  $path = array();
  $path['path'] = isset($_GET['destination']) ? $_GET['destination'] : RULES_FORMS_ADMIN_PATH;
  $title = t('Are you sure you want to activate events for %form?', array(
    '%form' => $form_id_activate,
  ));
  $msg = t('Once the activation is confirmed, events on this form can be used to trigger rules.');
  return confirm_form($form, $title, $path, $msg, t('Activate'), t('Cancel'));
}

/**
 * Submit handler for activation of a form.
 */
function rules_forms_activate_confirm_form_submit($form, &$form_state) {
  $path = urldecode($form_state['form_page']);
  $form_info = array(
    'label' => $form_state['values']['form_id_label'],
    'elements' => array(),
    'path' => $path,
    'buttons' => $form_state['values']['button_validate_submit'] == TRUE,
  );

  // Save the form information but prevent cache rebuild until the form visited.
  rules_forms_activate_form($form_state['form_id_activate'], $form_info);
  drupal_set_message(t("%form has been activated.", array(
    '%form' => $form_state['form_id_activate'],
  )));

  // Redirect the user back to the form that was activated.
  $form_state['redirect'] = $path;
}

Functions

Name	Description
rules_forms_activate	Activation page for a form ID.
rules_forms_activate_confirm_form	Confirmation form to activate events on a form.
rules_forms_activate_confirm_form_submit	Submit handler for activation of a form.
rules_forms_admin_events	Defines the forms events settings form.
rules_forms_elements_rebuild	Submit handler to rebuild form elements.
rules_forms_events_deactivate_submit	Submit handler to deactivate form events.
rules_forms_settings_submit	Submit handler to save settings.