coosos/jms-serializer-bidirectional-relation

Build mapping for restore bidirectional relation

v1.0.0 2020-03-15 17:47 UTC

Requires

• php: ^7.2
• jms/serializer: ^1.14|^2.0|^3.0

Requires (Dev)

• ext-json: *
• phpmd/phpmd: ^2.8
• phpunit/phpunit: ^8.4
• squizlabs/php_codesniffer: 3.*

MIT

• Remy

• serializer
• jms serializer
• bidirectional relation

README

Description

Build a mapping for restore bidirectional relation when deserialize process.

This mapping is add to your serialized content with _mapping_bidirectional_relation key.

Install

With jms/serializer (without symfony)

use JMS\Serializer\SerializerBuilder;
use JMS\Serializer\EventDispatcher\EventDispatcher;
use Coosos\BidirectionalRelation\EventSubscriber\MapDeserializerSubscriber;
use Coosos\BidirectionalRelation\EventSubscriber\MapSerializerSubscriber;

$builder = SerializerBuilder::create();
$builder->configureListeners(function (EventDispatcher $dispatcher) {
    $dispatcher->addSubscriber(new MapSerializerSubscriber());
    $dispatcher->addSubscriber(new MapDeserializerSubscriber());
});

$serializer = $builder->build();

With Symfony

# services.yml
Coosos\BidirectionalRelation\EventSubscriber\MapDeserializerSubscriber:
      tags:
        - { name: jms_serializer.event_subscriber }

Coosos\BidirectionalRelation\EventSubscriber\MapSerializerSubscriber:
      tags:
        - { name: jms_serializer.event_subscriber }

Usage

Annotation (Minimum required)

For to avoid mapping on an object that does not need it, you should add @Coosos\BidirectionalRelation\Annotations\SerializerBidirectionalRelation to annotation class (only root model)

Exclude from mapping

If you want to exclude an object to map, you can by adding @Coosos\BidirectionalRelation\Annotations\ExcludeFromMapping annotation to your field.