https://github.com/consistence/consistence-jms-serializer
Integration of Consistence library with JMS Serializer
https://github.com/consistence/consistence-jms-serializer
Last synced: 8 months ago
JSON representation
Integration of Consistence library with JMS Serializer
- Host: GitHub
- URL: https://github.com/consistence/consistence-jms-serializer
- Owner: consistence
- License: other
- Created: 2017-01-17T11:39:15.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T12:50:02.000Z (over 1 year ago)
- Last Synced: 2024-12-12T16:24:11.736Z (over 1 year ago)
- Language: PHP
- Size: 86.9 KB
- Stars: 4
- Watchers: 3
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
Integration of Consistence library with JMS Serializer
======================================================
This library provides integration of [Consistence](https://github.com/consistence/consistence) value objects for [JMS Serializer](http://jmsyst.com/libs/serializer) so that you can use them in your serialization mappings.
For now, the only integration which is needed is for [Enums](https://github.com/consistence/consistence/blob/master/docs/Enum/enums.md), see the examples below.
Usage
-----
[Enums](https://github.com/consistence/consistence/blob/master/docs/Enum/enums.md) represent predefined set of values and of course, you will want to serialize and deserialize these values as well. Since [`Enums`](https://github.com/consistence/consistence/blob/master/src/Enum/Enum.php) are objects and you only want to (de)serialize represented value, there has to be some mapping.
You can see it in this example where you want to (de)serialize sex for your `User`s:
```php
`:
```php
")
* @var \Consistence\JmsSerializer\Example\User\Sex|null
*/
private $sex;
// ...
public function __construct(
// ...
Sex $sex = null
// ...
)
{
// ...
$this->sex = $sex;
// ...
}
}
```
Now everything is ready to be used, when you serialize the object, only `female` will be returned as the value representing the enum:
```php
serialize($user, 'json'));
/*
{
"sex": "female"
}
*/
```
And when you deserialize the object, you will receive the `Sex` enum object again:
```php
deserialize('{
"sex": "female"
}', User::class, 'json'));
/*
class Consistence\JmsSerializer\Example\User\User#46 (1) {
private $sex =>
class Consistence\JmsSerializer\Example\User\Sex#5 (1) {
private $value =>
string(6) "female"
}
}
*/
```
This means that the objects API is symmetrical (you get the same type as you set) and you can start benefiting from Enums advantages such as being sure, that what you get is already a valid value and having the possibility to define methods on top of the represented values.
### Nullable by default
Both serialization and deserialization will accept `null` values, there is no special mapping for that (by `Jms Serializer`s convention), so if you are expecting a non-null value you have to enforce this by other means - either by restricting this in the API of your objects or by validation (needed especially for deserialization).
### Invalid values
While serializing, there should be no invalid values, because [Enums](https://github.com/consistence/consistence/blob/master/docs/Enum/enums.md) guarantee that the instance contains only valid values.
While deserializing, there can be an invalid value given, an exception will be thrown:
```php
deserialize('{
"sex": "FOO"
}', User::class, 'json'));
// \Consistence\Enum\InvalidEnumValueException: FOO [string] is not a valid value, accepted values: female, male
```
If you are using this in an API, make sure you will catch this exception and send the consumer a response detailing this error, you can also write a custom message, the available values are listed in `InvalidEnumValueException::getAvailableValues()`.
### XML support
Unlike in JSON, in XML value types cannot be inferred directly from the values. So if you need to deserialize XML, you have to provide this type manually. You can do this by writing the type in the type definition - for the above example it would be `string`:
```php
")
* @var \Consistence\JmsSerializer\Example\User\Sex|null
*/
private $sex;
// ...
}
```
### Special support for mapped MultiEnums
Since the (de)serialization works only with the value the enum is representing, then in case of [MultiEnums](https://github.com/consistence/consistence/blob/master/docs/Enum/multi-enums.md) this would mean outputting the value of the internal bit mask. This could be useful if both the client and server use the same Enum objects, but otherwise this breaks the abstraction and is less readable for a human consumer as well.
If you are using a [MultiEum mapped to a single Enum](https://github.com/consistence/consistence/blob/master/docs/Enum/multi-enums.md#mapping-a-multienum-to-a-single-enum) there is a handy solution provided, if you add to your mapping `enum` - notice the new `as_single` parameter, then the value of `MultiEnum` will be serialized as a collection of single `Enum` values:
```php
MultiEnum value (int) */
private static $singleMultiMap = [
RoleEnum::USER => 1,
RoleEnum::EMPLOYEE => 2,
RoleEnum::ADMIN => 4,
];
public static function getSingleEnumClass(): string
{
return RoleEnum::class;
}
/**
* Converts value representing a value from single Enum to MultiEnum counterpart
*
* @param string $singleEnumValue
* @return int
*/
protected static function convertSingleEnumValueToValue($singleEnumValue): int
{
return ArrayType::getValue(self::$singleMultiMap, $singleEnumValue);
}
/**
* Converts value representing a value from MultiEnum to single Enum counterpart
*
* @param int $value
* @return string
*/
protected static function convertValueToSingleEnumValue(int $value): string
{
return ArrayType::getKey(self::$singleMultiMap, $value);
}
}
class User extends \Consistence\ObjectPrototype
{
// ...
/**
* @JMS\Type("enum")
* @var \Consistence\JmsSerializer\Example\User\RolesEnum
*/
private $roles;
// ...
public function __construct(
// ...
RolesEnum $roles
// ...
)
{
// ...
$this->roles = $roles;
// ...
}
}
$user = new User(RolesEnum::getMultiByEnums([
RoleEnum::get(RoleEnum::USER),
RoleEnum::get(RoleEnum::ADMIN),
]));
/** @var \JMS\Serializer\Serializer $serializer */
var_dump($serializer->serialize($user, 'json'));
/*
{
"roles": [
"user",
"admin"
]
}
*/
```
Deserialization then again works symmetrically - giving an array of single `Enum` values will produce a `MultiEnum` instance:
```php
deserialize('{
"roles": [
"user",
"admin"
]
}', User::class, 'json'));
/*
class Consistence\JmsSerializer\Example\User\User#48 (1) {
private $roles =>
class Consistence\JmsSerializer\Example\User\RolesEnum#37 (1) {
private $value =>
int(5)
}
}
*/
```
Installation
------------
> If you are using Symfony, you can use [`consistence/consistence-jms-serializer-symfony`](https://github.com/consistence/consistence-jms-serializer-symfony), which will take care of the integration.
1) Install package [`consistence/consistence-jms-serializer`](https://packagist.org/packages/consistence/consistence-jms-serializer) with [Composer](https://getcomposer.org/):
```bash
composer require consistence/consistence-jms-serializer
```
2) Register [serialization handler](http://jmsyst.com/libs/serializer/master/handlers#subscribing-handlers):
```php
configureHandlers(function (HandlerRegistry $registry) {
$registry->registerSubscribingHandler(new EnumSerializerHandler());
})
->build();
```
That's all, you are good to go!