New in Symfony 6.1: Serializer Context Builders

Contributed by Mathias Arlaud in #43973.

The Serializer component allows you to pass some context information to the serializing and deserializing process. For example, to ignore certain attributes when serializing, you can use the following code:

    $serializer->serialize($person, 'json', ['ignored_attributes' => ['age']]);

// Symfony also defines public constants for the names of all context options $serializer->serialize($person, 'json', [AbstractNormalizer::IGNORED_ATTRIBUTES => ['age']]);

In Symfony 6.1 we're improving the definition of serialization contexts with the introduction of Context Builders. Instead of having to deal with plain arrays, these objects allow you to define the context using a fluent interface which provides autocompletion, validation and documentation. As shown in this example, you can mix both arrays and builder objects and you can even merge these context objects between them:

    use Symfony\Component\Serializer\Context\Encoder\CsvEncoderContextBuilder;

use Symfony\Component\Serializer\Context\Normalizer\ObjectNormalizerContextBuilder;

$initialContext = [ 'custom_key' => 'custom_value', ];

$contextBuilder = (new ObjectNormalizerContextBuilder()) ->withContext($initialContext) ->withGroups(['group1', 'group2']);

$contextBuilder = (new CsvEncoderContextBuilder()) ->withContext($contextBuilder) ->withDelimiter(';');

$serializer->serialize($something, 'csv', $contextBuilder->toArray());

If you need the context as a plain array (e.g. to pass it to serialize() method) call to the toArray() method:

    $this->serializer->serialize($data, 'csv', $contextBuilder->toArray());

When building your own context builder, consider using the Symfony\Component\Serializer\Context\ContextBuilderTrait to reuse some common methods:

    // src/Serializer/LegacyContextBuilder

namespace App\Serializer;

use Symfony\Component\Serializer\Context\ContextBuilderInterface; use Symfony\Component\Serializer\Context\ContextBuilderTrait;

final class LegacyContextBuilder implements ContextBuilderInterface { use ContextBuilderTrait;

public function withNullableDates(bool $nullable = true): static
{
    return $this->with('zero_datetime_to_null', $nullable);
}

}

// you can now use this context builder as follows: // $context = (new LegacyContextBuilder())->withNullableDates();

                Sponsor the Symfony project.

https://symfony.com/blog/new-in-symfony-6-1-serializer-context-builders?utm_source=Symfony%20Blog%20Feed&utm_medium=feed

Établi 3y | 27 avr. 2022, 13:20:14


Connectez-vous pour ajouter un commentaire

Autres messages de ce groupe

A Week of Symfony #973 (August 18–24, 2025)

This week, Symfony development focused on improving the IsGranted attribute with a new option, updated the Route attribute to allow setting multiple environments, improved the DomCrawler component to

24 août 2025, 09:40:28 | Symfony
A Week of Symfony #972 (August 11–17, 2025)

This week, development activity mostly focused on dealing with the deprecation of sleep/wakeup methods in PHP 8.5 and their replacement by serialize/unserialize methods. In addition, we published more

17 août 2025, 08:30:06 | Symfony
Let’s build the Symfony AI ecosystem together

It’s been only in July that we published symfony/ai and kicked off our AI initiative, but the repository has been busy since day one. Over 500 stars, more than 200 pull requests & issues, trending

16 août 2025, 09:30:03 | Symfony
SymfonyCon Amsterdam 2025:   Unconference Track at SymfonyCon Amsterdam 2025

🎤 Take the stage at SymfonyCon Amsterdam 2025, on your own terms!

The Unconference track is back and more dynamic than ever!

This unique, participant-driven format invites attendees to shape

12 août 2025, 12:40:20 | Symfony
A Week of Symfony #971 (August 4–10, 2025)

This week, Symfony completed the migration to PHPUnit 12 in the 7.4 branch, which required many changes during the past weeks, such as replacing annotations with attributes. In addition, we updated th

10 août 2025, 09:40:09 | Symfony
SymfonyCon Amsterdam 2025:  Join the Symfony Hackathon:  Collaborate, Contribute, Create

🧑‍💻HACKDAY IS COMING!

Get ready to code, collaborate, and contribute, Symfony Hackday is back!

Join us in Amsterdam on Saturday, November 29th, for a hands-on hackathon designed to bring the

6 août 2025, 10:40:04 | Symfony
A Week of Symfony #970 (July 28 – August 3, 2025)

This week, Symfony released the maintenance versions 6.4.24, 7.2.9, and 7.3.2. Meanwhile, we began deprecating the XML configuration format in some components, enhanced the YAML configuration format t

3 août 2025, 08:30:03 | Symfony