Зв'язування URL з контролером

Для того, щоб побачити результат цього контролера, вам знадобиться прив'язати URL до нього за допомогою маршруту. Це було зроблено вище за допомогою анотації маршруту #[Route('/lucky/number/{max}')].

Щоб побачити вашу сторінку, перейдіть на цей URL у вашому браузері: http://localhost:8000/lucky/number/100

Для того, щоб дізнатися більше про маршрутизацію, див. главу Маршрутизация.

Генерування URL

Метод generateUrl() - це просто метод-хелпер, який генерує URL для заданого маршруту:

1

$url = $this->generateUrl('app_lucky_number', ['max' => 10]);

Перенаправлення

Якщо ви хочете перенаправити користувача на іншу сторінку, використовуйте методи

redirectToRoute() та redirect():

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
26
27
28
29

use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Response;

// ...
public function index(): RedirectResponse
{
    // перенаправлення на маршрут "homepage"
    return $this->redirectToRoute('homepage');

    // redirectToRoute - скорочення для:
    // повернути новий RedirectResponse($this->generateUrl('homepage'));

    // робить постійне 301 перенаправлення
    return $this->redirectToRoute('homepage', [], 301);
    // якщо ви хочете, ви можете використати PHP-константи замість жорстко закодованих цифр
    return $this->redirectToRoute('homepage', [], Response::HTTP_MOVED_PERMANENTLY);

    // перенаправлення на маршрут з параметрами
    return $this->redirectToRoute('app_lucky_number', ['max' => 10]);

    // перенаправлення на маршрут та збереження оригінальних параметрів запиту
    return $this->redirectToRoute('blog_show', $request->query->all());

    // перенаправлення на поточний маршрут (наприклад, для патерну Post/Redirect/Get):
    return $this->redirectToRoute($request->attributes->get('_route'));

    // перенаправлення на зовнішній сайт
    return $this->redirect('http://symfony.com/doc');
}

Відображення шаблонів

Якщо ви видаєте HTML, вам знадобиться уміння відображати шаблони. Метод render() відображає шабло та розміщує його зміст в об'єкті Response для вас:

1
2

// відорбажає templates/lucky/number.html.twig
return $this->render('lucky/number.html.twig', ['number' => $number]);

Шаблонізування та Twig пояснені детальніше в статті Створення та використання шаблонів.

Отримання сервісів

Symfony за замовчуванням наповнена великою кількістю корисних об'єктів, які називаються сервісами. Вони використовуються для відобрадення шаблонів, відправки пошти, запитів до бази даних та будь-якої іншої "роботи", яку ви можете собі уявити.

Якщо вам потрібен сервіс в контролері, вкажіть клас (або інтерфейс) аргументу. Symfony автоматично передасть вам необхідний сервіс:

1
2
3
4
5
6
7
8
9
10

use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\Response;
// ...

#[Route('/lucky/number/{max}')]
public function number(int $max, LoggerInterface $logger): Response
{
    $logger->info('We are logging!');
    // ...
}

Чудово!

Які ще сервіси можна підключити за допомогою підказок? Щоб побачити їх, запустить консольну команду debug:autowiring:

1

$ php bin/console debug:autowiring

Якщо вам необхідний контроль над точним значенням аргументу, ви можете use the #[Autowire] attribute:

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
26
27
28
29

// ...
    use Psr\Log\LoggerInterface;
    use Symfony\Component\DependencyInjection\Attribute\Autowire;
    use Symfony\Component\HttpFoundation\Response;

    class LuckyController extends AbstractController
    {
        public function number(
            int $max,

            // впровадити конкретний сервіс логера
            #[Autowire(service: 'monolog.logger.request')]
            LoggerInterface $logger,

            // або впровадити значення параметра
            #[Autowire('%kernel.project_dir%')]
            string $projectDir
        ): Response
        {
            $logger->info('We are logging!');
            // ...
        }
    }

Ви можете прочитати більше про цей атрибут у :ref:`autowire-attribute`.

.. versionadded:: 6.1

    Атрибут ``#[Autowire]`` було представлено в Symfony 6.1.

Як і з усіма сервісами, ви можете використовувати звичайне впровадження через конструктор у ваших контролерах.

Щоб дізнатися більше про сервіси, див. статтю Сервіс-контейнер.

Флеш-повідомлення

Ви можете також зберігати спеціальні повідомлення, які називають флеш-повідомленнями, в користувацькій сесії. Згідно з задумкою, флеш-повідомелення передбачаються для використання лише одного разу: вони автоматично зникають з сесії, як тільки ви їх повертаєте. Ця особливість робить флеш-повідомлення особливо зручними для зберігання користувацьких сповіщень.

Для прикладу уявіть, що ви обробляєте відправку форми:

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

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
// ...

public function update(Request $request): Response
{
    // ...

    if ($form->isSubmitted() && $form->isValid()) {
        // проведіть якусь обробку

        $this->addFlash(
            'notice',
            'Ваші зміни збережені!'
        );
        // $this->addFlash() еквівалентно $request->getSession()->getFlashBag()->add()

        return $this->redirectToRoute(...);
    }

    return $this->render(...);
}

Після обробки запиту, контролер встановлює флеш-повідомлення в сесії, а потім виконує перенаправлення. Ключ до повідомлення (notice в цьому прикладі) може бути будь-яким: ви будете використовувати його для того, щоб отримати доступ до самого повідомлення.

В шаблоні наступної сторінки (або ще краще, в вашому базовому шаблоні), прочитайте будь-яке флеш-повідомлення з сесії, використовуючи метод flashes(), наданий глобальною змінною app в Twig :

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
26

{# templates/base.html.twig #}

{# прочитати та відобразити лише один тип флеш-повідомлення #}
{% for message in app.flashes('notice') %}
    <div class="flash-notice">
        {{ message }}
    </div>
{% endfor %}

{# прочитати та відобразити декілька типів флеш-повідомлень #}
{% for label, messages in app.flashes(['success', 'warning']) %}
    {% for message in messages %}
        <div class="flash-{{ label }}">
            {{ message }}
        </div>
    {% endfor %}
{% endfor %}

{# прочитати та відобразити всі флеш-повідомлення #}
{% for label, messages in app.flashes %}
    {% for message in messages %}
        <div class="flash-{{ label }}">
            {{ message }}
        </div>
    {% endfor %}
{% endfor %}

Зазвичай використовують notice, warning та error в якості ключів для різних типів флеш-повідомлень, але ви можете використовувати будь-який ключ, який вам підходить.

Доступ до параметрів конфігурації

Для отримання значень будь-яких параметрів конфігурації з контролера, використовуйте метод getParameter():

1
2
3
4
5
6

// ...
public function index(): Response
{
    $contentsDir = $this->getParameter('kernel.project_dir').'/contents';
    // ...
}

Повернення JSON-відповіді

Щоб повернути JSON з контролера, використовуйте метод json(). Він повертає спеціальний об'єкт JsonResponse, який автоматично перетворює дані в json:

1
2
3
4
5
6
7
8
9
10
11

use Symfony\Component\HttpFoundation\Response;
// ...

public function index(): Response
{
    // повертає '{"username":"jane.doe"}' та встановлює правильний заголовок Content-Type
    return $this->json(['username' => 'jane.doe']);

    // скорочення визначає три необов'язкових аргументи
    // return $this->json($data, $status = 200, $headers = [], $context = []);
}

Якщо у вашому додатку включено сервіс серіалізації, то він буде використаний для серіалізації даних в JSON. В іншому випадку буде використано функцію json_encode.

Потокова передача файлів відопвідей

Ви можете використовувати метод file(), щоб видавати файл з контролера:

1
2
3
4
5
6
7
8

use Symfony\Component\HttpFoundation\Response;
// ...

public function download(): Response
{
    // відправити зміст файлу та змусити браузер завантажити його
    return $this->file('/path/to/some_file.pdf');
}

Метод file() надає деякі аргументи, щоб сконфігурувати його поведінку:

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

use Symfony\Component\HttpFoundation\File\File;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;
// ...

public function download(): Response
{
    // завантажити файл з файлової системи
    $file = new File('/path/to/some_file.pdf');

    return $this->file($file);

    // перейменувати завантажений файл
    return $this->file($file, 'custom_name.pdf');

    // відобразити зміст файлу в браузері замість завантаження
    return $this->file('invoice_3241.pdf', 'my_invoice.pdf', ResponseHeaderBag::DISPOSITION_INLINE);
}