-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[Serializer] add documentation for serializer callbacks #3701
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
cordoval
wants to merge
3
commits into
symfony:master
from
cordoval:3701-serializer-add-documentation-for-serializer-callbacks
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -181,6 +181,37 @@ method on the normalizer definition:: | |
As a final result, the deserializer uses the ``first_name`` attribute as if | ||
it were ``firstName`` and uses the ``getFirstName`` and ``setFirstName`` methods. | ||
|
||
Using Callbacks to Serialize Properties with Object Instances | ||
------------------------------------------------------------- | ||
|
||
When serializing, you can set a callback to format a specific object property:: | ||
|
||
use Acme\Person; | ||
use Symfony\Component\Serializer\Encoder\JsonEncoder; | ||
use Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer; | ||
use Symfony\Component\Serializer\Serializer; | ||
|
||
$encoder = new JsonEncoder(); | ||
$normalizer = new GetSetMethodNormalizer(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. missing use statements |
||
|
||
$callback = function ($dateTime) { | ||
return $dateTime instanceof \DateTime | ||
? $dateTime->format(\DateTime::ISO8601) | ||
: ''; | ||
} | ||
|
||
$normalizer->setCallbacks(array('createdAt' => $callback)); | ||
|
||
$serializer = new Serializer(array($normalizer), array($encoder)); | ||
|
||
$person = new Person(); | ||
$person->setName('cordoval'); | ||
$person->setAge(34); | ||
$person->setCreatedAt(new \DateTime('now')); | ||
|
||
$serializer->serialize($person, 'json'); | ||
// Output: {"name":"cordoval", "age": 34, "createdAt": "2014-03-22T09:43:12-0500"} | ||
|
||
JMSSerializer | ||
------------- | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing
code-block
directive