diogo
/
symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor #27402 [HttpFoundation] Change PHPDoc in ResponseHeaderBag::getCookies() to help IDEs (dborsatto) 

This PR was merged into the 2.8 branch.

Discussion
----------

[HttpFoundation] Change PHPDoc in ResponseHeaderBag::getCookies() to help IDEs

| Q             | A
| ------------- | ---
| Branch?       | master <!-- see below -->
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | none
| License       | MIT
| Doc PR        | none

Hello,

I'm proposing a very small change to `ResponseHeaderBag` in the HttpFoundation component. The change involves changing the PHPDoc return type of `getCookies()` from a simple `array` to `Cookie[]`. This way, IDEs will play nicely and understand that the returned value is in fact an array of Cookie objects. This is the current behavior:

![Before PR](https://user-images.githubusercontent.com/94651/40648899-d6690f84-632f-11e8-8e43-e09d71b9ccec.png)

whereas with the proposed change, the IDE correctly understands the type:

![After PR](https://user-images.githubusercontent.com/94651/40648980-109621c4-6330-11e8-8ead-f176307e5bda.png)

Commits
-------

479aa9074b Change PHPDoc in ResponseHeaderBag::getCookies() to help IDEs
This commit is contained in:
Fabien Potencier 2018-05-29 13:31:42 +02:00
parent 518ec864e9 479aa9074b
commit 785b4319ad
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Symfony/Component/HttpFoundation/ResponseHeaderBag.php
View File

@ -160,7 +160,7 @@ class ResponseHeaderBag extends HeaderBag
*
* @param string $format
*
* @return array
* @return Cookie[]
*
* @throws \InvalidArgumentException When the $format is invalid
*/