Add documentation about SerializerAwareDataProviderInterface #336
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
soyuka
reviewed
Nov 9, 2017
core/data-providers.md
Outdated
| ## Inject Serializer in a ItemDataProvider | ||
|
|
||
| In some case, you may need to inject the Serializer in your DataProvider. For CollectionDataProvider, you can inject it | ||
| easily without risk, but for ItemDataProvider you will experience a CircularReferenceException. |
There was a problem hiding this comment.
In some cases, you may need to inject the Serializer in your DataProvider. There are no issues with the CollectionDataProvider, but when injecting it in the ItemDataProvider it will throw a CircularReferenceException.
soyuka
reviewed
Nov 9, 2017
core/data-providers.md
Outdated
| In some case, you may need to inject the Serializer in your DataProvider. For CollectionDataProvider, you can inject it | ||
| easily without risk, but for ItemDataProvider you will experience a CircularReferenceException. | ||
|
|
||
| That's why we implemented the SerializerAwareDataProviderInterface to help you inject the Serializer dependency: |
There was a problem hiding this comment.
For this reason, we implemented the SerializerAwareDataProviderInterface:
soyuka
reviewed
Nov 9, 2017
core/data-providers.md
Outdated
| // Deserialize data using Serializer | ||
| return $this->getSerializer()->deserialize($data, BlogPost::class, 'custom'); | ||
| } | ||
| } |
There was a problem hiding this comment.
I love this stuff. Nice improvement!
soyuka
approved these changes
Nov 9, 2017
dunglas
requested changes
Nov 9, 2017
core/data-providers.md
Outdated
| @@ -125,6 +125,46 @@ services: | |||
| tags: [ 'api_platform.item_data_provider' ] | |||
| ``` | |||
|
|
|||
| ## Inject Serializer in a ItemDataProvider | |||
There was a problem hiding this comment.
# Injecting the Serializer in an `ItemDataProvider`
core/data-providers.md
Outdated
| @@ -125,6 +125,46 @@ services: | |||
| tags: [ 'api_platform.item_data_provider' ] | |||
| ``` | |||
|
|
|||
| ## Inject Serializer in a ItemDataProvider | |||
|
|
|||
| In some cases, you may need to inject the Serializer in your DataProvider. There are no issues with the | |||
There was a problem hiding this comment.
Can you add backticks aroung class and exception names (everywhere)?
core/data-providers.md
Outdated
|
|
||
| ```php | ||
| <?php | ||
|
|
core/data-providers.md
Outdated
| // Retrieve data from anywhere you want, in a custom format | ||
| $data = '...'; | ||
|
|
||
| // Deserialize data using Serializer |
|
Can you also update the TOC please? |
|
Thanks @vincentchalamon! |
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.
Related to api-platform/core#1184