[SecurityBundle] Rename FirewallContext#getContext()

chalasr · chalasr · commit ee66b4973dcb · 2016-12-08T23:44:32.000+01:00
diff --git a/UPGRADE-3.3.md b/UPGRADE-3.3.md
@@ -12,3 +12,9 @@ Security
 
  * The `RoleInterface` has been deprecated. Extend the `Symfony\Component\Security\Core\Role\Role`
    class in your custom role implementations instead.
+
+SecurityBundle
+--------------
+
+ * The `FirewallContext::getContext()` method has been deprecated and will be removed in 4.0.
+   Use the `getListeners()` method instead.
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -134,6 +134,11 @@ FrameworkBundle
    `serializer.mapping.cache.apc` and `serializer.mapping.cache.doctrine.apc`
    have been removed. APCu should now be automatically used when available.
 
+SecurityBundle
+--------------
+
+ * The `FirewallContext::getContext()` method has been removed, use the `getListeners()` method instead.
+
 HttpFoundation
 ---------------
 
diff --git a/src/Symfony/Bundle/SecurityBundle/Security/FirewallContext.php b/src/Symfony/Bundle/SecurityBundle/Security/FirewallContext.php
@@ -37,7 +37,17 @@ public function getConfig()
         return $this->config;
     }
 
+    /**
+     * @deprecated since version 3.3, will be removed in 4.0. Use {@link getListeners()} 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);
+
+        return $this->getListeners();
+    }
+
+    public function getListeners()
     {
         return array($this->listeners, $this->exceptionListener);
     }
diff --git a/src/Symfony/Bundle/SecurityBundle/Security/FirewallMap.php b/src/Symfony/Bundle/SecurityBundle/Security/FirewallMap.php
@@ -46,7 +46,7 @@ public function getListeners(Request $request)
             return array(array(), null);
         }
 
-        return $context->getContext();
+        return $context->getListeners();
     }
 
     /**
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Security/FirewallContextTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/Security/FirewallContextTest.php
@@ -21,12 +21,7 @@ class FirewallContextTest extends \PHPUnit_Framework_TestCase
     public function testGetters()
     {
         $config = new FirewallConfig('main', 'user_checker', 'request_matcher');
-
-        $exceptionListener = $this
-            ->getMockBuilder(ExceptionListener::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
+        $exceptionListener = $this->getExceptionListenerMock();
         $listeners = array(
             $this
                 ->getMockBuilder(ListenerInterface::class)
@@ -36,7 +31,25 @@ public function testGetters()
 
         $context = new FirewallContext($listeners, $exceptionListener, $config);
 
-        $this->assertEquals(array($listeners, $exceptionListener), $context->getContext());
+        $this->assertEquals(array($listeners, $exceptionListener), $context->getListeners());
         $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.
+     * @group legacy
+     */
+    public function testGetContextTriggersDeprecation()
+    {
+        (new FirewallContext(array(), $this->getExceptionListenerMock(), new FirewallConfig('main', 'request_matcher', 'user_checker')))
+            ->getContext();
+    }
+
+    private function getExceptionListenerMock()
+    {
+        return $this
+            ->getMockBuilder(ExceptionListener::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,17 @@ public function getConfig()`
`37`	`37`	`return $this->config;`
`38`	`38`	`}`
`39`	`39`
	`40`	`+ /**`
	`41`	`+ * @deprecated since version 3.3, will be removed in 4.0. Use {@link getListeners()} instead.`
	`42`	`+ */`
`40`	`43`	`public function getContext()`
	`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);`
	`46`	`+`
	`47`	`+ return $this->getListeners();`
	`48`	`+ }`
	`49`	`+`
	`50`	`+ public function getListeners()`
`41`	`51`	`{`
`42`	`52`	`return array($this->listeners, $this->exceptionListener);`
`43`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public function getListeners(Request $request)`
`46`	`46`	`return array(array(), null);`
`47`	`47`	`}`
`48`	`48`
`49`		`- return $context->getContext();`
	`49`	`+ return $context->getListeners();`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`/**`