bu/json-response-bundle

Symfony2 bundle allows to use templates for json responses

1.0.1 2014-10-17 18:36 UTC

Requires

• php: >=5.3.2
• sensio/framework-extra-bundle: 2.3.*
• symfony/framework-bundle: >=2.1,<2.4-dev

MIT

• Fludimir

• json
• template
• bundle

README

BuJsonResponseBundle helps you to use templates for json responses in just same way as templates are used for html responses, allowing you to separate business logic and data presentation when you need to return data in json format.

Based on @Template annotation from SensioFrameworkExtraBundle and requires it.

Installation

Add bundle with composer:

composer require bu/json-response-bundle dev-master

Enable php templating engine in your symfony config:

# app/config/config.yml
framework:
    # ...
    templating:
        engines: ['twig', 'php']

register bundle in AppKernel.php :

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Bu\JsonResponseBundle\BuJsonResponseBundle(),
    );
}

Usage

Example controller:

<?php

namespace Application\MyBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Bu\JsonResponseBundle\Configuration\JsonResponseTemplate;


class ProductController extends Controller
{
    /**
     * @JsonResponseTemplate
     */
    public function listAction()
    {
        return array('products' => $this->get('my.product.service')->getAllProducts());
    }
}

Json template for listAction:

<?php
// Resources/view/Product/list.json.php

$data = array();
foreach ($products as $product) {
    $data[$product->getStatus()][] = array(
        'name'              => $product->getName(),
        'description'       => $product->getDescription(),
        'relationsCount'    => count($product->getRelations()),
        'isRequiresCheck'   => $product->isRequiresCheck(),
    );
}

$view['jsonResponse']->output($data);

Also there is simple JsonResponse class that can be used if you already have data prepared:

use Bu\JsonResponseBundle\HttpFoundation\JsonResponse;

    public function deleteAction(Product $product)
    {
        $this->get('my.product.service')->delete($product);

        return new JsonResponse(array('success' => true));
    }

As of Symfony 2.7 there is similar internal class Symfony\Component\HttpFoundation\JsonResponse https://symfony.com/doc/2.7/components/http_foundation.html#creating-a-json-response

License

This bundle is under the MIT license.