Skip to content

Latest commit

 

History

History
303 lines (217 loc) · 7.99 KB

readme.md

File metadata and controls

303 lines (217 loc) · 7.99 KB
Raw

Symfony Bundle integrating Consistence library with JMS Serializer

This is a Symfony bundle providing integration for the standalone package consistence/consistence-jms-serializer, if you are not using Symfony, follow instructions there.

This bundle provides integration of Consistence value objects for JMS Serializer so that you can use them in your serialization mappings.

For now, the only integration which is needed is for Enums, see the examples below.

Usage

Enums represent predefined set of values and of course, you will want to serialize and deserialize these values as well. Since Enums 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 Users:

<?php

namespace Consistence\JmsSerializer\Example\User;

class Sex extends \Consistence\Enum\Enum
{

	const FEMALE = 'female';
	const MALE = 'male';

}

Now you can use the Sex enum in your User object. Type for (de)serialization is specified as enum<Your\Enum\Class>:

<?php

namespace Consistence\JmsSerializer\Example\User;

use JMS\Serializer\Annotation as JMS;

class User extends \Consistence\ObjectPrototype
{

	// ...

	/**
	 * @JMS\Type("enum<Consistence\JmsSerializer\Example\User\Sex>")
	 * @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

namespace Consistence\JmsSerializer\Example\User;

/** @var $serializer \JMS\Serializer\Serializer */
$user = new User(Sex::get(Sex::FEMALE));
var_dump($serializer->serialize($user, 'json'));

/*

{
   "sex": "female"
}

*/

And when you deserialize the object, you will receive the Sex enum object again:

<?php

namespace Consistence\JmsSerializer\Example\User;

/** @var $serializer \JMS\Serializer\Serializer */
var_dump($serializer->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 Serializers 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 guarantee that the instance contains only valid values.

While deserializing, there can be an invalid value given, an exception will be thrown:

<?php

namespace Consistence\JmsSerializer\Example\User;

/** @var $serializer \JMS\Serializer\Serializer */
var_dump($serializer->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().

Special support for mapped MultiEnums

Since the (de)serialization works only with the value the enum is representing, then in case of MultiEnums 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 there is a handy solution provided, if you add to your mapping enum<Your\Enum\Class, as_single> - notice the new as_single parameter, then the value of MultiEnum will be serialized as a collection of single Enum values:

<?php

namespace Consistence\JmsSerializer\Example\User;

use Consistence\Type\ArrayType\ArrayType;

use JMS\Serializer\Annotation as JMS;

class RoleEnum extends \Consistence\Enum\Enum
{

	const USER = 'user';
	const EMPLOYEE = 'employee';
	const ADMIN = 'admin';

}

class RolesEnum extends \Consistence\Enum\MultiEnum
{

	/** @var integer[] format: single Enum value (string) => MultiEnum value (integer) */
	private static $singleMultiMap = [
		RoleEnum::USER => 1,
		RoleEnum::EMPLOYEE => 2,
		RoleEnum::ADMIN => 4,
	];

	/**
	 * @return string
	 */
	public static function getSingleEnumClass()
	{
		return RoleEnum::class;
	}

	/**
	 * Converts value representing a value from single Enum to MultiEnum counterpart
	 *
	 * @param string $singleEnumValue
	 * @return integer
	 */
	protected static function convertSingleEnumValueToValue($singleEnumValue)
	{
		return ArrayType::getValue(self::$singleMultiMap, $singleEnumValue);
	}

	/**
	 * Converts value representing a value from MultiEnum to single Enum counterpart
	 *
	 * @param integer $value
	 * @return string
	 */
	protected static function convertValueToSingleEnumValue($value)
	{
		return ArrayType::getKey(self::$singleMultiMap, $value);
	}

}

class User extends \Consistence\ObjectPrototype
{

	// ...

	/**
	 * @JMS\Type("enum<Consistence\JmsSerializer\Example\User\RolesEnum, as_single>")
	 * @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 $serializer \JMS\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

namespace Consistence\JmsSerializer\Example\User;

/** @var $serializer \JMS\Serializer\Serializer */
var_dump($serializer->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

  1. Install package consistence/consistence-jms-serializer-symfony with Composer:
composer require consistence/consistence-jms-serializer-symfony
  1. Register the bundle in your application kernel:
// app/AppKernel.php
public function registerBundles()
{
	return [
		// ...
		new Consistence\JmsSerializer\SymfonyBundle\ConsistenceJmsSerializerBundle(),
	];
}

That's all, you are good to go!