feat: Added dynamic actions and filters

Author: seebeen

src/Decorators/Action.php

@@ -21,21 +21,10 @@
  */
 #[\Attribute( \Attribute::IS_REPEATABLE | \Attribute::TARGET_METHOD )]
 class Action extends Filter {
-    /**
-     * Get the hook type.
-     *
-     * @return string
-     */
     protected function get_type(): string {
         return 'action';
     }
 
-    /**
-     * Indirect call to the hook callback.
-     *
-     * @param  mixed ...$args Arguments passed to the hook callback.
-     * @return mixed          Always null.
-     */
     public function invoke( mixed ...$args ): mixed {
         parent::invoke( ...$args );
 

src/Decorators/Dynamic_Action.php

@@ -0,0 +1,29 @@
+<?php //phpcs:disable Squiz.Commenting.FunctionComment.Missing
+/**
+ * Dynamic_Action class file.
+ *
+ * @package eXtended WordPress
+ * @subpackage Dependency Injection
+ */
+
+namespace XWP\DI\Decorators;
+
+/**
+ * Dynamic action decorator
+ *
+ * @template T of object
+ * @template H of Ajax_Handler<T>
+ * @extends Dynamic_Filter<T,H>
+ */
+#[\Attribute( \Attribute::TARGET_METHOD )]
+class Dynamic_Action extends Dynamic_Filter {
+    protected function get_type(): string {
+        return 'action';
+    }
+
+    public function invoke( mixed ...$args ): mixed {
+        parent::invoke( ...$args );
+
+        return null;
+    }
+}

src/Decorators/Dynamic_Filter.php

@@ -0,0 +1,137 @@
+<?php //phpcs:disable Squiz.Commenting.FunctionComment.Missing
+/**
+ * Dynamic_Filter class file.
+ *
+ * @package eXtended WordPress
+ * @subpackage Dependency Injection
+ */
+
+namespace XWP\DI\Decorators;
+
+use Closure;
+use Reflector;
+
+/**
+ * Dynamic filter decorator
+ *
+ * @template T of object
+ * @template H of Ajax_Handler<T>
+ * @extends Filter<T,H>
+ */
+#[\Attribute( \Attribute::TARGET_METHOD )]
+class Dynamic_Filter extends Filter {
+    /**
+     * Variables to fetch.
+     *
+     * @var array<string,string>
+     */
+    protected array $vars;
+
+    /**
+     * Raw variables for substitution.
+     *
+     * @var string|array<string>|Closure():array<string>
+     */
+    protected Closure|string|array $raw_vars;
+
+    /**
+     * Extra variables to pass to the callback.
+     *
+     * @var array<string,string>
+     */
+    protected array $extra;
+
+    /**
+     * Constructor.
+     *
+     * @param string                                        $tag      Hook tag.
+     * @param string|array<string>|callable():array<string> $vars     Variables to mix into the tag.
+     * @param int                                           $context  Hook context.
+     * @param Closure|string|int|array{class-string,string} $priority Hook priority.
+     * @param int|null                                      $args        The number of arguments to pass to the callback.
+     * @param array<int,string>                             $params   The parameters to pass to the callback.
+     */
+    public function __construct(
+        string $tag,
+        callable|array|string $vars,
+        int $context = self::CTX_GLOBAL,
+        Closure|array|int|string $priority = 10,
+        ?int $args = null,
+        array $params = array(),
+    ) {
+        $this->raw_vars = $vars;
+
+        parent::__construct(
+            tag: $tag,
+            priority: $priority,
+            context: $context,
+            invoke: self::INV_PROXIED,
+            args: $args,
+            params: $params,
+        );
+    }
+
+    /**
+     * Process variables.
+     *
+     * @param  string|array<string>|callable():array<string> $vars Variables to mix into the tag.
+     * @return array<int,string>|array<string,string>
+     */
+    private function process_vars( string|callable|array $vars ): array {
+        if ( \is_callable( $vars ) ) {
+            return $vars();
+        }
+
+        if ( \is_string( $vars ) && $this->container->has( $vars ) ) {
+            return $this->container->get( $vars );
+        }
+
+        return $vars;
+    }
+
+    /**
+     * Parse variables.
+     *
+     * @param  string|array<string>|callable():array<string> $vars Variables to mix into the tag.
+     * @return array<string,string>
+     */
+    protected function parse_vars( string|callable|array $vars ): array {
+        $parsed = array();
+
+        foreach ( $this->process_vars( $vars ) as $key => $val ) {
+            $key = \is_int( $key ) ? $val : $key;
+
+            $parsed[ $key ] = $val;
+        }
+
+        return $parsed;
+    }
+
+    public function with_reflector( Reflector $r ): static {
+        $this->args ??= $r->getNumberOfParameters() - 1;
+
+        return parent::with_reflector( $r );
+    }
+
+    public function load_hook( ?string $tag = null ): bool {
+        $res = true;
+
+        foreach ( $this->parse_vars( $this->raw_vars ) as $var => $param ) {
+            $tag = $this->define_tag( $this->tag, array( $var ) );
+
+            $this->extra[ $tag ] = $param;
+
+            $res = $res && parent::load_hook( $tag );
+        }
+
+        return $res;
+    }
+
+    protected function get_cb_args( array $args ): array {
+        $args = parent::get_cb_args( $args );
+
+        $args[] = $this->extra[ $this->current() ];
+
+        return $args;
+    }
+}

src/Decorators/Filter.php

@@ -91,6 +91,17 @@ protected function get_type(): string {
         return 'filter';
     }
 
+    /**
+     * Get the current hook.
+     *
+     * @return string
+     */
+    protected function current(): string {
+        $cb = "current_{$this->get_type()}";
+
+        return $cb();
+    }
+
     public function with_reflector( Reflector $r ): static {
         $this->args ??= $r->getNumberOfParameters();
 

src/Interfaces/Can_Invoke.php

@@ -15,11 +15,12 @@
  * @template THndl of Can_Handle<TInst>
  * @extends Can_Hook<TInst,\ReflectionMethod>
  *
- * @property-read bool $firing Is the hook firing?
- * @property-read int  $fired   Number of times the hook has fired.
-
+ * @property-read bool   $firing Is the hook firing?
+ * @property-read int    $fired  Number of times the hook has fired.
+ * @property-read string $method The method name.
+ *
  * @property-read array{TInst,string} $target The target method.
- * @property-read Thndl $handler The handler instance.
+ * @property-read THndl $handler The handler instance.
  */
 interface Can_Invoke extends Can_Hook {
     /**