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

Created 3y | Apr 27, 2022, 1:20:14 PM


Login to add comment

Other posts in this group

Case study: Modernizing Audi France’s Digital Ecosystem with Symfony 6

At Wide, Micropole’s digital agency, they help leading brands modernize their digital infrastructures while ensuring scalability, security, and performance. When Audi France approached them to migrate

Jul 4, 2025, 9:40:14 AM | Symfony
Case study: A Long-Term Powerhouse Behind Vente-unique.com's E-Commerce Success (Zero Churn, All Wins!)

Vente-unique.com, a leading European online retailer of furniture and home decor, operates in 11 countries, powered by a team of 400 professionals and serving more than 3 million customers. From 15 ye

Jul 2, 2025, 9:10:03 AM | Symfony
A Week of Symfony #965 (June 23–29, 2025)

This week, Symfony 6.4.23, 7.2.8 and 7.3.1 maintenance versions were released. Meanwhile, the upcoming Symfony 7.4 version continued adding new features such as better controller helpers, more precisi

Jun 29, 2025, 9:10:15 AM | Symfony
Symfony 6.4.23 released

Symfony 6.4.23 has just been released. Read the Symfony upgrade guide to learn more about upgrading Symfony and use the SymfonyInsight upgrade reports to detect the code you will need to change in you

Jun 28, 2025, 9:50:15 AM | Symfony
Symfony 7.2.8 released

Symfony 7.2.8 has just been released. Read the Symfony upgrade guide to learn more about upgrading Symfony and use the SymfonyInsight upgrade reports to detect the code you will need to change in your

Jun 28, 2025, 9:50:15 AM | Symfony
Symfony 7.3.1 released

Symfony 7.3.1 has just been released. Read the Symfony upgrade guide to learn more about upgrading Symfony and use the SymfonyInsight upgrade reports to detect the code you will need to change in your

Jun 28, 2025, 9:50:14 AM | Symfony
A Week of Symfony #964 (June 16–22, 2025)

This week, development activity was intense, with many bug fixes in the maintained branches, numerous deprecation removals in the 8.0 branch, and new features added to the 7.4 branch, including tighte

Jun 22, 2025, 8:10:05 AM | Symfony