How can I send json response in symfony2 controller

Question

I use jQuery to edit my form, which is built into Symfony.

I show the form in the jQuery dialog and then submit it.

The data is getting into the database correctly.

But I do not know if I need to send JSON back to jQuery. Actually I am a bit confused about JSON.

Suppose I added a row to a table with jQuery, and when I submit the form after submitting the data, I want to send back the data of this row so that I can dynamically add the row of the table to show the added data.

I am confused how to get data back

This is my current code.

$editForm = $this->createForm(new StepsType(), $entity); $request = $this->getRequest(); $editForm->bindRequest($request); if ($editForm->isValid()) { $em->persist($entity); $em->flush(); return $this->render('::success.html.twig'); } 

This is only a template with a successful message.

Answer 1

Symfony 2.1

 $response = new Response(json_encode(array('name' => $name))); $response->headers->set('Content-Type', 'application/json'); return $response; 

---

Symfony 2.2 and higher

You have a special JsonResponse class that serializes an array in JSON:

 return new JsonResponse(array('name' => $name)); 

---

But if your problem is How to serialize an entity , then you should take a look at the JMSSerializerBundle p>

Assuming you installed it, you just need to do

 $serializedEntity = $this->container->get('serializer')->serialize($entity, 'json'); return new Response($serializedEntity); 

You should also check for similar issues in StackOverflow:

• How to encode Doctrine objects for JSON in a Symfony 2.0 AJAX application?
• Export Symfony 2 Doctrine to JSON

Answer 2

Symfony 2.1 has a JsonResponse class.

 return new JsonResponse(array('name' => $name)); 

The JSON code passed in the array will be encoded, the default status code will be 200, and the content type will be set to application / json.

There is also a convenient setCallback function for JSONP.

Answer 3

With Symfony 3.1 you can use JSON Helper http://symfony.com/doc/current/book/controller.html#json-helper

 public function indexAction() { // returns '{"username":"jane.doe"}' and sets the proper Content-Type header return $this->json(array('username' => 'jane.doe')); // the shortcut defines three optional arguments // return $this->json($data, $status = 200, $headers = array(), $context = array()); } 

Answer 4

To end @thecatontheflat's answer, I would also recommend wrapping your action inside a try ... catch . This will prevent the JSON endpoint from being interrupted for exceptions. The skeleton is used here:

 public function someAction() { try { // Your logic here... return new JsonResponse([ 'success' => true, 'data' => [] // Your data here ]); } catch (\Exception $exception) { return new JsonResponse([ 'success' => false, 'code' => $exception->getCode(), 'message' => $exception->getMessage(), ]); } } 

Thus, your endpoint will behave stably even in the event of errors, and you will be able to process them directly on the client side.

Answer 5

If your data is already serialized:

a) send a JSON response

 public function someAction() { $response = new Response(); $response->setContent(file_get_contents('path/to/file')); $response->headers->set('Content-Type', 'application/json'); return $response; } 

b) send JSONP response (with callback)

 public function someAction() { $response = new Response(); $response->setContent('/**/FUNCTION_CALLBACK_NAME(' . file_get_contents('path/to/file') . ');'); $response->headers->set('Content-Type', 'text/javascript'); return $response; } 

If your data needs to be serialized:

c) send a JSON response

 public function someAction() { $response = new JsonResponse(); $response->setData([some array]); return $response; } 

d) send JSONP response (with callback)

 public function someAction() { $response = new JsonResponse(); $response->setData([some array]); $response->setCallback('FUNCTION_CALLBACK_NAME'); return $response; } 

e) use groups in symfony 3.xx

Creating groups inside your objects

 <?php namespace Mindlahus; use Symfony\Component\Serializer\Annotation\Groups; /** * Some Super Class Name * * @ORM able("table_name") * @ORM\Entity(repositoryClass="SomeSuperClassNameRepository") * @UniqueEntity( * fields={"foo", "boo"}, * ignoreNull=false * ) */ class SomeSuperClassName { /** * @Groups({"group1", "group2"}) */ public $foo; /** * @Groups({"group1"}) */ public $date; /** * @Groups({"group3"}) */ public function getBar() // is* methods are also supported { return $this->bar; } // ... } 

Normalize a Doctrine object inside your application logic

 <?php use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory; // For annotations use Doctrine\Common\Annotations\AnnotationReader; use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader; use Symfony\Component\Serializer\Serializer; use Symfony\Component\Serializer\Normalizer\ObjectNormalizer; use Symfony\Component\Serializer\Encoder\JsonEncoder; ... $repository = $this->getDoctrine()->getRepository('Mindlahus:SomeSuperClassName'); $SomeSuperObject = $repository->findOneById($id); $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader())); $encoder = new JsonEncoder(); $normalizer = new ObjectNormalizer($classMetadataFactory); $callback = function ($dateTime) { return $dateTime instanceof \DateTime ? $dateTime->format('md-Y') : ''; }; $normalizer->setCallbacks(array('date' => $callback)); $serializer = new Serializer(array($normalizer), array($encoder)); $data = $serializer->normalize($SomeSuperObject, null, array('groups' => array('group1'))); $response = new Response(); $response->setContent($serializer->serialize($data, 'json')); $response->headers->set('Content-Type', 'application/json'); return $response;