refactor: move symfony messenger from core to symfony

api-platform · Nov 28, 2024 · dcc89f9 · dcc89f9
1 parent 8115686
commit dcc89f9
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/core/design.md b/core/design.md
@@ -40,7 +40,7 @@ Again, it's up to the developers to use, or to not use these built-in state prov
 they are dealing with.
 API Platform makes it easy to create custom state providers and processors.
 It also makes it easy to implement patterns such as [CQS](https://www.martinfowler.com/bliki/CommandQuerySeparation.html)
-or [CQRS](https://martinfowler.com/bliki/CQRS.html) thanks to [the Messenger Component integration](messenger.md) and the [DTO support](dto.md).
+or [CQRS](https://martinfowler.com/bliki/CQRS.html) thanks to [the Messenger Component integration](../symfony/messenger.md) and the [DTO support](dto.md).
 
 Last but not least, to create [Event Sourcing](https://martinfowler.com/eaaDev/EventSourcing.html)-based systems, a convenient
 approach is:

diff --git a/core/dto.md b/core/dto.md
@@ -75,7 +75,7 @@ In some cases, using an input DTO is a way to avoid serialization groups.
 
 ## Use Messenger With an Input DTO
 
-Let's use a message that will be processed by [Symfony Messenger](https://symfony.com/components/Messenger). API Platform has an [integration with messenger](./messenger.md), to use a DTO as input you need to specify the `input` attribute:
+Let's use a message that will be processed by [Symfony Messenger](https://symfony.com/components/Messenger). API Platform has an [integration with messenger](../symfony/messenger.md), to use a DTO as input you need to specify the `input` attribute:
 
 ```php
 <?php

diff --git a/core/extending.md b/core/extending.md
@@ -16,7 +16,7 @@ The following tables summarizes which extension point to use depending on what y
 | [Normalizers](serialization.md#decorating-a-serializer-and-adding-extra-data)                  | customize the resource sent to the client (add fields in JSON documents, encode codes, dates...)                                                                                                                                    |
 | [Filters](filters.md)                                                                          | create filters for collections and automatically document them (OpenAPI, GraphQL, Hydra)                                                                                                                                            |
 | [Serializer Context Builders](serialization.md#changing-the-serialization-context-dynamically) | change the Serialization context (e.g. groups) dynamically                                                                                                                                                                          |
-| [Messenger Handlers](messenger.md)                                                             | create 100% custom, RPC, async, service-oriented endpoints (should be used in place of custom controllers because the messenger integration is compatible with both REST and GraphQL, while custom controllers only work with REST) |
+| [Messenger Handlers](../symfony/messenger.md)                                                             | create 100% custom, RPC, async, service-oriented endpoints (should be used in place of custom controllers because the messenger integration is compatible with both REST and GraphQL, while custom controllers only work with REST) |
 | [DTOs](dto.md)                                                                                 | use a specific class to represent the input or output data structure related to an operation                                                                                                                                        |
 | [Kernel Events](events.md)                                                                     | customize the HTTP request or response (REST only, other extension points must be preferred when possible)                                                                                                                          |
 

diff --git a/core/migrate-from-fosrestbundle.md b/core/migrate-from-fosrestbundle.md
@@ -33,7 +33,7 @@ Same as above.
 
 Even though this is not recommended, API Platform allows you to [create custom controllers](controllers.md) and declare them in your entity's `ApiResource` attribute.
 
-You can use them as you migrate from FOSRestBundle, but you should consider [switching to Symfony Messenger](messenger.md) as it will give you more benefits, such as compatibility with both REST and GraphQL and better performances of your API on big tasks.
+You can use them as you migrate from FOSRestBundle, but you should consider [switching to Symfony Messenger](../symfony/messenger.md) as it will give you more benefits, such as compatibility with both REST and GraphQL and better performances of your API on big tasks.
 
 See [General Design Considerations](design.md).
 

diff --git a/outline.yaml b/outline.yaml
@@ -9,6 +9,7 @@ chapters:
       - testing
       - debugging
       - caddy
+      - messenger
   - title: "API Platform for Laravel"
     path: laravel
     items:
@@ -43,7 +44,6 @@ chapters:
       - default-order
       - performance
       - extensions
-      - messenger
       - dto
       - openapi
       - json-schema

diff --git a/core/messenger.md → symfony/messenger.md b/core/messenger.md → symfony/messenger.md
@@ -69,9 +69,9 @@ Because the `messenger` attribute is `true`, when a `POST` is handled by API Pla
 For this example, only the `POST` operation is enabled. We disabled the item operation using the `NotFoundAction`. A resource must have at least one item operation as it must be identified by an IRI, here the route `/people/1` exists, eventhough it returns a 404 status code.
 We use the `status` attribute to configure API Platform to return a [202 Accepted HTTP status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202).
 It indicates that the request has been received and will be treated later, without giving an immediate return to the client.
-Finally, the `output` attribute is set to `false`, so the HTTP response that will be generated by API Platform will be empty, and the [serialization process](serialization.md) will be skipped.
+Finally, the `output` attribute is set to `false`, so the HTTP response that will be generated by API Platform will be empty, and the [serialization process](../core/serialization.md) will be skipped.
 
-**Note:** when using `messenger=true` ApiResource attribute in a Doctrine entity, the Doctrine Processor is not called. If you want the Doctrine Processor to be called, you should [decorate a built-in state processor](state-processors.md#decorating-the-built-in-state-processors) and implement your own logic.
+**Note:** when using `messenger=true` ApiResource attribute in a Doctrine entity, the Doctrine Processor is not called. If you want the Doctrine Processor to be called, you should [decorate a built-in state processor](../core/state-processors.md#creating-a-custom-state-processor) and implement your own logic.
 
 ## Registering a Message Handler
 
@@ -116,7 +116,7 @@ To differentiate typical persists calls (create and update) and removal calls, c
 
 ## Using Messenger with an Input Object
 
-Set the `messenger` attribute to `input`, and API Platform will automatically dispatch the given Input as a message instead of the Resource. Indeed, it'll add a default `DataTransformer` ([see input/output documentation](./dto.md)) that handles the given `input`. In this example, we'll handle a `ResetPasswordRequest` on a custom operation on our `User` resource:
+Set the `messenger` attribute to `input`, and API Platform will automatically dispatch the given Input as a message instead of the Resource. Indeed, it'll add a default `DataTransformer` ([see input/output documentation](../core/dto.md)) that handles the given `input`. In this example, we'll handle a `ResetPasswordRequest` on a custom operation on our `User` resource:
 
 ```php
 <?php
@@ -163,7 +163,7 @@ final class ResetPasswordRequest
 
 As above, we use the `status` attribute to configure API Platform to return a [202 Accepted HTTP status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202).
 It indicates that the request has been received and will be treated later, without giving an immediate return to the client.
-Finally, the `output` attribute is set to `false`, so the HTTP response that will be generated by API Platform will be empty, and the [serialization process](serialization.md) will be skipped.
+Finally, the `output` attribute is set to `false`, so the HTTP response that will be generated by API Platform will be empty, and the [serialization process](../core/serialization.md) will be skipped.
 
 In this case, when a `POST` request is issued on `/users/reset_password` the message handler will receive an `App\Dto\ResetPasswordRequest` object instead of a `User` because we specified it as `input` and set `messenger=input`: