Return a JSON array from a Controller in Symfony

Question

I am trying return a JSON response from a controller in Symfony 2. Form example, in Spring MVC I can get a JSON response with @ResponseBody annotattion. I want get a JSON response, no mtter if it is a JSON Array or a Json Object, then, manipulate it with javascript in the view.

I try the next code:

/**
     * @Route(
     *      "/drop/getCategory/",
     *      name="getCategory"
     * )
     * @Method("GET")
     */
    public function getAllCategoryAction() {
        $categorias = $this->getDoctrine()
                           ->getRepository('AppBundle:Categoria')
                           ->findAll();

        $response = new JsonResponse();
        $response->setData($categorias);

        $response->headers->set('Content-Type', 'application/json');
        return $response;
    }

But I get [{},{}] as Response in the browser. I try with $response = new Response(json_encode($categorias)); too, but I get the same result.

Did you try 'return new JSONResponse($data);'?

Naftali
– Naftali

2015-01-28 11:54:48 +00:00
Commented Jan 28, 2015 at 11:54 — Naftali
– Naftali, Commented Jan 28, 2015 at 11:54
$categorias is an object. but setData expects an array.

Juergen Schulze
– Juergen Schulze

2023-01-24 11:58:04 +00:00
Commented Jan 24, 2023 at 11:58 — Juergen Schulze
– Juergen Schulze, Commented Jan 24, 2023 at 11:58

chalasr · Accepted Answer · 2016-01-03 14:11:12Z

I think the @darkangelo answer need explainations.

The findAll() method return a collection of objects.

$categorias = $this->getDoctrine()
                   ->getRepository('AppBundle:Categoria')
                   ->findAll();

To build your response, you have to add all getters of your entities to your response like :

$arrayCollection = array();

foreach($categorias as $item) {
     $arrayCollection[] = array(
         'id' => $item->getId(),
         // ... Same for each property you want
     );
}

return new JsonResponse($arrayCollection);

Use QueryBuilder allows you to return results as arrays containing all properties :

$em = $this->getDoctrine()->getManager();
$query = $em->createQuery(
    'SELECT c
    FROM AppBundle:Categoria c'
);
$categorias = $query->getArrayResult();

return new JsonResponse($categorias);

The getArrayResult() avoids need of getters.

Roman · Accepted Answer · 2023-01-11 14:06:39Z

20

You need to do this (based on previous answer):

public function getAllCategoryAction() {
    $em = $this->getDoctrine()->getManager();
    $query = $em->createQuery(
        'SELECT c
        FROM AppBundle:Categoria c'
    );
    $categorias = $query->getArrayResult();

    return new JsonResponse($categorias);
}

It works perfect with any Query that Doctrine returns as array.

edited Jan 11, 2023 at 14:06

Roman

2,5592 gold badges31 silver badges53 bronze badges

answered Jan 27, 2015 at 17:43

ramses

5054 silver badges8 bronze badges

1 Comment

chalasr Over a year ago

You can improve your answer by using JsonResponse instead of Response. This will avoid duplicate uses of json_encode and custom headers.

AlexS · Accepted Answer · 2020-05-23 17:15:42Z

6

/**
 * @Route("/api/list", name="list")
 */
public function getList(SerializerInterface $serializer, SomeRepository $repo): JsonResponse
{
    $models = $repo->findAll();
    $data = $serializer->serialize($models, JsonEncoder::FORMAT);
    return new JsonResponse($data, Response::HTTP_OK, [], true);
}

answered May 23, 2020 at 17:15

AlexS

961 silver badge3 bronze badges

1 Comment

bcag2 Over a year ago

as explain at symfony.com/doc/current/serializer.html add use Symfony\Component\Serializer\SerializerInterface;, I should add also use Symfony\Component\HttpFoundation\JsonResponse;

Jan Bodnar · Accepted Answer · 2020-05-05 17:43:16Z

2

Following the best practices, I managed to do it the following way:

public function index(CityRepository $cityRepository,
                      SerializerInterface $serializer): Response

Injecting repository & serializer.

$cities = $cityRepository->findAll();

Retrieving an array of objects.

$data = $serializer->serialize($cities, 'json');

Serializing the data into a JSON string.

return new JsonResponse($data, 200, [], true);

Passing the JSON string to JsonResponse.

answered May 5, 2020 at 17:43

Jan Bodnar

11.8k6 gold badges74 silver badges84 bronze badges

2 Comments

Artur O Over a year ago

I get very ugly object "{\u0022id\u0022:105,\u0022name\u0022:\u00223..." how to fix it ?

Jan Bodnar Over a year ago

@ArturO The serializer in this example returns a JSON string; check that the JsonResponse has the last parameter set to true.

Alexandru Furculita · Accepted Answer · 2015-01-25 22:06:18Z

1

You need to change your code this way:

/**
 * @Route(
 *      "/drop/getCategory/",
 *      name="getCategory"
 * )
 * @Method("GET")
 */
public function getAllCategoryAction() {
    $categorias = $this->getDoctrine()
                       ->getRepository('AppBundle:Categoria')
                       ->findAll();

    $categorias = $this->get('serializer')->serialize($categorias, 'json');

    $response = new Response($categorias);

    $response->headers->set('Content-Type', 'application/json');
    return $response;
}

If the serializer service is not enabled, you have to enable it in app/config/config.yml:

    framework:
        # ...
        serializer:
            enabled: true

For more advanced options for serialization, you can install JMSSerializerBundle

edited Jan 25, 2015 at 22:06

answered Jan 25, 2015 at 21:37

Alexandru Furculita

1,3739 silver badges19 bronze badges

4 Comments

Giancarlo Ventura Granados Over a year ago

I get a 500 error: You have requested a non-existent service "serializer".

Alexandru Furculita Over a year ago

You have to enable first the serializer service. In app/config/config.yml add this: framework: # ... serializer: enabled: true

Giancarlo Ventura Granados Over a year ago

I get the solution: $categorias = $query->getArrayResult(); //$response->headers->set('Content-Type', 'application/json'); //return $response; //return $this->render('AppBundle:Front:test.html.twig', array('otra' => $otra)); return new Response(json_encode($categorias), 200);

Alexandru Furculita Over a year ago

That's a good solution too. Didn't work using the serializer service? I find to be a better practice to use a serializer

Alex · Accepted Answer · 2015-01-26 07:20:52Z

1

Looks like you are trying to put into response a collection. For that you need to setup serializer (or retrieve data as an array).

Look at this doc pages: http://symfony.com/doc/current/components/http_foundation/introduction.html#creating-a-json-response

and

http://symfony.com/doc/current/cookbook/serializer.html.

answered Jan 26, 2015 at 7:20

Alex

1,19311 silver badges22 bronze badges

Comments

Adib Aroui · Accepted Answer · 2015-01-27 14:42:05Z

0

I suggest the following solution:

/**
     * @Route(
     *      "/drop/getCategory/",
     *      name="getCategory"
     * )
     * @Method("GET")
     */
    public function getAllCategoryAction() {
        $em = $this->getDoctrine()->getManager();
        $query = $em->createQuery(
            'SELECT c
            FROM AppBundle:Categoria c'
        );
        $categorias = $query->getArrayResult();


        return new Response(json_encode($categorias), 200);
}

edited Jan 27, 2015 at 14:42

Adib Aroui

5,0656 gold badges45 silver badges96 bronze badges

answered Jan 25, 2015 at 22:30

Giancarlo Ventura Granados

1,1904 gold badges14 silver badges31 bronze badges

1 Comment

Cerad Over a year ago

You should probably use newJsonResponse like you did in your question.

Collectives™ on Stack Overflow

Return a JSON array from a Controller in Symfony

7 Answers 7

Comments

1 Comment

1 Comment

2 Comments

4 Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

7 Answers 7

Comments

1 Comment

1 Comment

2 Comments

4 Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related