aboutcoders / enum-serializer-bundle
A symfony bundle to serialize/deserialize enumerations of type myclabs/php-enum with jms/serializer
Installs: 25 001
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 5
Open Issues: 1
Type:symfony-bundle
Requires
- php: >=7.1.0
- jms/serializer-bundle: ~1.0|~2.0|~3.0
- myclabs/php-enum: ~1.4
- symfony/dependency-injection: ^3.3 || ^4.0 || ^5.0
- symfony/framework-bundle: ^3.0 || ^4.0 || ^5.0
Requires (Dev)
This package is not auto-updated.
Last update: 2024-11-21 11:09:21 UTC
README
A symfony bundle to serialize/deserialize enumerations of type myclabs/php-enum with jms/serializer.
Note: At this point json
is the only supported format.
Installation
Add the AbcEnumSerializerBundle to your composer.json
file:
php composer.phar require aboutcoders/enum-serializer-bundle
Include the bundle in the AppKernel.php class:
# app/AppKernel.php public function registerBundles() { $bundles = array( ... new Abc\Bundle\EnumSerializerBundle\AbcEnumSerializerBundle(), ); }
Usage
Define the enum as defined by myclabs/php-enum:
namespace Acme; use MyCLabs\Enum\Enum; class MyEnum { const VALUE_1; const VALUE_2; }
In order to serialize/deserialize the enumeration you can register the type in app/config.yml
# app/config/config.yml abc_enum_serializer: serializer: types: - Acme\MyEnum
or you can register the enum within the service container and tag it with with the tag abc.enum
services: my_enum: class: Acme\MyEnum tags: - { name: abc.enum }
Note, this service should be declared private and should never be instantiated, since this would lead to an exception. The only purpose of this service is to provide the fully qualified name of the class that needs to be registered as enum type.
Finally you can configure the type in case you use it as a member variable
use JMS\Serializer\Annotation\Type; class MyExample { /** * @Type("Acme\MyEnum") */ private $myEnum; }
or serialize/deserialize it directly referencing the type:
$serializer = $container->get('jms_serializer'); $data = $serializer->serialize($subject, 'json'); $enum = $this->serializer->deserialize($data, MyExample::class, 'json');
ToDo
- Add support for the formats XML and YAML