function rule

Creates a new rule.

Parameters

array $variables: The array of variables to setup in the evaluation state, making them available for the configuration elements. Values for the variables need to be passed as argument when the rule is executed. Only Rule instances with no variables can be embedded in other configurations, e.g. rule sets. The array has to be keyed by variable name and contain a sub-array for each variable that has the same structure as the arrays used for describing parameters of an action, see hook_rules_action_info(). However, in addition to that the following keys are supported:

• parameter: (optional) If set to FALSE, no parameter for the variable is created - thus no argument needs to be passed to the rule for the variable upon execution. As a consequence no value will be set initially, but the "Set data value" action may be used to do so. This is in particular useful for defining variables which can be provided to the caller (see $provides argument) but need not be passed in as parameter.

array $provides: The names of variables which should be provided to the caller. Only variables contained in $variables may be specified.

Return value

Rule

File

./rules.module, line 128

Code

function rule($variables = NULL, $provides = array()) {
    return rules_plugin_factory('rule', $variables, $provides);
}