rules.rules_forms.inc in Rules 6

Forms for the integration provided by rules

File

rules/modules/rules.rules_forms.inc

<?php

/**
 * @file Forms for the integration provided by rules
 *
 * @addtogroup rules
 * @{
 */

/**
 * Condition: Textual comparison configuration form
 */
function rules_condition_text_compare_form($settings = array(), &$form) {
  $form['settings']['text1']['#title'] = t('Two texts to compare');
  $form['settings']['text2']['#title'] = '';
  $form['settings']['regex'] = array(
    '#type' => 'checkbox',
    '#title' => t('Evaluate the second text as a regular expression.'),
    '#default_value' => isset($settings['regex']) ? $settings['regex'] : 0,
    '#description' => t('If enabled, the matching pattern will be interpreted as a <a href="@regex-wikipedia">regex</a>.  Tip: <a href="@RegExr">RegExr: Online Regular Expression Testing Tool</a> is helpful for learning, writing, and testing Regular Expressions.', array(
      '@regex-wikipedia' => 'http://en.wikipedia.org/wiki/Regular_expression',
      '@RegExr' => 'http://gskinner.com/RegExr/',
    )),
  );
}

/**
 * Condition: Numerical comparision configuration form
 */
function rules_condition_number_compare_form($settings = array(), &$form) {
  $form['settings']['number1']['#weight'] = -2;
  $form['settings']['number2']['#weight'] = 2;
  $form['settings']['operation'] = array(
    '#type' => 'select',
    '#title' => t('Operation'),
    '#options' => array(
      'greater' => t('Greater than'),
      'equal' => t('Equal to'),
      'less' => t('Less than'),
    ),
    '#default_value' => isset($settings['operation']) ? $settings['operation'] : 'equal',
  );
}
function rules_condition_check_boolean_help() {
  return t('Check a <a href="http://en.wikipedia.org/wiki/Logical_value">truth value</a>, i.e. TRUE or FALSE.');
}

/**
 * Also add in the invoked rule set when exporting for features.
 */
function rules_action_invoke_set_features_export(&$export, &$pipe, $settings, $element) {
  $set_name = $element['#info']['set'];
  if (!isset($export['features']['rules_sets'][$set_name])) {
    $export['features']['rules_sets'][$set_name] = $set_name;
    rules_features_process_set($set_name, $export, $pipe);
  }
}
function rules_action_save_variable_form($settings, &$form, $form_state) {

  // Only add this form for the save variable action, not for the add variable action.
  if (!isset($form_state['element']['#info']['new variables'])) {
    $settings += array(
      'immediate' => 0,
    );
    $form['settings']['immediate'] = array(
      '#type' => 'checkbox',
      '#title' => t('Force immediate saving.'),
      '#description' => t('If enabled, intelligent saving is bypassed to ensure immediate saving.'),
      '#default_value' => $settings['immediate'],
    );
  }
}
function rules_action_save_variable_help() {
  return t('Usually you need not care about saving changes done by actions. However this action allows you to force saving changes, if no action does.') . ' ' . t('Furthermore note that changes are saved intelligently, which means that changes are saved only once, even if multiple actions request saving changes.');
}

/**
 * The following functions help converting actions
 * when upgrading from workflow-ng
 */
function workflow_ng_condition_token_compare_upgrade(&$element) {
  $element['#name'] = 'rules_condition_text_compare';
}
function workflow_ng_condition_token_numeric_upgrade(&$element) {
  $element['#name'] = 'rules_condition_number_compare';
  foreach (array(
    'text1',
    'text2',
    'text1_args',
    'text2_args',
  ) as $key) {
    $element['#settings'][str_replace('text', 'number', $key)] = $element['#settings'][$key];
    unset($element['#settings'][$key]);
  }
}

/**
 * @}
 */

Related topics

Rules module integrations.

Module integrations with the rules module.

Functions

Name	Description
rules_action_invoke_set_features_export	Also add in the invoked rule set when exporting for features.
rules_action_save_variable_form
rules_action_save_variable_help
rules_condition_check_boolean_help
rules_condition_number_compare_form	Condition: Numerical comparision configuration form
rules_condition_text_compare_form	Condition: Textual comparison configuration form
workflow_ng_condition_token_compare_upgrade	The following functions help converting actions when upgrading from workflow-ng
workflow_ng_condition_token_numeric_upgrade