Download the PHP package webmunkeez/adr-bundle without Composer

WebmunkeezADRBundle

This bundle unleashes the Action-Domain-Responder pattern on Symfony applications.

Installation

Use Composer to install this bundle:

Add the bundle in your application kernel:

Usage

Actions

An Action is just an invokable class that has to implement \Webmunkeez\ADRBundle\Action\ActionInterface:

But, it can be a more classic Controller that implements the same interface:

(Each service that implements ActionInterface is automatically tagged controller.service_arguments)

Responders

Responders are services which take data (an object that implements \Webmunkeez\ADRBundle\Response\ResponseDataInterface) and return it in a Response.
It can be a response containing HTML or a JsonResponse, or whatever you want, as far as it is a Symfony\Component\HttpFoundation\Response instance.

In this bundle, there is a responder manager \Webmunkeez\ADRBundle\Response\Responder that you can inject into your actions (or controllers).

This responder manager takes all responders of your application (it uses a compiler pass to get all services tagged webmunkeez_adr.responder sorted by priority) and find the right one to render the response.

You can use \Webmunkeez\ADRBundle\Response\ResponderAwareInterface and \Webmunkeez\ADRBundle\Response\ResponderAwareTrait to automatically inject Responder:

And you can use \Webmunkeez\ADRBundle\Action\ActionTrait to clean code:

Or directly extend \Webmunkeez\ADRBundle\Action\AbstractAction:

Responders are classes that implement \Webmunkeez\ADRBundle\Response\ResponderInterface (and so, they are automatically tagged webmunkeez_adr.responder):

As you can see, there are two methods: supports that defines conditions to "activate" the responder and render to make the response.

Core responders

There are two core responders provided:

HtmlResponder

\Webmunkeez\ADRBundle\Response\HtmlResponder that uses Twig for render html with a twig template. To indicate template, you have to use \Webmunkeez\ADRBundle\Attribute\Template:

This responder is active if the request contains HTTP_ACCEPT text/html header (warning: a twig template is needed for this responder, otherwise it will throw an \Webmunkeez\ADRBundle\Exception\RenderingException exception).
It has a priority: -20.

JsonResponder

\Webmunkeez\ADRBundle\Response\JsonResponder that uses Serializer for render json (you can indicate serialization context with \Webmunkeez\ADRBundle\Attribute\SerializationContext):

This responder is active if the request contains HTTP_ACCEPT application/json header.
It has a priority: -10.

Custom responders

You can write your own reponders like in my previous XmlResponder example, by implementing \Webmunkeez\ADRBundle\Response\ResponderInterface.

Services implementing this interface are automatically tagged webmunkeez_adr.responder with priority: 0, and you can change it (in your service.yaml or by static getDefaultPriority method ; see https://symfony.com/doc/current/service_container/tags.html#tagged-services-with-priority).

You can define "generic" responders like html, json, xml and so on. But you can also define more specifics, by checking $request->attributes->get('_controller') to make a responder only for a specific action:

Render Exception Listener

If there is an uncaught \Webmunkeez\ADRBundle\Exception\RenderingException, it will be catch by this listener which will throw an \Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException that will embed the original exception.

Exception Listener

If there is an uncaught \Throwable, it will be catch by this listener which will throw an \Symfony\Component\HttpKernel\Exception\BadRequestHttpException that will embed the original exception.

Http Exception Listener

If you request an Action with HTTP_ACCEPT application/json header and if this Action throws an Exception that implements \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface, its content will automatically be serialized in a JSON reading format to the Response body content.