public function RulesLoop::pluginParameterInfo in Rules 7.2

Returns info about parameters needed by the plugin.

Note that not necessarily all parameters are needed when executing the plugin, as values for the parameter might have been already configured via the element settings.

Overrides RulesPlugin::pluginParameterInfo

See also

self::parameterInfo()

1 call to RulesLoop::pluginParameterInfo()

RulesLoop::evaluate in includes/rules.plugins.inc

Evaluate, whereas by default new vars are visible in the parent's scope.

File

includes/rules.plugins.inc, line 677

Contains plugin info and implementations not needed for rule evaluation.

Class

RulesLoop

A loop element.

Code

public function pluginParameterInfo() {
  $info['list'] = array(
    'type' => 'list',
    'restriction' => 'selector',
    'label' => t('List'),
    'description' => t('The list to loop over. The loop will step through each item in the list, allowing further actions on them. See <a href="@url"> the online handbook</a> for more information on how to use loops.', array(
      '@url' => rules_external_help('loops'),
    )),
  );
  return $info;
}