feature #50978 [Messenger] Allow accessing all options on a handler descriptor (ruudk)

fabpot · fabpot · commit 3b200519c2e5 · 2023-07-30T15:23:55.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Messenger] Allow accessing all options on a handler descriptor | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? |no | New feature? | yes | Deprecations? | no | Tickets | | License | MIT | Doc PR | Currently it's only possible to use `HandlerDescriptor::getOption` to retrieve options one by one. In my situation, I want to inspect all the options, without knowing their name. Commits ------- 55e1176 Allow accessing all options on a handler descriptor
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Deprecate `StopWorkerOnSignalsListener` in favor of using the `SignalableCommandInterface`
+ * Add `HandlerDescriptor::getOptions`
 
 6.3
 ---
diff --git a/src/Symfony/Component/Messenger/Handler/HandlerDescriptor.php b/src/Symfony/Component/Messenger/Handler/HandlerDescriptor.php
@@ -73,4 +73,9 @@ public function getOption(string $option): mixed
     {
         return $this->options[$option] ?? null;
     }
+
+    public function getOptions(): array
+    {
+        return $this->options;
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Tests/Handler/HandleDescriptorTest.php b/src/Symfony/Component/Messenger/Tests/Handler/HandleDescriptorTest.php
@@ -45,6 +45,14 @@ public function __invoke()
             }
         }, 'class@anonymous%sHandleDescriptorTest.php%s::__invoke'];
     }
+
+    public function testGetOptions()
+    {
+        $options = ['option1' => 'value1', 'option2' => 'value2'];
+        $descriptor = new HandlerDescriptor(function () {}, $options);
+
+        $this->assertSame($options, $descriptor->getOptions());
+    }
 }
 
 class DummyCommandHandlerWithSpecificMethod

Original file line number	Diff line number	Diff line change
`@@ -73,4 +73,9 @@ public function getOption(string $option): mixed`
`73`	`73`	`{`
`74`	`74`	`return $this->options[$option] ?? null;`
`75`	`75`	`}`
	`76`	`+`
	`77`	`+ public function getOptions(): array`
	`78`	`+ {`
	`79`	`+ return $this->options;`
	`80`	`+ }`
`76`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,14 @@ public function __invoke()`
`45`	`45`	`}`
`46`	`46`	`}, 'class@anonymous%sHandleDescriptorTest.php%s::__invoke'];`
`47`	`47`	`}`
	`48`	`+`
	`49`	`+ public function testGetOptions()`
	`50`	`+ {`
	`51`	`+ $options = ['option1' => 'value1', 'option2' => 'value2'];`
	`52`	`+ $descriptor = new HandlerDescriptor(function () {}, $options);`
	`53`	`+`
	`54`	`+ $this->assertSame($options, $descriptor->getOptions());`
	`55`	`+ }`
`48`	`56`	`}`
`49`	`57`
`50`	`58`	`class DummyCommandHandlerWithSpecificMethod`