Add a method to retrieve firewall config by name

symfony · julienfalque · Nov 14, 2016 · Nov 21, 2016 · 56664f738c7514d601b01571b46f7d69ecb72dd8
commit 56664f738c7514d601b01571b46f7d69ecb72dd8
diff --git a/src/Symfony/Bundle/SecurityBundle/Security/FirewallMap.php b/src/Symfony/Bundle/SecurityBundle/Security/FirewallMap.php
@@ -63,6 +63,24 @@ public function getFirewallConfig(Request $request)
        return $context->getConfig();
    }

+    /**
+     * @param string $name
+     *
+     * @throws \OutOfBoundsException
+     *
+     * @return FirewallConfig
+     */
+    public function getFirewallConfigByName($name)
+    {
+        $contextId = 'security.firewall.map.context.'.$name;
+
+        if (!array_key_exists($contextId, $this->map)) {
+            throw new \OutOfBoundsException(sprintf('The firewall "%s" does not exist.', $name));
+        }
+
+        return $this->container->get($contextId)->getConfig();
+    }
+
    private function getFirewallContext(Request $request)
    {
        if ($this->contexts->contains($request)) {

diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Security/FirewallMapTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/Security/FirewallMapTest.php
@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\SecurityBundle\Tests\Security;
+
+use Symfony\Bundle\SecurityBundle\Security\FirewallConfig;
+use Symfony\Bundle\SecurityBundle\Security\FirewallMap;
+
+class FirewallMapTest extends \PHPUnit_Framework_TestCase
+{
+    public function testGetFirewallConfigByName()
+    {
+        $config = new FirewallConfig('foo', 'bar', 'baz');
+
+        $context = $this->getMockBuilder('Symfony\Bundle\SecurityBundle\Security\FirewallContext')
+            ->disableOriginalConstructor()
+            ->getMock()
+        ;
+        $context
+            ->expects($this->once())
+            ->method('getConfig')
+            ->will($this->returnValue($config))
+        ;
+
+        $container = $this->getMock('Symfony\Component\DependencyInjection\ContainerInterface');
+        $container
+            ->expects($this->once())
+            ->method('get')
+            ->with($this->equalTo('security.firewall.map.context.foo'))
+            ->will($this->returnValue($context))
+        ;
+
+        $map = new FirewallMap($container, array(
+            'security.firewall.map.context.foo' => $this->getMock('Symfony\Component\HttpFoundation\RequestMatcher'),
+            'security.firewall.map.context.bar' => $this->getMock('Symfony\Component\HttpFoundation\RequestMatcher'),
+        ));
+
+        $this->assertSame($config, $map->getFirewallConfigByName('foo'));
+    }
+
+    /**
+     * @expectedException \OutOfBoundsException
+     */
+    public function testGetFirewallConfigByNameWithUnknownName()
+    {
+        $map = new FirewallMap(
+            $this->getMock('Symfony\Component\DependencyInjection\ContainerInterface'),
+            array()
+        );
+
+        $map->getFirewallConfigByName('foo');
+    }
+}