This repository was archived by the owner on Nov 19, 2024. It is now read-only.
magento/devdocs#: Routing. Action result object. #4541
Merged
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
magento-engcom-team
added
Partner: Atwix
partners-contribution
|
An admin must run tests on this PR before it can be merged. |
Merge remote-tracking branch 'upstream/master' into routing-result-object # Conflicts: # guides/v2.1/extension-dev-guide/routing.md # guides/v2.3/extension-dev-guide/routing.md
jeff-matthews
added
2.1.x
2.2.x
2.3.x
ronak2ram
approved these changes
May 17, 2019
erikmarr
reviewed
May 20, 2019
There was a problem hiding this comment.
@atwixfirster this looks really good. I only have some minor editorial feedback.
|
|
||
| Name | Description | ||
| --- | --- | ||
| `json` | Sets `Content-Type:application/json` in the header and returns a json encoded representation of an array with data. |
| Name | Description | ||
| --- | --- | ||
| `json` | Sets `Content-Type:application/json` in the header and returns a json encoded representation of an array with data. | ||
| `raw` | Returns the data as it's been set. Does not set a `Content-Type` of the header. |
There was a problem hiding this comment.
Suggested change
| `raw` | Returns the data as it's been set. Does not set a `Content-Type` of the header. | |
| `raw` | Returns the data as it's been set. Does not set a `Content-Type` in the header. |
Also, remove period from end of last sentence.
| --- | --- | ||
| `json` | Sets `Content-Type:application/json` in the header and returns a json encoded representation of an array with data. | ||
| `raw` | Returns the data as it's been set. Does not set a `Content-Type` of the header. | ||
| `redirect` | Creates an external redirect, which the browser follows and requests a new url. |
There was a problem hiding this comment.
remove period from end of sentence
| `json` | Sets `Content-Type:application/json` in the header and returns a json encoded representation of an array with data. | ||
| `raw` | Returns the data as it's been set. Does not set a `Content-Type` of the header. | ||
| `redirect` | Creates an external redirect, which the browser follows and requests a new url. | ||
| `forward` | Internally calls the execute method of another action class and does not trigger a new request from the browser. The URL stays the same. |
There was a problem hiding this comment.
Remove period from end of last sentence.
| `raw` | Returns the data as it's been set. Does not set a `Content-Type` of the header. | ||
| `redirect` | Creates an external redirect, which the browser follows and requests a new url. | ||
| `forward` | Internally calls the execute method of another action class and does not trigger a new request from the browser. The URL stays the same. | ||
| `layout` | View result. A generic layout response can be used for rendering any kind of layout. So it comprises a response body from the layout elements it has and sets it to the HTTP response |
There was a problem hiding this comment.
Suggested change
| `layout` | View result. A generic layout response can be used for rendering any kind of layout. So it comprises a response body from the layout elements it has and sets it to the HTTP response | |
| `layout` | View result. You can use a generic layout response to render any kind of layout. The layout comprises a response body from its layout elements and sets it to the HTTP response |
| Name | Description | ||
| --- | --- | ||
| `json` | Sets `Content-Type:application/json` in the header and returns a json encoded representation of an array with data. | ||
| `raw` | Returns the data as it's been set. Does not set a `Content-Type` of the header! |
There was a problem hiding this comment.
Remove ending exclamation mark
There was a problem hiding this comment.
| {: .bs-callout .bs-callout-info } | ||
| Action class should return a `result object`. | ||
|
|
||
| ## Result object |
There was a problem hiding this comment.
Please apply above edits to this table as well except where noted below.
| `redirect` | Creates an external redirect, which the browser follows and requests a new url. | ||
| `forward` | Internally calls the execute method of another action class and does not trigger a new request from the browser. The URL stays the same. | ||
| `layout` | View result. A generic layout response can be used for rendering any kind of layout. So it comprises a response body from the layout elements it has and sets it to the HTTP response | ||
| `page` | View result. Encapsulates page type, page configuration and imposes certain layout handles. Triggers `layout.xml` rendering into HTML. |
There was a problem hiding this comment.
Suggested change
| `page` | View result. Encapsulates page type, page configuration and imposes certain layout handles. Triggers `layout.xml` rendering into HTML. | |
| `page` | View result. Encapsulates page type, page configuration, and imposes certain layout handles. `page` triggers `layout.xml` to render into HTML |
|
running tests |
|
Hi @atwixfirster, thank you for your contribution! |
|
Thanks @atwixfirster! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Purpose of this pull request
This pull request (PR) adds information about action result objects.
Affected DevDocs pages
Links to Magento source code
Thank you!
whatsnew
Added reference documentation about the
result objectreturned by theActionclass