Як визначати контролери як сервіси

В Symfony контролер не повинен бути зареєстрований як сервіс. Але якщо ви використовуєте конфігурацію services.yaml за замовчуванням , і ваші контролери розширюють клас AbstractController, вони вже автоматично зареєстровані як сервіси. Це означає, що ви можете використовувати впровадження залежностей, як і будь-який інший нормальний сервіс.

Якщо ваші контроллери не розширюють клас AbstractController, ви повинні чітко помітити ваші сервіси контролера як public. Як варіант, ви можете застосувати тег controller.service_arguments до ваших сервісів контролера. Це зробить теговані сервіси public та дозволить вам впроваджувати сервіси у параметрах методу:

1
2
3
4
5
6
7

# config/services.yaml

# контролери імпортуються окреми, щоб гарантувати, що сервіси можуть бути впроваджені
# в якості аргументу дії, навіть якщо ви не розширюєте ніякий базовий клас контролера
App\Controller\:
   resource: '../src/Controller/'
   tags: ['controller.service_arguments']

If you prefer, you can use the #[AsController] PHP attribute to automatically apply the controller.service_arguments tag to your controller services:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// src/Controller/HelloController.php
namespace App\Controller;

use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\Routing\Annotation\Route;

#[AsController]
class HelloController
{
    #[Route('/hello', name: 'hello', methods: ['GET'])]
    public function index()
    {
        // ...
    }
}

Реєстрація вашого контролера як сервісу - це перший крок, але ви також повинні переконатися, що ваш маршрутизатор коректно посилається на сервіс, щоб Symfony знала, що його потрібно використовувати.

Використовуйте синтаксис service_id::method_name, щоб посилатися на метод контролера. Якщо id сервісу є повністю кваліфікованим іменем класу (FQCN) вашого контролера, як рекомендує Symfony, то синтаксис буде таким же, як якщо б контролер не був сервісом, на кшталт: App\Controller\HelloController::index:

1
2
3
4
5
6
7
8
9
10
11
12
13

// src/Controller/HelloController.php
namespace App\Controller;

use Symfony\Component\Routing\Annotation\Route;

class HelloController
{
    #[Route('/hello', name: 'hello', methods: ['GET'])]
    public function index()
    {
        // ...
    }
}

1
2
3
4
5

# config/routes.yaml
hello:
    path:     /hello
    controller: App\Controller\HelloController::index
    methods: GET

1
2
3
4
5
6
7
8
9
10

<!-- config/routes.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <route id="hello" path="/hello" controller="App\Controller\HelloController::index" methods="GET"/>

</routes>

1
2
3
4
5
6
7
8
9
10

// config/routes.php
use App\Controller\HelloController;
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

return function (RoutingConfigurator $routes) {
    $routes->add('hello', '/hello')
        ->controller([HelloController::class, 'index'])
        ->methods(['GET'])
    ;
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14

// src/Controller/Hello.php
namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

#[Route('/hello/{name}', name: 'hello')]
class Hello
{
    public function __invoke($name = 'World')
    {
        return new Response(sprintf('Hello %s!', $name));
    }
}

1
2
3
4

# config/routes.yaml
hello:
    path:     /hello/{name}
    controller: app.hello_controller

1
2
3
4
5
6
7
8
9
10
11
12

<!-- config/routes.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <route id="hello" path="/hello/{name}">
        <default key="_controller">app.hello_controller</default>
    </route>

</routes>

1
2
3
4

// app/config/routing.php
$collection->add('hello', new Route('/hello', [
    '_controller' => 'app.hello_controller',
]));

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

// src/Controller/HelloController.php
namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Twig\Environment;

class HelloController
{
    private $twig;

    public function __construct(Environment $twig)
    {
        $this->twig = $twig;
    }

    public function index($name)
    {
        $content = $this->twig->render(
            'hello/index.html.twig',
            ['name' => $name]
        );

        return new Response($content);
    }
}