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

minor #30696 [Contracts] fix phpdoc for http-client (user_data) (gharlan)

Browse Source 
This PR was merged into the 4.3-dev branch.

Discussion
----------

[Contracts] fix phpdoc for http-client (user_data)

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | —
| License       | MIT
| Doc PR        | —

Commits
-------

226dbbc54f [Contracts] fix phpdoc for http-client (user_data)
This commit is contained in:
Fabien Potencier 2019-03-26 07:12:02 +01:00
commit ce37d04771
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Symfony/Contracts/HttpClient/HttpClientInterface.php
View File

@ -39,7 +39,7 @@ interface HttpClientInterface
// the JSON-encoded value and set the "content-type" headers to a JSON-compatible
// value it is they are not defined - typically "application/json"
'user_data' => null, // mixed - any extra data to attach to the request (scalar, callable, object...) that
// MUST be available via $response->getInfo('data') - not used internally
// MUST be available via $response->getInfo('user_data') - not used internally
'max_redirects' => 20, // int - the maximum number of redirects to follow; a value lower or equal to 0 means
// redirects should not be followed; "Authorization" and "Cookie" headers MUST
// NOT follow except for the initial host name

2
src/Symfony/Contracts/HttpClient/ResponseInterface.php
View File

@ -86,7 +86,7 @@ interface ResponseInterface
* - http_method - the HTTP verb of the last request
* - http_code - the last response code or 0 when it is not known yet
* - error - the error message when the transfer was aborted, null otherwise
* - data - the value of the "data" request option, null if not set
* - user_data - the value of the "user_data" request option, null if not set
* - url - the last effective URL of the request
*
* When the "capture_peer_cert_chain" option is true, the "peer_certificate_chain"