-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Closed
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
bb9241c
Added docs for file helper
dfridrich 819b3c5
Update docs for JSON helper
dfridrich 8e60a99
Update docs for file helper
dfridrich f9ff7d1
Remove files from string functionality from file helper
dfridrich 8e7be8a
Fix typos
dfridrich File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::file` | ||
helper:: | ||
|
||
$this->file($file, $fileName = null, $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT); | ||
|
||
You can pass: | ||
|
||
* Instance of | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[...] use the [...]