rules.module
Version
1.1.2.25 (checked in on 2008/08/02 at 15:03:12 by fago)
Description
Rules engine module
Constants
Name | Description |
|---|---|
| RULES_ADMIN_PATH | |
| RULES_ADMIN_RULE_PATH | |
| RULES_ADMIN_SET_PATH | |
| RULES_ADMIN_TRIGGER_PATH |
Functions
| Name | Description |
|---|---|
| rules_clear_cache | Clears the rule set cache |
| rules_configure | A simple helping function, which eases the creation of rules Example use case: $conditions = rules_configure('OR', $condition1, conditions2); |
| rules_elements | Implementation of hook_elements() Defines default values for all available properties of rules's element types |
| rules_element_invoke | Invokes an element specific function. E.g. this is used for invoking actions. |
| rules_enable_items | Used to inform the rules engine about an added item type, so it can create the db table if necessary |
| rules_error_missing_implementation | Shows an error message, that a module is missing. |
| rules_evaluate_elements | Evaluates the elements in a recursive way The elements are a tree of rules, conditions, actions and logical operations (AND, OR,..) |
| rules_execute_action | Execution handler for actions |
| rules_execute_and | Execution handler for the AND element Evaluates to TRUE if all children evaluate to TRUE.. |
| rules_execute_condition | Execution handler for conditions Note: An condition may not alter arguments |
| rules_execute_element | Executes the element by invoking the element type's execution handler |
| rules_execute_or | Execution handler for the OR element Evaluates to TRUE if at least one children evaluate to TRUE.. |
| rules_execute_rule | Execution handler for rules |
| rules_extract_property | Extracts the property with the given name while keeping the keys |
| rules_flush_caches | Implementation of hook_flush_caches |
| rules_form_alter | Implementation of hook_form_alter() Clear the cache when a module is deactivated |
| rules_get_actions | Returns info about all defined actions |
| rules_get_conditions | Returns info about all defined conditions |
| rules_get_configured_items | Gets all configured items, regardless if defined by the admin or by a module |
| rules_get_data_types | Returns info about all defined data types |
| rules_get_element_info | Returns the element info of the element |
| rules_get_element_label | Gets the element's label |
| rules_get_events | Returns info about all defined events |
| rules_get_event_sets | Returns info about all events prefixed with 'event_' to be a set. |
| rules_get_items | Returns info about all defined items |
| rules_get_item_defaults | Returns all defined item defaults $item_type Which defaults to return, e.g. 'rules', 'rule_sets' or 'states' |
| rules_get_rule_set | Returns the rule set $set_name, which includes the set info and the rules. To improve performance rule sets are cached. |
| rules_get_rule_sets | Returns info about all rule sets, which includes events prefixed with 'event_'. |
| rules_handle_error_msg | Handles a error message. If the user has permission to administer the rules engine, show him the error. Otherwise just log it. |
| rules_include | Includes rules specific include files |
| rules_init | Implementation of hook_init() |
| rules_init_element_info | Initiates the element info property (#info) of an element (actions, conditions,..). Note that the element defaults will be applied before, if not yet done. |
| rules_invoke_event | Invokes configured rules for the given event |
| rules_invoke_rule_set | Invokes configured rules for the given rule set |
| rules_item_delete | Deletes the given item from the database |
| rules_item_load | |
| rules_item_save | Deletes the given item from the database |
| rules_item_title | |
| rules_item_type_invoke | Invoke an item type specific function, which will be item types base appended with _$op. The parameters given in $params will be passed to this function. |
| rules_log | Writes the message into the log |
| rules_log_evaluated_rule | Remembers the currently evaluated rules. With this information, recursion is prevented |
| rules_log_evaluation_finished | Checks whether every rule evaluation is finished |
| rules_log_rule_is_evaluated | Checks whether the given rule is currently evaluated. |
| rules_menu | Implementation of hook_menu(). |
| rules_perm | Implementation of hook_perm(). |
| rules_rules_item_info | Implementation of hook_rules_item_info |
| rules_rule_title | |
| rules_show_log | Shows the log and clears it afterwards |
| rules_theme | Implementation of hook_theme() |
| rules_use_action | Configures an action for using in a rule |
| rules_use_condition | Configures a condition for using in a rule |
| rules_use_element | Configures an element of type $type with the further properties $params for using in a configuration |
| rule_element_load | |
| rule_load | Loads the admin proxy of the rule with the given name |
| _rules_element_defaults | Makes sure the element defaults are applied |
| _rules_get_rule_sets | Actually retrieves all active rules bypassing the cache |
| _rules_get_rule_set_initialize | Initializes inactive sets |
| _rules_include_get_files | |
| _rules_log_set_invocation | Writes to the log and marks the entry to be the first one of a just started set |
| _rules_rule_is_active | Helper for array_filter() |
| _rules_show_log | |
| _rules_sort_children | Sorts the children of the elements |