Support implementing conditions and actions via classes [#2050649]

While the existing "faces" abstraction layer in Rules failed as concept, it still gives us a lot of flexibility in Rules: we can easily add support for implement conditions and actions as classes (what I felt would have not been welcomed by the community when I wrote Rules 2.x back in 2009).

But now, classes are cool - so let's add support for them!?

Comment	File	Size	Author
#14	d7_rules_classes.patch	22.43 KB	fago
#14	d7_rules_classes.interdiff.txt	2.05 KB	fago
#13	d7_rules_classes.interdiff.txt	2.03 KB	fago
#13	d7_rules_classes.patch	20.51 KB	fago
#10	d7_rules_classes.patch	20.22 KB	fago
#10	d7_rules_classes.interdiff.txt	10.38 KB	fago
#8	d7_rules_classes.patch	12.78 KB	fago
#8	d7_rules_classes.interdiff.patch	3.15 KB	fago
#6	d7_rules_classes.patch	11.82 KB	fago
#6	d7_rules_classes.interdiff.patch	628 bytes	fago
#2	d7_rules_classes.patch	11.78 KB	fago
#1	d7_rules_classes.patch	23.72 KB	fago

Comments

Comment #1

fago

German

Vienna

commented 25 July 2013 at 19:56

Status:

Active

» Needs review

Status	File	Size
new	d7_rules_classes.patch	23.72 KB

So attached patch adds in support for class-based event,action,condition definition - including a simple discovery mechanism based on the already existing possibility to expose additional files to Rules via hook_rules_file_info().

So a class must reside in module.rules.inc, in a file specified in hook_rules_file_info() or in any other included location and support auto-loading, e.g. via the registry. Then, the class must implement the suiting interface as well as a static getInfo() method providing the plugin info. Compared to info provided via info-hooks getInfo() must include the plugin 'name' and the providing 'module'.

Attached patch implements that and converts node conditions to classes to have an example.

Comment #2

fago

German

Vienna

commented 25 July 2013 at 19:59

Status	File	Size
new	d7_rules_classes.patch	11.78 KB

ops, previous patch contained other patches as well - please ignore.

See attached patch.

Comment #3

fago

German

Vienna

commented 25 July 2013 at 19:59

Title:

Support implement conditions and actions via classes

» Support implementing conditions and actions via classes

Comment #4

fubhy commented 25 July 2013 at 20:27

+++ b/includes/rules.core.incundefined
@@ -1933,6 +1938,29 @@ interface RulesPluginImplInterface {
+ *

weird line break.

+++ b/rules.moduleundefined
@@ -217,12 +222,40 @@ function rules_fetch_data($hook) {
+ */
+function rules_discover_plugins($class) {
+  // Make sure all files possibly holding plugins are included.
+  RulesAbstractPlugin::includeFiles();
+
+  $items = array();
+  foreach (get_declared_classes() as $plugin_class) {
+    if (is_subclass_of($plugin_class, $class) && method_exists($plugin_class, 'getInfo')) {
+      $info = call_user_func(array($plugin_class, 'getInfo'));
+      $items[$info['name']] = $info;
+    }
+  }
+  return $items;
+}
+

Let's try solving this with ReflectionClass::getFileName() and then doing a while() loop using dirname() to find the module through a keyed list of module names (keys being the paths to the modules).