minor #9293 [HttpFoundation] Docblock fix (jakzal)
This PR was merged into the 2.3 branch.
Discussion
----------
[HttpFoundation] Docblock fix
| Q | A
| ------------- | ---
| Bug fix? | yes
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets | -
| License | MIT
| Doc PR | -
`BinaryFileResponse::create()` has a different signature than `Response::create()` and cannot inherit its doc. I also fixed indentation in other blocks in this file.
Commits
-------
bb8930c
Replaced the @inheritdoc with an actual list of params since the original method has a different signature.
This commit is contained in:
commit
9ed5608abe
@ -35,12 +35,12 @@ class BinaryFileResponse extends Response
|
|||||||
* Constructor.
|
* Constructor.
|
||||||
*
|
*
|
||||||
* @param \SplFileInfo|string $file The file to stream
|
* @param \SplFileInfo|string $file The file to stream
|
||||||
* @param integer $status The response status code
|
* @param integer $status The response status code
|
||||||
* @param array $headers An array of response headers
|
* @param array $headers An array of response headers
|
||||||
* @param boolean $public Files are public by default
|
* @param boolean $public Files are public by default
|
||||||
* @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
|
* @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
|
||||||
* @param boolean $autoEtag Whether the ETag header should be automatically set
|
* @param boolean $autoEtag Whether the ETag header should be automatically set
|
||||||
* @param boolean $autoLastModified Whether the Last-Modified header should be automatically set
|
* @param boolean $autoLastModified Whether the Last-Modified header should be automatically set
|
||||||
*/
|
*/
|
||||||
public function __construct($file, $status = 200, $headers = array(), $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
|
public function __construct($file, $status = 200, $headers = array(), $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
|
||||||
{
|
{
|
||||||
@ -54,7 +54,13 @@ class BinaryFileResponse extends Response
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@inheritdoc}
|
* @param \SplFileInfo|string $file The file to stream
|
||||||
|
* @param integer $status The response status code
|
||||||
|
* @param array $headers An array of response headers
|
||||||
|
* @param boolean $public Files are public by default
|
||||||
|
* @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
|
||||||
|
* @param boolean $autoEtag Whether the ETag header should be automatically set
|
||||||
|
* @param boolean $autoLastModified Whether the Last-Modified header should be automatically set
|
||||||
*/
|
*/
|
||||||
public static function create($file = null, $status = 200, $headers = array(), $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
|
public static function create($file = null, $status = 200, $headers = array(), $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
|
||||||
{
|
{
|
||||||
@ -65,9 +71,9 @@ class BinaryFileResponse extends Response
|
|||||||
* Sets the file to stream.
|
* Sets the file to stream.
|
||||||
*
|
*
|
||||||
* @param \SplFileInfo|string $file The file to stream
|
* @param \SplFileInfo|string $file The file to stream
|
||||||
* @param string $contentDisposition
|
* @param string $contentDisposition
|
||||||
* @param Boolean $autoEtag
|
* @param Boolean $autoEtag
|
||||||
* @param Boolean $autoLastModified
|
* @param Boolean $autoLastModified
|
||||||
*
|
*
|
||||||
* @return BinaryFileResponse
|
* @return BinaryFileResponse
|
||||||
*
|
*
|
||||||
|
Reference in New Issue
Block a user