Clarify how to handle response bodies and add withStringBody docs #4771
Conversation
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
markstory
reviewed
Mar 2, 2017
en/controllers/request-response.rst
Outdated
|
|
||
| .. php:method:: withBody($body) | ||
| To set the response body, use the `withBody()` method, which is provided by the |
Member
There was a problem hiding this comment.
Backticks for inline code need to be doubled up.
ravage84
reviewed
Mar 2, 2017
en/controllers/request-response.rst
Outdated
|
|
||
| .. php:method:: withStringBody($string) | ||
| In most use cases, it is simpler to set a string as the response body:: |
Member
There was a problem hiding this comment.
If it is simpler, why not put it first?
en/controllers/request-response.rst
Outdated
| // Set a string into the body | ||
| $response = $response->withStringBody('My Body'); | ||
|
|
||
| //If you want a json response |
Member
There was a problem hiding this comment.
Nitpicking: Space after double slashes.
Member
Author
There was a problem hiding this comment.
Not nitpicking. Thoroughly 👍
en/controllers/request-response.rst
Outdated
| .. versionadded:: 3.4.3 | ||
| `withStringBody()` was added in 3.4.3 | ||
|
|
||
| You can also stream responses from files using diactoros streams:: |
Member
There was a problem hiding this comment.
Isn't diactoros a name? Using a capital letter "Diactoros", could make it more clear for non English native speakers...
en/controllers/request-response.rst
Outdated
| $stream = new Stream('/path/to/file', 'rb'); | ||
| $response = $response->withBody($stream); | ||
|
|
||
| You can also stream responses from a callback using the ``CallbackStream`` this |
ndm2
reviewed
Mar 2, 2017
en/controllers/request-response.rst
Outdated
|
|
||
| // If you want a json response | ||
| $response = $response->withType('application/json') | ||
| ->withBody(json_encode(['Foo' => 'bar'])); |
Contributor
There was a problem hiding this comment.
Should be withStringBody I guess...
markstory
reviewed
Mar 3, 2017
en/controllers/request-response.rst
Outdated
| ->withStringBody(json_encode(['Foo' => 'bar'])); | ||
|
|
||
| .. versionadded:: 3.4.3 | ||
| `withStringBody()` was added in 3.4.3 |
Member
There was a problem hiding this comment.
Another place backticks need to be doubled.
en/controllers/request-response.rst
Outdated
| // Prior to 3.4.0 - Set the body | ||
| $this->response->body('My Body'); | ||
|
|
||
| Be sure that `$stream` is a :php:class:`Psr\\Http\\Message\\StreamInterface` object. |
okinaka
added a commit
to okinaka/docs
that referenced
this pull request
Mar 4, 2017
okinaka
added a commit
to okinaka/docs
that referenced
this pull request
Mar 4, 2017
HavokInspiration
added a commit
that referenced
this pull request
Jun 15, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
I tried to clarify the use of
withBody().I also fixed some mistakes and restructured the response section a bit.