feat: add PHP JsonSerializable Preset #1491
Conversation
In PHP objects (and also arrays and scalars) can be serialized to JSON using the function `json_encode()`. In order to maintain the correct property names and values for Enums, normalization of values needs to be implemented manually using the `JsonSerializable` interface. The serialization to JSON can be enabled by using the optional preset `PHP_JSON_SERIALIZABLE_PRESET`. This way of serializing PHP objects does not require any user land package and works out of the box with each PHP version. It is also compatible with different serialization frameworks, like Symfony.
markuspoerschke
requested review from
Ferror,
magicmatatjahu,
jonaslagoni,
kennethaasan and
asyncapi-bot-eve
as code owners
✅ Deploy Preview for modelina ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Pull Request Test Coverage Report for Build 5962856642
💛 - Coveralls |
markuspoerschke
changed the title
There was a problem hiding this comment.
@markuspoerschke thanks for taking the time to provide a PR 🙏
I have a few comments ✌️
@Ferror do you have time to do a review? 🤔
Co-authored-by: Jonas Lagoni <[email protected]>
Co-authored-by: Jonas Lagoni <[email protected]>
examples/php-generate-json-serializable-preset/__snapshots__/index.spec.ts.snap
Outdated
Show resolved
Hide resolved
test/generators/php/presets/__snapshots__/JsonSerializablePreset.spec.ts.snap
Show resolved
Hide resolved
* remove import of JsonSerializable * add test for mixed (int and string) enums
Me too. The cool thing is, that Symfony ships with a JsonSerializableNormalizer, which allows using this kind of PHP object also with Symfony serializer. |
* extract serializing properties to own variable to make code more readable. * use ConstrainedDictionaryModel to detect additional properties
|
SonarCloud Quality Gate failed.
|
|
/rtm |
|
🎉 This PR is included in version 1.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
@all-contributors please add @markuspoerschke for code, example, test, docs |
|
I've put up a pull request to add @markuspoerschke! 🎉 |
|
🎉 This PR is included in version 2.0.0-next.25 🎉 The release is available on: Your semantic-release bot 📦🚀 |
In PHP objects (and also arrays and scalars) can be serialized to JSON using the function
json_encode(). In order to maintain the correct property names and values for Enums, normalization of values needs to be implemented manually using theJsonSerializableinterface.The serialization to JSON can be enabled by using the optional preset
PHP_JSON_SERIALIZABLE_PRESET.This way of serializing PHP objects does not require any user land package and works out of the box with each PHP version. It is also compatible with different serialization frameworks, like Symfony.