function rules_forms_rules_forms_element_info in Rules Forms Support 7.2

Implements hook_rules_forms_element_info().

Possible keys:

• label: A human-readable label of the form element.
• description (optional): A human-readable translated description.
• properties: An array of property info as required by EntityMetadataWrapper. This info should directly correspond to the element's possible attributes. Additional keys in each individual property:
  • attribute info: An array of information about the form element attribute.
    • validate callback (optional): A callback for validating form data in the set element attribute action.
    • setter callback: A callback for setting data in the set element attribute action.
• element info: An array of information describing the form element to Rules Forms.
  • data type: The type of data the form element's value requires.
  • keys: An array of key|value pairs describing keys to important attributes. For example:
    • value: The key to the value of the form element (if any).
    • default_value: The key to the default value of the form element (if any).
  • empty: An empty form element value.

File

includes/rules_forms.info.inc, line 33

Implements Rules Forms hooks.

Code

function rules_forms_rules_forms_element_info() {
  $info['button'] = array(
    'label' => t('Button'),
    'properties' => rules_forms_element_properties('button'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#value',
      ),
      'empty' => '',
    ),
  );
  $info['checkbox'] = array(
    'label' => t('Checkbox'),
    'properties' => rules_forms_element_properties('checkbox'),
    'element info' => array(
      'data type' => 'boolean',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => FALSE,
    ),
  );
  $info['checkboxes'] = array(
    'label' => t('Checkboxes'),
    'properties' => rules_forms_element_properties('checkboxes'),
    'element info' => array(
      'data type' => 'struct',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => array(),
    ),
  );
  $info['container'] = array(
    'label' => t('Container'),
    'properties' => rules_forms_element_properties('container'),
    // The 'data type' FALSE indicates that this element is not settable.
    'element info' => array(
      'data type' => FALSE,
    ),
  );
  $info['fieldset'] = array(
    'label' => t('Fieldset'),
    'properties' => rules_forms_element_properties('fieldset'),
    // The 'data type' FALSE indicates that this element is not settable.
    'element info' => array(
      'data type' => FALSE,
    ),
  );
  $info['hidden'] = array(
    'label' => t('Hidden'),
    'properties' => rules_forms_element_properties('hidden'),
    'element info' => array(
      'data type' => '*',
      'keys' => array(
        'value' => '#value',
      ),
      'empty' => NULL,
    ),
  );
  $info['item'] = array(
    'label' => t('Item'),
    'properties' => rules_forms_element_properties('item'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#markup',
      ),
      'empty' => '',
    ),
  );
  $info['markup'] = array(
    'label' => t('Markup'),
    'properties' => rules_forms_element_properties('markup'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#markup',
      ),
      'empty' => '',
    ),
  );
  $info['password'] = array(
    'label' => t('Password'),
    'properties' => rules_forms_element_properties('password'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#value',
      ),
      'empty' => NULL,
    ),
  );
  $info['radio'] = array(
    'label' => t('Radio'),
    'properties' => rules_forms_element_properties('radio'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => NULL,
    ),
  );
  $info['radios'] = array(
    'label' => t('Radios'),
    'properties' => rules_forms_element_properties('radios'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => '',
    ),
  );
  $info['select'] = array(
    'label' => t('Select list'),
    'properties' => rules_forms_element_properties('select'),
    'element info' => array(
      'data type' => 'text|struct',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => '',
    ),
  );
  $info['submit'] = array(
    'label' => t('Submit'),
    'properties' => rules_forms_element_properties('submit'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#value',
      ),
      'empty' => '',
    ),
  );
  $info['tableselect'] = array(
    'label' => t('Table select list'),
    'properties' => rules_forms_element_properties('tableselect'),
    'element info' => array(
      'data type' => 'struct',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => array(),
    ),
  );
  $info['text_format'] = array(
    'label' => t('Text format'),
    'properties' => rules_forms_element_properties('text_format'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => '',
    ),
  );
  $info['textarea'] = array(
    'label' => t('Text area'),
    'properties' => rules_forms_element_properties('textarea'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => '',
    ),
  );
  $info['textfield'] = array(
    'label' => t('Text field'),
    'properties' => rules_forms_element_properties('textfield'),
    'element info' => array(
      'data type' => 'text',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => '',
    ),
  );
  $info['weight'] = array(
    'label' => t('Weight'),
    'properties' => rules_forms_element_properties('weight'),
    'element info' => array(
      'data type' => 'integer',
      'keys' => array(
        'value' => '#value',
        'default_value' => '#default_value',
      ),
      'empty' => 0,
    ),
  );
  $info['value'] = array(
    'label' => t('Value'),
    'properties' => rules_forms_element_properties('value'),
    'element info' => array(
      'data type' => '*',
      'keys' => array(
        'value' => '#value',
      ),
      'empty' => '',
    ),
  );
  return $info;
}