custom encoders interface signature #11439
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
Fixes the documentation about encoders that was wrong. Using `Symfony\Component\Serializer\Encoder\EncoderInterface` no `$context` parameter is passed to `supportsEncoding` method. YOu have to use the ContextAware version of it.
OskarStark
reviewed
Apr 15, 2019
| .. tip:: | ||
|
|
||
| If you need access to ``$context`` in your ``supportsDecoding`` or ``supportsEncoding`` method, make sure | ||
| to implements ``Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface`` or ``Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface`` interface |
There was a problem hiding this comment.
Suggested change
| to implements ``Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface`` or ``Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface`` interface | |
| to implement ``Symfony\Component\Serializer\Encoder\ContextAwareDecoderInterface`` or ``Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface`` accordingly. |
Why the same interface twice?
and a . (Dot) is missing at the end
There was a problem hiding this comment.
Ah I found out by myself, Decoder and Encoder....
OskarStark
approved these changes
May 24, 2019
|
... and one more bug fixed, thank you Florian and congratulations on your first contribution to the Symfony-Docs 🎉 ❗️ |
OskarStark
added a commit
that referenced
this pull request
May 24, 2019
This PR was merged into the 4.2 branch. Discussion ---------- custom encoders interface signature Fixes the documentation about encoders that was wrong. Using `Symfony\Component\Serializer\Encoder\EncoderInterface` no `$context` parameter is passed to `supportsEncoding` method. You have to use the ContextAware version of it. <!-- If your pull request fixes a BUG, use the oldest maintained branch that contains the bug (see https://symfony.com/roadmap for the list of maintained branches). If your pull request documents a NEW FEATURE, use the same Symfony branch where the feature was introduced (and `master` for features of unreleased versions). --> Commits ------- 754a62b custom encoders interface signature
OskarStark
added a commit
that referenced
this pull request
May 24, 2019
OskarStark
added a commit
that referenced
this pull request
May 24, 2019
* 4.2: Tweaks. refs #11439 custom encoders interface signature
OskarStark
added a commit
that referenced
this pull request
May 24, 2019
* 4.3: Tweaks. refs #11439 custom encoders interface signature
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.
Fixes the documentation about encoders that was wrong.
Using
Symfony\Component\Serializer\Encoder\EncoderInterfaceno$contextparameter is passed tosupportsEncodingmethod. You have to use the ContextAware version of it.