-
-
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
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. | ||
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. "You can set a callback to format a specific object property when serializing." |
||
|
||
use Symfony\Component\Serializer\Encoder\JsonEncoder; | ||
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 Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer; | ||
use Symfony\Component\Serializer\Serializer; | ||
use Acme\Person; | ||
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. the order of this use cache block should be the other way around. 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. cache block? need some ☕ ? 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. I think so :) I meant use case block 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. actually, I meant "use statements block". I need to stop for today, I think :P |
||
|
||
$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 | ||
------------- | ||
|
||
|
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.
with