Skip to content

Document controller file() helper #6732

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

Document controller file() helper #6732

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42d647d
Added docs for file helper
dfridrich Apr 10, 2016
643c0d4
Tweak section to remove some text
wouterj Jul 8, 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
44 changes: 40 additions & 4 deletions book/controller.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,6 +782,12 @@ There are also special classes to make certain kinds of responses easier:
:class:`Symfony\\Component\\HttpFoundation\\StreamedResponse`.
See :ref:`streaming-response`.

.. seealso::

Now that you know the basics you can continue your research on Symfony
``Request`` and ``Response`` object in the
:ref:`HttpFoundation component documentation <component-http-foundation-request>`.

JSON Helper
~~~~~~~~~~~

Expand All @@ -806,11 +812,41 @@ If the :doc:`serializer service </cookbook/serializer>` is enabled in your
application, contents passed to ``json()`` are encoded with it. Otherwise,
the :phpfunction:`json_encode` function is used.

.. seealso::
File helper
~~~~~~~~~~~

Now that you know the basics you can continue your research on Symfony
``Request`` and ``Response`` object in the
:ref:`HttpFoundation component documentation <component-http-foundation-request>`.
.. versionadded:: 3.2
The ``file()`` helper was introduced in Symfony 3.2.

You can use :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::file`
to serve a file from inside a controller::

$this->file($file, $fileName = null, $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT);

You can pass an :phpclass:`SplFileInfo` instance (like
:class:`Symfony\\Component\\HttpFoundation\\File`) or the path to a file as
first argument. Using the second and third arguments, you can customize the
send filename and the disposition.

.. code-block:: php

use Symfony\Component\HttpFoundation\File\File;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;

public function fileAction()
{
// load file from the file system
$file = new File('some_file.pdf');

// send the file as attachment to browser
return $this->file($file, 'custom_name.pdf');
}

public function pathFileAction()
{
// serve file from specified path
return $this->file('/path/to/my/picture.jpg');
}

Creating Static Pages
---------------------
Expand Down