gisostallenberg/response-content-negotiation-bundle

A bundle that allows creating various Response types from a controller, based on content negotiation

2.0.0 2023-08-11 13:04 UTC

Requires

• php: >=7.3
• friendsofsymfony/rest-bundle: ^3.0
• symfony/config: ^6.0
• symfony/contracts: ^3.0
• symfony/dependency-injection: ^6.0
• symfony/event-dispatcher: ^6.0
• symfony/http-foundation: ^6.0
• symfony/http-kernel: ^6.0
• symfony/twig-bundle: ^6.0
• twig/twig: ^3.0
• willdurand/negotiation: ^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.6
• jms/serializer-bundle: ^4.0
• localheinz/composer-normalize: ^2.2
• maglnet/composer-require-checker: ^3.8
• phpstan/phpstan: ^0.12.8
• phpunit/phpunit: ^8.5
• sensiolabs/security-checker: ^6.0
• symfony/browser-kit: ^6.0
• symfony/debug-pack: ^1.0
• symfony/framework-bundle: ^6.0

MIT

• Giso Stallenberg

README

Response Content Negotiation Bundle

A bundle that allows creating various Response types from a controller, based on content negotiation

Installation

composer require gisostallenberg/response-content-negotiation-bundle

Requirements

HTML

To render HTML the bundle requires TwigBundle.

JSON & XML

To output JSON or XML the bundle requires FOS Rest Bundle and JMS Serializer Bundle or Symfony Serializer

Usage

<?php

namespace App\Controller;

use GisoStallenberg\Bundle\ResponseContentNegotiationBundle\Content\ResultData;
use GisoStallenberg\Bundle\ResponseContentNegotiationBundle\Content\ResultInterface;
use GisoStallenberg\Bundle\ResponseContentNegotiationBundle\Content\ResultServiceLocator;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;

class AcmeController
{
    /**
     * @Route("/my-page", methods={"GET"})
     */
    public function resultAction(
        ResultServiceLocator $resultServiceLocator,
        Request $request
    ): ResultInterface {
        return $resultServiceLocator->getResult($request, new ResultData('acme', ['my-data-label' => 'my data']));
    }
}

HTML

This will render acme.html.twig with the Twig context ['my-data-label' => 'my data'].

If you want to render a specific template, you can add this as template argument to the ResultData. For example:

new ResultData('acme', ['my-data-label' => 'my data'], ['template' => '@AcmeBundle/templates/acme.twig.html'])

This will render @AcmeBundle/templates/acme.twig.html with the Twig context ['my-data-label' => 'my data'].

JSON

This will respond with

{
  "my-data-label": "my data"
}

XML

This will respond with

<my-data-label>
    <entry>my data</entry>
<my-data-label>

Serialization

To use serialization groups in the serialization process, you can add the groups option parameter. For example:

new ResultData('acme', ['my-data-label' => 'my data'], ['groups' => ['profile', 'list']])