feature #25439 Add ControllerTrait::getParameter() (chalasr)

fabpot · fabpot · commit 2c976f746734 · 2017-12-11T13:49:45.000-08:00
This PR was merged into the 4.1-dev branch. Discussion ---------- Add ControllerTrait::getParameter() | Q | A | ------------- | --- | Branch? | 4.1 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #25288 (comment) | License | MIT | Doc PR | n/a Commits ------- 28397e5 Add ControllerTrait::getParameter()
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php b/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php
@@ -13,6 +13,7 @@
 
 use Psr\Container\ContainerInterface;
 use Doctrine\Common\Persistence\ManagerRegistry;
+use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
 use Symfony\Component\DependencyInjection\ServiceSubscriberInterface;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -67,6 +68,7 @@ public static function getSubscribedServices()
             'form.factory' => '?'.FormFactoryInterface::class,
             'security.token_storage' => '?'.TokenStorageInterface::class,
             'security.csrf.token_manager' => '?'.CsrfTokenManagerInterface::class,
+            'parameter_bag' => '?'.ContainerBagInterface::class,
         );
     }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php b/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php
@@ -377,4 +377,20 @@ protected function isCsrfTokenValid(string $id, string $token): bool
 
         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
     }
+
+    /**
+     * Gets a container configuration parameter by its name.
+     *
+     * @return mixed
+     *
+     * @final
+     */
+    protected function getParameter(string $name)
+    {
+        if (!$this->container->has('parameter_bag')) {
+            throw new \LogicException('The "parameter_bag" service is not available. Try running "composer require dependency-injection:^4.1"');
+        }
+
+        return $this->container->get('parameter_bag')->get($name);
+    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerTraitTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerTraitTest.php
@@ -14,6 +14,9 @@
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
 use Symfony\Bundle\FrameworkBundle\Controller\ControllerTrait;
 use Symfony\Component\DependencyInjection\Container;
+use Symfony\Component\DependencyInjection\ParameterBag\ContainerBag;
+use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
+use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -528,6 +531,23 @@ public function testGetDoctrine()
 
         $this->assertEquals($doctrine, $controller->getDoctrine());
     }
+
+    public function testGetParameter()
+    {
+        $container = new Container(new FrozenParameterBag(array('foo' => 'bar')));
+
+        $controller = $this->createController();
+        $controller->setContainer($container);
+
+        if (!interface_exists(ContainerBagInterface::class)) {
+            $this->expectException(\LogicException::class);
+            $this->expectExceptionMessage('The "parameter_bag" service is not available. Try running "composer require dependency-injection:^4.1"');
+        } else {
+            $container->set('parameter_bag', new ContainerBag($container));
+        }
+
+        $this->assertSame('bar', $controller->getParameter('foo'));
+    }
 }
 
 trait TestControllerTrait
@@ -552,5 +572,6 @@ trait TestControllerTrait
         createForm as public;
         createFormBuilder as public;
         getDoctrine as public;
+        getParameter as public;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`use Psr\Container\ContainerInterface;`
`15`	`15`	`use Doctrine\Common\Persistence\ManagerRegistry;`
	`16`	`+use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;`
`16`	`17`	`use Symfony\Component\DependencyInjection\ServiceSubscriberInterface;`
`17`	`18`	`use Symfony\Component\Form\FormFactoryInterface;`
`18`	`19`	`use Symfony\Component\HttpFoundation\RequestStack;`
`@@ -67,6 +68,7 @@ public static function getSubscribedServices()`
`67`	`68`	`'form.factory' => '?'.FormFactoryInterface::class,`
`68`	`69`	`'security.token_storage' => '?'.TokenStorageInterface::class,`
`69`	`70`	`'security.csrf.token_manager' => '?'.CsrfTokenManagerInterface::class,`
	`71`	`+ 'parameter_bag' => '?'.ContainerBagInterface::class,`
`70`	`72`	`);`
`71`	`73`	`}`
`72`	`74`	`}`