Skip to content

Added docs for file helper #6454

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.

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 5 commits into from
Closed
Changes from 4 commits
Commits
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
37 changes: 37 additions & 0 deletions book/controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -778,6 +778,43 @@ There are also special classes to make certain kinds of responses easier:
:class:`Symfony\\Component\\HttpFoundation\\StreamedResponse`.
See :ref:`streaming-response`.

File helper
~~~~~~~~~~~

If you want to serve file use
Copy link
Member

Choose a reason for hiding this comment

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

[...] use the [...]

:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::file`
helper::

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

You can pass:

* Instance of
Copy link
Member

Choose a reason for hiding this comment

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

An instance of [...]

:class:`Symfony\\Component\\HttpFoundation\\File`
in ``$file`` parameter (you can customize ``$fileName`` and ``$disposition``)

* Path to file in ``$file`` parameter

Example usage::

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

// This will send file with original name as attachment to browser
public function fileAction()
{
// Load file from file system
$file = new File('some_file.pdf');

return $this->file($file);
}

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

.. seealso::

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