Deprecate LogoutListener being returned as 3rd element by FirewallMapInterface::getListeners

scheb · scheb · commit 690b40cf0958 · 2021-10-23T11:40:46.000+02:00
diff --git a/src/Symfony/Bundle/SecurityBundle/Security/FirewallMap.php b/src/Symfony/Bundle/SecurityBundle/Security/FirewallMap.php
@@ -35,6 +35,10 @@ public function __construct(ContainerInterface $container, iterable $map)
 
     public function getListeners(Request $request)
     {
+        if (2 > \func_num_args() || func_get_arg(1)) {
+            trigger_deprecation('symfony/security-bundle', '5.4', 'The third element in the return value of "%s()" is deprecated', __METHOD__);
+        }
+
         $context = $this->getFirewallContext($request);
 
         if (null === $context) {
diff --git a/src/Symfony/Component/Security/Http/CHANGELOG.md b/src/Symfony/Component/Security/Http/CHANGELOG.md
@@ -16,6 +16,7 @@ CHANGELOG
  * Deprecate `CookieClearingLogoutHandler`, `SessionLogoutHandler` and `CsrfTokenClearingLogoutHandler`.
    Use `CookieClearingLogoutListener`, `SessionLogoutListener` and `CsrfTokenClearingLogoutListener` instead
  * Deprecate `PassportInterface`, `UserPassportInterface` and `PassportTrait`, use `Passport` instead
+ * Deprecate the third element of the outer array returned by `FirewallMapInterface::getListener` which contains the `LogoutListener`.
 
 5.3
 ---
diff --git a/src/Symfony/Component/Security/Http/Firewall.php b/src/Symfony/Component/Security/Http/Firewall.php
@@ -48,7 +48,7 @@ public function onKernelRequest(RequestEvent $event)
         }
 
         // register listeners for this firewall
-        $listeners = $this->map->getListeners($event->getRequest());
+        $listeners = $this->map->getListeners($event->getRequest(), false);
 
         $authenticationListeners = $listeners[0];
         $exceptionListener = $listeners[1];
diff --git a/src/Symfony/Component/Security/Http/FirewallMap.php b/src/Symfony/Component/Security/Http/FirewallMap.php
@@ -36,6 +36,10 @@ public function add(RequestMatcherInterface $requestMatcher = null, array $liste
      */
     public function getListeners(Request $request)
     {
+        if (2 > \func_num_args() || func_get_arg(1)) {
+            trigger_deprecation('symfony/security', '5.4', 'The third element in the return value of "%s()" is deprecated', __METHOD__);
+        }
+
         foreach ($this->map as $elements) {
             if (null === $elements[0] || $elements[0]->matches($request)) {
                 return [$elements[1], $elements[2], $elements[3]];
diff --git a/src/Symfony/Component/Security/Http/FirewallMapInterface.php b/src/Symfony/Component/Security/Http/FirewallMapInterface.php
@@ -33,6 +33,10 @@ interface FirewallMapInterface
      * If there is no logout listener, the third element of the outer array
      * must be null.
      *
+     * The third element of the outer array is deprecated since Symfony 5.4. It
+     * will be removed in Symfony 6.0 and instead the LogoutListener will be
+     * included in the first element.
+     *
      * @return array of the format [[AuthenticationListener], ExceptionListener, LogoutListener]
      */
     public function getListeners(Request $request);

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,10 @@ public function __construct(ContainerInterface $container, iterable $map)`
`35`	`35`
`36`	`36`	`public function getListeners(Request $request)`
`37`	`37`	`{`
	`38`	`+ if (2 > \func_num_args() \|\| func_get_arg(1)) {`
	`39`	`+ trigger_deprecation('symfony/security-bundle', '5.4', 'The third element in the return value of "%s()" is deprecated', __METHOD__);`
	`40`	`+ }`
	`41`	`+`
`38`	`42`	`$context = $this->getFirewallContext($request);`
`39`	`43`
`40`	`44`	`if (null === $context) {`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function onKernelRequest(RequestEvent $event)`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`// register listeners for this firewall`
`51`		`- $listeners = $this->map->getListeners($event->getRequest());`
	`51`	`+ $listeners = $this->map->getListeners($event->getRequest(), false);`
`52`	`52`
`53`	`53`	`$authenticationListeners = $listeners[0];`
`54`	`54`	`$exceptionListener = $listeners[1];`