Використовуючи атрибут #[Route]

При використанні атрибуту #[Route] для визначення маршрутів у будь-якому класі PHP, Symfony розглядає цей клас як контролер. Вона реєструє його як публічний, нелінивий сервіс та вмикає впровадження аргументів сервіса у всіх його методах.

Це найпростіший та рекомендований спосіб реєстрації контролерів як сервісів, коли не розширюється базовий клас контролера.

Використовуючи атрибут #[AsController]

Якщо вам так більше подобається, ви можете використовувати PHP-атрибут #[AsController], щоб автоматично застосовувати тег controller.service_arguments до ваших сервісів контролера:

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

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

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\Routing\Attribute\Route;

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

Використовуючи тег сервісу controller.service_arguments

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

1
2
3
4
5
6
7

# config/services.yaml

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

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

# config/services.yaml

# ця розширена конфігурація необхідна лише за умови, що не використовується автомонтування/автоконфігурація,
# що малорозсповсюджено і не рекомендовано

abstract_controller.locator:
    class: Symfony\Component\DependencyInjection\ServiceLocator
    arguments:
        -
            router: '@router'
            request_stack: '@request_stack'
            http_kernel: '@http_kernel'
            session: '@session'
            parameter_bag: '@parameter_bag'
            # ви можете додати більше сервісів тут, коли вони вам знадобляться (наприклад, сервіс `serializer`)
            # і подивитися на клас AbstractController, щоб побачити, які сервіси визначені в локаторі

App\Controller\:
    resource: '../src/Controller/'
    tags: ['controller.service_arguments']
    calls:
        - [setContainer, ['@abstract_controller.locator']]

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

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

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

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

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

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

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): void {
    $routes->add('hello', '/hello')
        ->controller([HelloController::class, 'index'])
        ->methods(['GET'])
    ;
};

Викличні контролери

Контролери також можуть визначати одну дію, використовуючи метод __invoke(),
що є розповсюдженою практикою при дотриманні патерну ADR (Дія-Домен-Відповідач):

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\Attribute\Route;

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

1
2
3
4

# config/routes.yaml
hello:
    path:       /hello/{name}
    controller: App\Controller\HelloController

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\Controller\HelloController</default>
    </route>

</routes>

1
2
3
4
5
6

use App\Controller\HelloController;

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

Альтернативи базових методів контролера

При використанні контролера, визначеного як сервіс, ви все ще можете розширити базовий контролер AbstractController та використовувати його скорочення. Але ви не повинні цього робити! Ви можете обрати не розширювати нічого та використати впровадження залежності, щоб отримати доступ до різних сервісів.

Базовий початковий код класу контролера - це чудовий спосіб дізнатися, як можна досягти виконання загальних задач. Наприклад, $this->render() зазвичай використовується для відображення шаблону Twig та повернення Відповіді. Але ви також можете зробити це напряму:

У контролері, визначеному як сервіс, ви можете замість цього впровадити сервіс twig та використати його напряму:

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

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

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

class HelloController
{
    public function __construct(
        private Environment $twig,
    ) {
    }

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

        return new Response($content);
    }
}

Ви також можете використати спеціальне впровадження залежності на основі дій , щоб отримувати сервіси в якості аргументів ваших методів дій контролера.