Skip to content

Added docs for JSON helper #6453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Added docs for JSON helper #6453

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cda506
Added docs for JSON helper
dfridrich Apr 10, 2016
5ffa35c
Update docs for JSON helper
dfridrich Apr 10, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions book/controller.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -778,6 +778,20 @@ There are also special classes to make certain kinds of responses easier:
:class:`Symfony\\Component\\HttpFoundation\\StreamedResponse`.
See :ref:`streaming-response`.

JSON helper
~~~~~~~~~~~

You can simplify sending JSON response with
:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::json`
helper::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I miss here some information about the argument/arguments expected by this method.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will update PR in a while.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The greatest feature of this shortcut is the usage of the Symfony serializer if available. We surely have to document that imo


public function jsonAction()
{
$data = [1, 2, 3];

return $this->json($data);
}

.. seealso::

Now that you know the basics you can continue your research on Symfony
Expand Down