Symfony 4 - accessing parameters inside a Controller

Question

I'm trying to get some parameters defined in the services.yaml into one of my controllers, but I can't seem to find anything that works.

The idea is that I want to have a common string inside all of my controllers that defines the prefix of all the routes inside my application, for example /api/v1/.

I'm trying to store that string inside the services.yaml file as it seems the appropriate place to do it.

Also, I would like to use the contents of these parameters inside the method annotation...

Any ideas?

score 4 · Answer 1 · answered May 28 '18 at 10:59

4

Starting from Symfony 4.1 you will be able to wire container parameters automatically.

For now you have to explicitly tell the dependency injection component how to wire such property. You can create a service for that to have it autowired everywhere you want:

namespace App\Provider;

final class DefaultEndpointProvider
{
    private $url;

    public function __construct(string $url)
    {
        $this->url = $url;
    }

    public function getUrl()
    {
        return $this->url;
    }
}

service definition:

# todo: replace with parameter bind in Sf4.1
App\Provider\DefaultEndpointProvider:
  arguments:
    $url: '%common_url_parameter%'

then you can simply require that service as a dependency in your controllers / services etc.

answered May 28 '18 at 10:59

Mike Doe

16,349
11
65
88

and is this available as well on Route annotations? – LuisF May 28 '18 at 12:52
It [should](https://symfony.com/doc/current/routing/service_container_parameters.html). Haven't you tried yet? – Mike Doe May 28 '18 at 14:10
@Route("/user/list/", name="user-list"), how can I call the method inside this annotation? I have no idea – LuisF May 28 '18 at 15:34
Don't call a method, try with the parameter `@Route("%common_url_parameter%/user/list/"...` – Mike Doe May 29 '18 at 06:42

score 3 · Answer 2 · edited May 28 '18 at 13:20

3

If you don't want to inject the parameter you can use this:

$this->getParameter('your.parameter');

service.yaml

parameters:
    your.parameter: /api/v1/

edited May 28 '18 at 13:20

fucethebads

471
1
5
10

answered May 28 '18 at 11:02

Vyctorya

1,387
1
12
18

Just mind that accessing anything via a container is an antipattern. – Mike Doe May 28 '18 at 11:03
@Vyctorya how can I inject the parameter? – LuisF May 28 '18 at 11:49
1

look at emix answer :) – Vyctorya May 28 '18 at 12:01
it is and anti pattern, this means you should not use it if you can. if there is no other option. the i would use the $this->getParameter() – fucethebads May 28 '18 at 12:34
@emix about the anti-pattern comment you made, can you please point us your source? Or give us some clarification of why is it so? – Francisco Luz Aug 26 '19 at 15:03
@emix nevermind. The answer provided by Dan Blows at https://stackoverflow.com/questions/23931321/in-symfony2-why-is-it-a-bad-idea-to-inject-the-service-container-rather-than-i says it all. – Francisco Luz Aug 26 '19 at 15:09
1

This is violation of the Law of Demeter. – Mike Doe Aug 26 '19 at 15:10

Florian Hermann · Answer 3 · 2018-05-29T07:08:10.590

I don't think that accessing parameters from a service is the better choice. I will suggest you rather to define your parameter in the "bind" section of service.yaml file like this

services:
    _defaults:
        autowire: true
        autoconfigure: true
        public: false

        # Bind all arguments requested by multiple services (auto-wiring)
        bind:
            $yourParameter: '%your.parameter%'

Put a parameter in this bind section allows you to inject it like a service in all other services (including controllers).

Then in your controllers and all other services, you could do something like this:

class RandomController extends Controller
{
    private $yourParameter;

    public function __construct(string $yourParameter)
    {
        $this->yourParameter = $yourParameter;
    }
    ...

I answered your question about injecting parameters. Now if you want to use it in your route annotation, I would test something like this.

/**
 * @Route("/api/{apiVersion}/the/rest/of/your/route", name="route_name", defaults={"apiVersion"="%yourParameter%"})
 */
public function yourAction()
{}

I didn't test this last solution. Don't know if it still work with symfony 4. If not maybe try to put %$yourParameter% (with a '$'). Tell me about that.

Edit:

Or even better for you situation (I assume that you are using the annotation routing): I guess your parameter is important only for the /api/ part of your application. Then you can define in your config/routes/annotations.yaml file all your controller concerned by your api. I suggest something like this.

controllers:
    path: /api/{apiVersion}
    resource: ../../src/Controller/Api
    type: annotation
    defaults:
        apiVersion : '%your.parameter%'
    # And maybe add also requirements like this
    requirements:
        apiVersion: 'v0|v1|v2'

Where all your api controllers are in the src/Controller/Api folder. Therefore, this solution allows you to define this configuration only once.

Symfony 4 - accessing parameters inside a Controller

3 Answers3