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

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 | symfony/symfony#25288 (comment)
| License       | MIT
| Doc PR        | n/a

Commits
-------

28397e5b2c Add ControllerTrait::getParameter()

Author: fabpot

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,
         );
     }
 }

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);
+    }
 }

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;
     }
 }