From 0fc886d2ae9fa02ef220bf1e97518034761897df Mon Sep 17 00:00:00 2001 From: Antoine Makdessi Date: Tue, 28 Dec 2021 14:13:49 +0100 Subject: [PATCH] [Messenger] Document the validation middleware --- messenger.rst | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/messenger.rst b/messenger.rst index e177e99655b..8a4d66fe4ac 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1730,6 +1730,67 @@ may want to use: ], ]); +Other Middlewares +~~~~~~~~~~~~~~~~~ + +.. versionadded:: 4.1 + + The ``validation`` middleware was introduced in Symfony 4.1. + +Add the ``validation`` middleware if you need to validate the message +object using the :doc:`Validator component ` before handling it. +If validation fails, a ``ValidationFailedException`` will be thrown. The +:class:`Symfony\\Component\\Messenger\\Stamp\\ValidationStamp` can be used +to configure the validation groups. + +.. configuration-block:: + + .. code-block:: yaml + + # config/packages/messenger.yaml + framework: + messenger: + buses: + command_bus: + middleware: + - validation + + .. code-block:: xml + + + + + + + + + + + + + + + .. code-block:: php + + // config/packages/messenger.php + $container->loadFromExtension('framework', [ + 'messenger' => [ + 'buses' => [ + 'command_bus' => [ + 'middleware' => [ + 'validation', + ], + ], + ], + ], + ]); + Messenger Events ~~~~~~~~~~~~~~~~