function rb_batch_rules_action_info in Rules Bonus Pack 7

Implements hook_rules_action_info().

Declares meta-data about the action which enables to alter batch API context data on rules runtime.

File

rb_batch/rb_batch.rules.inc, line 74

Provides a batched rule set component to rules.

Code

function rb_batch_rules_action_info() {
  $actions = array();
  $actions['rb_batch_action_batch_context'] = array(
    'label' => t('Alter batch context'),
    'group' => t('Batched Rules'),
    'parameter' => array(
      'batch_context_message' => array(
        'type' => 'text',
        'label' => t('Message'),
        'description' => t("A message shown on progress page after this rule was executed. (Defaults to it's title)"),
      ),
      'batch_context_finished' => array(
        'type' => 'boolean',
        'label' => t('Finished'),
        'description' => t("Wether this rule succeed and is finished. (Will be re-executed otherwise)"),
        'default value' => TRUE,
      ),
    ),
  );
  return $actions;
}