Added example for extra key in ApiListener Action#657
Open
gringlas wants to merge 3 commits into
Open
Conversation
I thought the documentation could get a bit improved here with an example of how exactly add an extra key to response, as up for today I never really figured it out and even then it took me some trying ;)
ADmad
reviewed
Jan 28, 2021
| .. code-block:: php | ||
|
|
||
| <?php | ||
| class MyAction extends BaseAction |
Member
There was a problem hiding this comment.
Instead of an example using a custom action class, an example which uses $this->Crud->action()->setConfig() would be more suitable.
Contributor
Author
There was a problem hiding this comment.
You mean like, so?
class SomeController extends AppController {
public function initialize() {
$this->Crud->setConfig([
'serialize' => [
'my_extra_data'
],
'api' => [
'success' => [
'data' => [
'entity' => [],
'my_extra_data'
]
]
]
]);
}
Member
There was a problem hiding this comment.
Yes, though you missed the ->action() in the call chain and it should be done in beforeFilter() or controller's action method.
There was a problem hiding this comment.
Personnaly, I'm using it like this :
$this->set(compact('aggregation'));
$this->Crud->action()->setConfig('serialize.aggregation', 'aggregation');
I've update the code example to searilize variable in beforeFilter ans also added the method of doing that in a controller action, thanks to @irongomme.
Contributor
Author
|
Why did those checks fail? |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 thought the documentation could get a bit improved here with an example of how exactly add an extra key to response, as up for today I never really figured it out and even then it took me some trying ;)