Merge pull request #1306 from VincentLanglet/commandSubscriber

[ENQUEUE] Precise phpdoc for static analysis
TheCluster · Oct 14, 2023 · 8a0c3d2 · 8a0c3d2
2 parents 03eff4c + b39c388
commit 8a0c3d2
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/Client/CommandSubscriberInterface.php b/Client/CommandSubscriberInterface.php
@@ -2,6 +2,15 @@
 
 namespace Enqueue\Client;
 
+/**
+ * @phpstan-type CommandConfig = array{
+ *     command: string,
+ *     processor?: string,
+ *     queue?: string,
+ *     prefix_queue?: bool,
+ *     exclusive?: bool,
+ * }
+ */
 interface CommandSubscriberInterface
 {
     /**
@@ -44,6 +53,8 @@ interface CommandSubscriberInterface
      * Note: If you set "prefix_queue" to true then the "queue" is used as is and therefor the driver is not used to create a transport queue name.
      *
      * @return string|array
+     *
+     * @phpstan-return string|CommandConfig|array<CommandConfig>
      */
     public static function getSubscribedCommand();
 }