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

Utworzony 3y | 27 kwi 2022, 13:20:14


Zaloguj się, aby dodać komentarz

Inne posty w tej grupie

A Week of Symfony #967 (July 7–13, 2025)

This week, Symfony unveiled the Symfony AI initiative, a set of components and bundles designed to bring powerful AI capabilities directly into your PHP applications. In addition, we published travel

13 lip 2025, 09:20:11 | Symfony
Kicking off the Symfony AI Initiative

Today we are happy to announce a new Symfony initiative called Symfony AI - with the goal to provide a comprehensive set of components and bundles designed to bring powerful AI capabilities directly i

11 lip 2025, 13:20:27 | Symfony
SymfonyCon Amsterdam 2025: Travel & Lodging Tips

SymfonyCon Amsterdam 2025, our next annual international Symfony conference, will take place on:

November 25 & 26: 2 workshops days with several topics to learn, practice and improve your skills

11 lip 2025, 08:40:20 | Symfony
A Week of Symfony #966 (June 30 – July 6, 2025)

This week, development on the upcoming Symfony 8.0 version continued with the removal of deprecated features and the marking of several classes as final. In addition, we published two new case studies

6 lip 2025, 08:10:15 | Symfony
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

4 lip 2025, 09:40:14 | 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

2 lip 2025, 09:10:03 | 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

29 cze 2025, 09:10:15 | Symfony