minor #22475 [SecurityBundle] Enhance FirewallContext::getListeners() (ro0NL)

fabpot · fabpot · commit 025701330882 · 2017-04-26T13:18:04.000-04:00
This PR was merged into the 3.3-dev branch. Discussion ---------- [SecurityBundle] Enhance FirewallContext::getListeners() | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20417 (comment), #20417 (comment) | License | MIT | Doc PR | symfony/symfony-docs#...  I think @stof is right.. and the fact we can do this on master currently without the hassle. cc @chalasr Commits ------- ba65078 [SecurityBundle] Enhance FirewallContext::getListeners()
diff --git a/UPGRADE-3.3.md b/UPGRADE-3.3.md
@@ -313,7 +313,7 @@ SecurityBundle
 --------------
 
  * The `FirewallContext::getContext()` method has been deprecated and will be removed in 4.0.
-   Use the `getListeners()` method instead.
+   Use the `getListeners()` and/or `getExceptionListener()` method instead.
 
  * The `FirewallMap::$map` and `$container` properties have been deprecated and will be removed in 4.0.
 
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -434,7 +434,7 @@ Security
 SecurityBundle
 --------------
 
- * The `FirewallContext::getContext()` method has been removed, use the `getListeners()` method instead.
+ * The `FirewallContext::getContext()` method has been removed, use the `getListeners()` and/or `getExceptionListener()` method instead.
 
  * The `FirewallMap::$map` and `$container` properties have been removed.
 
diff --git a/src/Symfony/Bundle/SecurityBundle/Security/FirewallContext.php b/src/Symfony/Bundle/SecurityBundle/Security/FirewallContext.php
@@ -38,17 +38,22 @@ public function getConfig()
     }
 
     /**
-     * @deprecated since version 3.3, will be removed in 4.0. Use {@link getListeners()} instead.
+     * @deprecated since version 3.3, will be removed in 4.0. Use {@link getListeners()} and/or {@link getExceptionListener()} instead.
      */
     public function getContext()
     {
-        @trigger_error(sprintf('Method %s() is deprecated since version 3.3 and will be removed in 4.0. Use %s::getListeners() instead.', __METHOD__, __CLASS__), E_USER_DEPRECATED);
+        @trigger_error(sprintf('Method %s() is deprecated since version 3.3 and will be removed in 4.0. Use %s::getListeners/getExceptionListener() instead.', __METHOD__, __CLASS__), E_USER_DEPRECATED);
 
-        return $this->getListeners();
+        return array($this->getListeners(), $this->getExceptionListener());
     }
 
     public function getListeners()
     {
-        return array($this->listeners, $this->exceptionListener);
+        return $this->listeners;
+    }
+
+    public function getExceptionListener()
+    {
+        return $this->exceptionListener;
     }
 }
diff --git a/src/Symfony/Bundle/SecurityBundle/Security/FirewallMap.php b/src/Symfony/Bundle/SecurityBundle/Security/FirewallMap.php
@@ -124,7 +124,7 @@ public function getListeners(Request $request)
             return array(array(), null);
         }
 
-        return $context->getListeners();
+        return array($context->getListeners(), $context->getExceptionListener());
     }
 
     /**
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Security/FirewallContextTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/Security/FirewallContextTest.php
@@ -32,18 +32,21 @@ public function testGetters()
 
         $context = new FirewallContext($listeners, $exceptionListener, $config);
 
-        $this->assertEquals(array($listeners, $exceptionListener), $context->getListeners());
+        $this->assertEquals($listeners, $context->getListeners());
+        $this->assertEquals($exceptionListener, $context->getExceptionListener());
         $this->assertEquals($config, $context->getConfig());
     }
 
     /**
-     * @expectedDeprecation Method Symfony\Bundle\SecurityBundle\Security\FirewallContext::getContext() is deprecated since version 3.3 and will be removed in 4.0. Use Symfony\Bundle\SecurityBundle\Security\FirewallContext::getListeners() instead.
+     * @expectedDeprecation Method Symfony\Bundle\SecurityBundle\Security\FirewallContext::getContext() is deprecated since version 3.3 and will be removed in 4.0. Use Symfony\Bundle\SecurityBundle\Security\FirewallContext::getListeners/getExceptionListener() instead.
      * @group legacy
      */
-    public function testGetContextTriggersDeprecation()
+    public function testGetContext()
     {
-        (new FirewallContext(array(), $this->getExceptionListenerMock(), new FirewallConfig('main', 'request_matcher', 'user_checker')))
+        $context = (new FirewallContext($listeners = array(), $exceptionListener = $this->getExceptionListenerMock(), new FirewallConfig('main', 'request_matcher', 'user_checker')))
             ->getContext();
+
+        $this->assertEquals(array($listeners, $exceptionListener), $context);
     }
 
     private function getExceptionListenerMock()

Original file line number	Diff line number	Diff line change
`@@ -38,17 +38,22 @@ public function getConfig()`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`/**`
`41`		`- * @deprecated since version 3.3, will be removed in 4.0. Use {@link getListeners()} instead.`
	`41`	`+ * @deprecated since version 3.3, will be removed in 4.0. Use {@link getListeners()} and/or {@link getExceptionListener()} instead.`
`42`	`42`	`*/`
`43`	`43`	`public function getContext()`
`44`	`44`	`{`
`45`		`- @trigger_error(sprintf('Method %s() is deprecated since version 3.3 and will be removed in 4.0. Use %s::getListeners() instead.', __METHOD__, __CLASS__), E_USER_DEPRECATED);`
	`45`	`+ @trigger_error(sprintf('Method %s() is deprecated since version 3.3 and will be removed in 4.0. Use %s::getListeners/getExceptionListener() instead.', __METHOD__, __CLASS__), E_USER_DEPRECATED);`
`46`	`46`
`47`		`- return $this->getListeners();`
	`47`	`+ return array($this->getListeners(), $this->getExceptionListener());`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`public function getListeners()`
`51`	`51`	`{`
`52`		`- return array($this->listeners, $this->exceptionListener);`
	`52`	`+ return $this->listeners;`
	`53`	`+ }`
	`54`	`+`
	`55`	`+ public function getExceptionListener()`
	`56`	`+ {`
	`57`	`+ return $this->exceptionListener;`
`53`	`58`	`}`
`54`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ public function getListeners(Request $request)`
`124`	`124`	`return array(array(), null);`
`125`	`125`	`}`
`126`	`126`
`127`		`- return $context->getListeners();`
	`127`	`+ return array($context->getListeners(), $context->getExceptionListener());`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`/**`