8000 Fixed the @return value of Response::setStatusCode() by javiereguiluz · Pull Request #20290 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content
/ symfony Public

Fixed the @return value of Response::setStatusCode() #20290

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 3 commits into from
Closed

Fixed the @return value of Response::setStatusCode() #20290

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b3d6ef4
Fixed the @return value of Response::setStatusCode()
javiereguiluz Oct 24, 2016
db76a94
Updated more return values to @return $this
javiereguiluz Oct 25, 2016
e416109
Use @return static for static methods
javiereguiluz Oct 25, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
F 8000 ailed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions src/Symfony/Component/HttpFoundation/Response.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ public function __construct($content = '', $status = 200, $headers = array())
* @param int $status The response status code
* @param array $headers An array of response headers
*
* @return Response
* @return $this
Copy link
Contributor
@ro0NL ro0NL Oct 25, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

Not sure this goes for static. Perhaps use @return static in these cases.

edit: it works though :)

Copy link
Contributor

Choose a reason for hiding this comment

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

Should be static indeed (IMHO)

*/
public static function create($content = '', $status = 200, $headers = array())
{
Expand Down Expand Up @@ -262,7 +262,7 @@ public function __clone()
*
* @param Request $request A Request instance
*
* @return Response The current response
* @return $this The current response
*/
public function prepare(Request $request)
{
Expand Down Expand Up @@ -324,7 +324,7 @@ public function prepare(Request $request)
/**
* Sends HTTP headers.
*
* @return Response
* @return $this
*/
public function sendHeaders()
{
Expand Down Expand Up @@ -354,7 +354,7 @@ public function sendHeaders()
/**
* Sends content for the current web response.
*
* @return Response
* @return $this
*/
public function sendContent()
{
Expand All @@ -366,7 +366,7 @@ public function sendContent()
/**
* Sends HTTP headers and content.
*
* @return Response
* @return $this
*/
public function send()
{
Expand All @@ -389,7 +389,7 @@ public function send()
*
* @param mixed $content Content that can be cast to string
*
* @return Response
* @return $this
*
* @throws \UnexpectedValueException
*/
Expand Down Expand Up @@ -419,7 +419,7 @@ public function getContent()
*
* @param string $version The HTTP protocol version
*
* @return Response
* @return $this
*/
public function setProtocolVersion($version)
{
Expand Down Expand Up @@ -447,7 +447,7 @@ public function getProtocolVersion()
* If the status text is null it will be automatically populated for the known
* status codes and left empty otherwise.
*
* @return Response
* @return $this
Copy link
Contributor

Choose a reason for hiding this comment

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

I vote for @return self since it's now used in php 7 as returned type hint

Copy link
8000
Member

Choose a reason for hiding this comment

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

What PSR-X tells us about this?

Copy link
Contributor
@HeahDude HeahDude Oct 24, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

For phpdoc see https://www.phpdoc.org/docs/latest/references/phpdoc/types.html, selfis in the list. Same for the php RFC about return type hint, self and parent https://wiki.php.net/rfc/return_types#differences_from_past_rfcs.

Copy link
Member

Choose a reason for hiding this comment

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

I was more thinking about https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md

Copy link
Contributor

Choose a reason for hiding this comment

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

thanks for the link, looks like self is in the Appendix A as well https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#appendix-a-types

Copy link
Contributor
@ro0NL ro0NL Oct 24, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

$this is allowed

https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#appendix-a-types

> keyword = "resource" / "self" / "static" / "string" / "true" / "void" / "$this"

Didnt read well @HeahDude :)

For PHPStorm $this gives way better DX so it seems (opposed to self).

Copy link
Contributor

Choose a reason for hiding this comment

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

For PHPStorm $this gives way better DX so it seems (opposed to self).

How that? We use self in many projects for some time now and it works pretty well.

8000
Copy link
Contributor
@ro0NL ro0NL Oct 24, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

image

Changing FormConfigBuilderInterface::addEventListener from @return self to @return $this (or @return static)

image

Copy link
Contributor

Choose a reason for hiding this comment

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

😭

Copy link
Contributor
@ogizanagi ogizanagi Oct 24, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

I personally use static everytime (because it behaves like late static binding), but according to PSR-5 Keywords section, 14-15:

static, the element to which this type applies is of the same class as which the documented element is contained, or when encountered in a subclass is of type of that subclass instead of the original class.

This keyword behaves the same way as the keyword for late static binding (not the static method, property, nor variable modifier) as defined by PHP.

$this, the element to which this type applies is the same exact instance as the current class in the given context. As such this type is a stricter version of static as, in addition, the returned instance must not only be of the same class but also the same instance.

$this seems the most appropriate. 👍

self isn't because:

the element to which this type applies is of the same class as which the documented element is originally contained

which means:

it may lead to confusing situations when inheritance is involved
*
* @throws \InvalidArgumentException When the HTTP status code is not valid
*/
Expand Down Expand Up @@ -490,7 +490,7 @@ public function getStatusCode()
*
* @param string $charset Character set
*
* @return Response
* @return $this
*/
public function setCharset($charset)
{
Expand Down Expand Up @@ -563,7 +563,7 @@ public function isValidateable()
*
* It makes the response ineligible for serving other clients.
*
* @return Response
* @return $this
*/
public function setPrivate()
{
Expand All @@ -578,7 +578,7 @@ public function setPrivate()
*
* It makes the response eligible for serving other clients.
*
* @return Response
* @return $this
*/
public function setPublic()
{
Expand Down Expand Up @@ -620,7 +620,7 @@ public function getDate()
*
* @param \DateTime $date A \DateTime instance
*
* @return Response
* @return $this
*/
public function setDate(\DateTime $date)
{
Expand All @@ -647,7 +647,7 @@ public function getAge()
/**
* Marks the response stale by setting the Age header to be equal to the maximum age of the response.
*
* @return Response
* @return $this
*/
public function expire()
{
Expand Down Expand Up @@ -680,7 +680,7 @@ public function getExpires()
*
* @param \DateTime|null $date A \DateTime instance or null to remove the header
*
* @return Response
* @return $this
*/
public function setExpires(\DateTime $date = null)
{
Expand Down Expand Up @@ -726,7 +726,7 @@ public function getMaxAge()
*
* @param int $value Number of seconds
*
* @return Response
* @return $this
*/
public function setMaxAge($value)
{
Expand All @@ -742,7 +742,7 @@ public function setMaxAge($value)
*
* @param int $value Number of seconds
*
* @return Response
* @return $this
*/
public function setSharedMaxAge($value)
{
Expand Down Expand Up @@ -776,7 +776,7 @@ public function getTtl()
*
* @param int $seconds Number of seconds
*
* @return Response
* @return $this
*/
public function setTtl($seconds)
{
Expand All @@ -792,7 +792,7 @@ public function setTtl($seconds)
*
* @param int $seconds Number of seconds
*
* @return Response
* @return $this
*/
public function setClientTtl($seconds)
{
Expand Down Expand Up @@ -820,7 +820,7 @@ public function getLastModified()
*
* @param \DateTime|null $date A \DateTime instance or null to remove the header
*
* @return Response
* @return $this
*/
public function setLastModified(\DateTime $date = null)
{
Expand Down Expand Up @@ -851,7 +851,7 @@ public function getEtag()
* @param string|null $etag The ETag unique identifier or null to remove the header
* @param bool $weak Whether you want a weak ETag or not
*
* @return Response
* @return $this
*/
public function setEtag($etag = null, $weak = false)
{
Expand All @@ -875,7 +875,7 @@ public function setEtag($etag = null, $weak = false)
*
* @param array $options An array of cache options
*
* @return Response
* @return $this
*
* @throws \InvalidArgumentException
*/
Expand Down Expand Up @@ -926,7 +926,7 @@ public function setCache(array $options)
* This sets the status, removes the body, and discards any headers
* that MUST NOT be included in 304 responses.
*
* @return Response
* @return $this
*
* @see http://tools.ietf.org/html/rfc2616#section-10.3.5
*/
Expand Down Expand Up @@ -978,7 +978,7 @@ public function getVary()
* @param string|array $headers
* @param bool $replace Whether to replace the actual value or not (true by default)
*
* @return Response
* @return $this
*/
public function setVary($headers, $replace = true)
{
Expand Down
0