Symfony Controller - How to return XML response?

Question

I want to return in my RandomController::indexAction() an XML Response:

return new Response($this->renderView(
    'AcmeRandomBundle:Random:index.xml.twig',
    array(
        'randomParameter' => $randomParameter
    )
));

where index.xml.twig is like that:

<?xml version="1.0" encoding="UTF-8"?>
<randomTag>
    {{ randomParameter }}
</randomTag>

When I want to open this action in firefox, I get in firebug:

<html>
   <body>
    <randomTag>
        randomValue
    </randomTag>
   </body>
</html>

How to return correct XML response?

this is totally randomly randomed random string, for example $randomParameter = "randomParameter" :P I think it is not matter in this case ;) — user3766478
– user3766478, Commented Oct 9, 2014 at 7:57
But I don't understand why randomParameter remained untranslated by Twig. It should work even the response was not XML but HTML. — COil
– COil, Commented Oct 9, 2014 at 20:00
It works. Really. Just Value and Variable Name are the same ;) — user3766478
– user3766478, Commented Oct 10, 2014 at 6:21
I made edit special for you. Now, value and variable are different. — user3766478
– user3766478, Commented Oct 10, 2014 at 6:24

Matteo · Accepted Answer · 2019-04-10 19:16:54Z

53

Try adding correct header on the Response Object like:

$response->headers->set('Content-Type', 'text/xml');

Otherwise add the correct annotation (defaults) on your Controller method like this example:

 /**
  * @Route("/hello/{name}", defaults={"_format"="xml"}, name="_demo_hello")
  * @Template()
  */
  public function helloAction($name)
  {
     return array('name' => $name);
  }

Look at the guide for further explaination

edited Apr 10, 2019 at 19:16

answered Oct 8, 2014 at 9:19

Matteo

39.8k11 gold badges110 silver badges129 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Matteo Over a year ago

Hi @user3766478 please consider to upvote my answer if you find it useful

Scott Flack Over a year ago

I never new about the _format property of defaults - I'd always had to do away with annotating the template before because I needed to use the response object. Thanks for pointing it out!

Herr Nentu' Over a year ago

@vladkras if you use annotations xml is enough.

Krzysztof Raciniewski · Accepted Answer · 2020-10-11 19:32:22Z

11

If you have many XmlResponse to return, consider creating your own Response object:

<?php

namespace App\Component\HttpFoundation;

use Symfony\Component\HttpFoundation\Response;

class XmlResponse extends Response
{
    public function __construct(?string $content = '', int $status = 200, array $headers = [])
    {
        parent::__construct($content, $status, array_merge($headers, [
            'Content-Type' => 'text/xml',
        ]));
    }
}

You can then return new XmlResponse($xmlBody); in your controllers.

edited Oct 11, 2020 at 19:32

Krzysztof Raciniewski

5,0043 gold badges23 silver badges44 bronze badges

answered Apr 8, 2020 at 9:56

Alain

37.1k18 gold badges128 silver badges160 bronze badges

1 Comment

Krzysztof Raciniewski Over a year ago

IMHO best solution - clean, transparent and no code repetitions

Collectives™ on Stack Overflow

Symfony Controller - How to return XML response?

2 Answers 2

3 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related