Skip to content

[Messenger] Add documentation for RouterContextMiddleware #14969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 16, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions messenger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1954,6 +1954,67 @@ may want to use:
],
]);

Other Middlewares
~~~~~~~~~~~~~~~~~

.. versionadded:: 5.3

The ``router_context`` middleware were introduced in Symfony 5.3.

When the consumer needs to build an absolute URL, for instance: rendering a
template with links, it needs the initial's request context in order to
retrieves the domain and information needed to build the URL. This can be
achieved by declaring the ``router_context`` middleware in the bus.

.. configuration-block::

.. code-block:: yaml

# config/packages/messenger.yaml
framework:
messenger:
buses:
command_bus:
middleware:
- router_context

.. code-block:: xml

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

<framework:config>
<framework:messenger>
<framework:bus name="command_bus">
<framework:middleware id="router_context"/>
</framework:bus>
</framework:messenger>
</framework:config>
</container>

.. code-block:: php

// config/packages/messenger.php
$container->loadFromExtension('framework', [
'messenger' => [
'buses' => [
'command_bus' => [
'middleware' => [
'router_context',
],
],
],
],
]);


Messenger Events
~~~~~~~~~~~~~~~~

Expand Down