Method with a SerializedName attribute getting ignored when object is serialized with symfony serializer

Question

I have a symfony serializer that i initialize this way :

$this->serializer = new Serializer(
    [
        new ArrayDenormalizer(),
        new UidNormalizer(),
        new BackedEnumNormalizer(),
        new DateTimeNormalizer(),
        new ObjectNormalizer(
            classMetadataFactory: new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader())),
            nameConverter: new CamelCaseToSnakeCaseNameConverter(),
            propertyTypeExtractor: new PropertyInfoExtractor([], [new PhpDocExtractor(), new ReflectionExtractor()])
        ),
    ],
    [new JsonEncoder()]
);

and a method on my object, i want to serialize with a specific name (getRrule being an existant method so i can't just rename it)

#[Serializer\Groups(['prestation:default'])]
#[Serializer\SerializedName('rrule')]
public function getRruleRfcString(): ?string
{
    return $this->rrule?->rfcString();
}

but when serialized i get : "rrule_rfc_string" => null

instead of : "rrule" => null

also the serialization group is working fine so i dont know why only one attribute out of two are working...

James · Accepted Answer · 2024-05-31 09:23:13Z

5

I just resolved it:

$classMetadataFactory = new ClassMetadataFactory(
    new AnnotationLoader(new AnnotationReader())
);

$this->serializer = new Serializer(
    [
        new ArrayDenormalizer(),
        new UidNormalizer(),
        new BackedEnumNormalizer(),
        new DateTimeNormalizer(),
        new ObjectNormalizer(
            classMetadataFactory: new ClassMetadataFactory(
                new AnnotationLoader(new AnnotationReader())
            ),
            nameConverter: new MetadataAwareNameConverter(
                $classMetadataFactory,
                new CamelCaseToSnakeCaseNameConverter()
            ),
            propertyTypeExtractor: new PropertyInfoExtractor(
                [],
                [
                    new PhpDocExtractor(),
                    new ReflectionExtractor()
                ]
            )
        ),
    ],
    [new JsonEncoder()]
);

Just needed to add a MetadataAwareNameConverter plus put the CamelCaseToSnakeCaseNameConverter as fallback name converter

edited May 31, 2024 at 9:23

James

4,7905 gold badges39 silver badges50 bronze badges

answered Jun 5, 2023 at 10:11

Methraen

997 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Jenne Over a year ago

Unless you are using the serializer as a standalone component please use it as described in symfony.com/doc/current/…. Symfony as a framework comes with a preconfigured out of the box serializer service you can inject which has all these things set up which avoids a lot of hassle.

Alex Dawn Jul 22 at 11:52

Thank you this answer was a lifesaver for some reason the autowired version of the Serializer was without the MetadataAwareNameConverter and the docs are somewhat limited on how to configure how the service is built. This got me far enough to test and get unstuck.

Collectives™ on Stack Overflow

Method with a SerializedName attribute getting ignored when object is serialized with symfony serializer

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related