Club Drupal

/**

 * @file

 * This file contains no working PHP code; it exists to provide additional

 * documentation for doxygen as well as to document hooks in the standard

 * Drupal manner.

 */

/**

 * @defgroup rules Rules module integrations.

 *

 * Module integrations with the rules module.

 *

 * The Rules developer documentation describes how modules can integrate with

 */

/**

 * handlers may be provided by implementing RulesActionHandlerInterface. See

 * the interface for details.

 *

 *   An array of information about the module's provided rules actions.

 *   The array contains a sub-array for each action, with the action name as

 *   the key. Actions names may only contain lowercase alpha-numeric characters

 *   - 'access callback': (optional) A callback which has to return whether the

 *     currently logged in user is allowed to configure this action. See

 *     rules_node_integration_access() for an example callback.

 *   - label: The label of the parameter. Start capitalized. Required.

 *   - type: The rules data type of the parameter, which is to be passed to the

 *     action. All types declared in hook_rules_data_info() may be specified, as

 *     to clean inserted replacements; e.g. this is used by the token evaluator.

 *   - wrapped: (optional) Set this to TRUE in case the data should be passed

 *     wrapped. This only applies to wrapped data types, e.g. entities.

 *   - label: The label of the variable. Start capitalized. Required.

 *   - type: The rules data type of the variable. All types declared in

 *     hook_rules_data_info() may be specified. Types may be parametrized e.g.

 *   - save: (optional) If this is set to TRUE, the provided variable is saved

 *     by rules when the rules evaluation ends. Only possible for savable data

 *     types. Defaults to FALSE.

 *

 */

function hook_rules_action_info() {

  return array(

 * will be treated as grouping in the given category (e.g. group "paypal" in

 * category "commerce payment").

 *

 *   An array of information about the module's provided categories.

 *   The array contains a sub-array for each category, with the category name as

 *   the key. Names may only contain lowercase alpha-numeric characters

 *   - label: The label of the category. Start capitalized. Required.

 *   - weight: (optional) A weight for sorting the category. Defaults to 0.

 *   - equals group: (optional) For BC, categories may be defined that equal

 *   - icon: (optional) The file path of an icon to use, relative to the module

 *     or specified icon path. The icon should be a transparent SVG containing

 *     Note that the icon is currently not used by Rules, however other UIs

 *     building upon Rules (like fluxkraft) do, and future releases of Rules

 *     might do as well. Consequently, the definition of an icon is optional.

 *     However, if both an icon font and icon is given, the icon is preferred.

 *   - icon path: (optional) The base path for the icon. Defaults to the

 *     providing module's directory.

 *     icon. Icon font class names should map to the ones as defined by Font

 *     Awesome, while themes might want to choose to provide another icon font.

 *     See http://fortawesome.github.io/Font-Awesome/cheatsheet/.

 * plugin method callbacks in any file without having to care about file

 * inclusion.

 *

 *   An array of file names without the file ending which defaults to '.inc'.

 */

function hook_rules_file_info() {

 *   The callback gets arguments passed as described as parameter in

 *   hook_rules_action_info() as well as an array containing the action's

 *   configuration settings.

 *   with their names as key. This is used update the value of a parameter or to

 *   Apart from that any parameters which have the key 'save' set to TRUE will

 *   be remembered to be saved by rules unless the action returns FALSE.

 *   Conditions have to return a boolean value in any case.

 * handlers may be provided by implementing RulesEventHandlerInterface. See

 * the interface for details.

 *

 *   An array of information about the module's provided rules events. The array

 *   contains a sub-array for each event, with the event name as the key. The

 *   name may only contain lower case alpha-numeric characters and underscores

 *     - handler: (optional) A handler to load the actual variable value. This

 *       is useful for lazy loading variables. The handler gets all so far

 *       available variables passed in the order as defined. Also see

 *       Note that for lazy-loading entities just the entity id may be passed

 *       as variable value, so a handler is not necessary in that case.

 *

 */

function hook_rules_event_info() {

  $items = array(

 * module.

 * For a list of data types defined by rules see rules_rules_core_data_info().

 *

 *   An array of information about the module's provided data types. The array

 *   contains a sub-array for each data type, with the data type name as the

 *   key. The name may only contain lower case alpha-numeric characters and

 *     makes use of the class for wrapping the data of the given type. However

 *     note that if data is already wrapped when it is passed to Rules, the

 *     existing wrappers will be kept.

 *     class RulesIdentifiableDataWrapper is provided, which can be used as base

 *     for a custom wrapper class. See RulesIdentifiableDataWrapper for details.

 *   - property info: (optional) May be used for non-entity data structures to

 *   - cleaning callback: (optional) A callback that input evaluators may use

 *     to clean inserted replacements; e.g. this is used by the token evaluator.

 *

 */

function hook_rules_data_info() {

  return array(

 * A rules configuration may consist of elements being instances of any rules

 * plugin. This hook can be used to define new or to extend rules plugins.

 *

 *   An array of information about the module's provided rules plugins. The

 *   array contains a sub-array for each plugin, with the plugin name as the

 *   key. The name may only contain lower case alpha-numeric characters,

 *     of the 'or' plugin. Note that only uppercase values are allowed, as

 *     lower case values are treated as action or condition exports.

 *

 */

function hook_rules_plugin_info() {

  return array(

 * and help() could be overridden in order to control access permissions or to

 * provide some usage help.

 *

 *   An array of information about the module's provided input evaluators. The

 *   array contains a sub-array for each evaluator, with the evaluator name as

 *   the key. The name may only contain lower case alpha-numeric characters and

 *     used. Defaults to 'text'. Multiple data types may be specified using an

 *     array.

 *

 */

function hook_rules_evaluator_info() {

  return array(

      'class' => 'RulesTokenEvaluator',

      'type' => array('text', 'uri'),

      'weight' => 0,

  );

}

 * access() could be overridden in order to provide a configuration form or

 * to control access permissions.

 *

 *   An array of information about the module's provided data processors. The

 *   array contains a sub-array for each processor, with the processor name as

 *   the key. The name may only contain lower case alpha-numeric characters and

 *     used. Defaults to 'text'. Multiple data types may be specified using an

 *     array.

 *

 */

function hook_rules_data_processor_info() {

  return array(

      'class' => 'RulesDateOffsetProcessor',

      'type' => 'date',

      'weight' => -2,

  );

}

 * @param $actions

 *   The items of all modules as returned from hook_rules_action_info().

 *

 */

function hook_rules_action_info_alter(&$actions) {

  unset($actions['rules_core_node_assign_owner_action']);

  // We prefer handling saving by rules - not by the user.

  unset($actions['rules_core_node_save_action']);

 * @param $events

 *   The items of all modules as returned from hook_rules_event_info().

 *

 */

function hook_rules_event_info_alter(&$events) {

  // Change events.

 * This hook is invoked during rules configuration loading, which is handled

 * by entity_load(), via classes RulesEntityController and EntityCRUDController.

 *

 *   An array of rules configurations being loaded, keyed by id.

 */

function hook_rules_config_load($configs) {

 * should be placed into the file MODULENAME.rules_defaults.inc, which gets

 * automatically included when the hook is invoked.

 *

 *   An array of rules configurations with the configuration names as keys.

 *

 * @see hook_default_rules_configuration_alter()

function hook_default_rules_configuration() {

  $rule = rules_reaction_rule();

  $rule->label = 'example default rule';

  $rule->active = FALSE;

  $rule->event('node_update')

       ->condition(rules_condition('data_is', array('data:select' => 'node:status', 'value' => TRUE))->negate())

       ->action('drupal_message', array('message' => 'A node has been updated.'));

  $configs['rules_test_default_1'] = $rule;

  return $configs;

}

 * This hook is invoked by the entity module after default rules configurations

 * have been rebuilt; i.e. defaults have been saved to the database.

 *

 *   The array of default rules configurations which have been inserted or

 *   updated, keyed by name.

 *   An array of original rules configurations keyed by name; i.e. the rules

 *   configurations before the current defaults have been applied. For inserted

 *   rules configurations no original is available.

 * @param $element

 *   The element array of a configured condition or action which is to be

 *   upgraded.

 *   The name of the action or condition which should be used.

 */

function hook_rules_action_base_upgrade_map_name($element) {

}

/**

 *

 * During upgrading Drupal 6 rule configurations to Drupal 7 Rules is taking

 * care of upgrading the configuration of all known parameters, which only works

 * if the parameter name has not changed.

 * If something changed, this callback can be used to properly apply the

 * ($target).

 *

 * This is no real hook, but a callback that is invoked for each Drupal 6

}

/**

 *

 * A alter hook that is called after the action/condition specific callback for

 * each element of a configuration that is upgraded.

 * a given user has access to perform a given operation on a Rules

 * configuration.

 *

 *   The operation being performed. One of 'view', 'create', 'update' or

 *   'delete'.

 * @param $rules_config

 * @param $account

 *   (optional) The user to check for. If no account is passed, access is

 *   determined for the current user.

 *   Return TRUE to grant access, FALSE to explicitly deny access. Return NULL

 *   or nothing to not affect the operation.

 *   Access is granted as soon as a module grants access and no one denies