RulesTriggerableInterface and RulesReactionRule changed as support for event settings have been added

By fago on 20 June 2013

Change record status:

Published (View all published change records)

Project:

Rules

Introduced in branch:

7.x-2.x

Introduced in version:

7.x-2.4

Issue links:

https://www.drupal.org/node/1993932

Description:

Issue #1993932: Add support for event settings added support for event settings. Consequently RulesTriggerableInterface and RulesReactionRule got changed a bit, most notable

RulesTriggerableInterface::events() and RulesReactionRule::events() do not return the array by reference any more. Then, RulesTriggerableInterface received some additional new methods - so in case someone implements that this needs to be adapted (however no implementation besides the one included with Rules (RulesReactionRule) is known.

Then, the patch allows for an option event handler to be specified as part of the event info:

 *   - class: (optional) An event handler class implementing the
 *     RulesEventHandlerInterface. If none is specified the
 *     RulesEventDefaultHandler class will be used. While the default event
 *     handler has no settings, custom event handlers may be implemented to
 *     to make an event configurable. See RulesEventHandlerInterface.

As noted, see the RulesEventHandlerInterface for more details.

Impacts:

Module developers

Updates Done (doc team, etc.)

Online documentation:

Not done

Theming guide:

Not done

Module developer documentation:

Not done

Examples project:

Not done