NotificationsYou must be signed in to change notification settings
Fork9.6k
Star30.4k

[FrameworkBundle][Serializer] Allow setting`$objectClassResolver` via configuration#60092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

HypeMC wants to merge1 commit intosymfony:7.4

base:7.4

Choose a base branch

fromHypeMC:allow-setting-object-class-resolver

Open

[FrameworkBundle][Serializer] Allow setting`$objectClassResolver` via configuration#60092

HypeMC wants to merge1 commit intosymfony:7.4fromHypeMC:allow-setting-object-class-resolver

Conversation

Copy link

Member

HypeMC commentedMar 31, 2025

Q	A
Branch?	7.3
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	Fix#58526
License	MIT

Currently, theMaxDepth feature doesn't work correctly with Doctrine proxies because theisMaxDepthReached method relies on the object's class:

symfony/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php

Lines 1053 to 1075 in091ae5b

	privatefunctionisMaxDepthReached(array$attributesMetadata,string$class,string$attribute,array &$context):bool
	{
	if (!($enableMaxDepth =$context[self::ENABLE_MAX_DEPTH] ??$this->defaultContext[self::ENABLE_MAX_DEPTH] ??false)
	\|\| !isset($attributesMetadata[$attribute]) \|\|null ===$maxDepth =$attributesMetadata[$attribute]?->getMaxDepth()
	) {
	returnfalse;
	}

	$key =\sprintf(self::DEPTH_KEY_PATTERN,$class,$attribute);
	if (!isset($context[$key])) {
	$context[$key] =1;

	returnfalse;
	}

	if ($context[$key] ===$maxDepth) {
	returntrue;
	}

	++$context[$key];

	returnfalse;
	}

This class is determined usingget_class(), which returns a different result for proxy and non-proxy objects:

symfony/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php

Line 149 in091ae5b

$this->objectClassResolver = ($objectClassResolver ??'get_class')(...);

Both theObjectNormalizer andPropertyNormalizer have a$objectClassResolver property, but there is currently no way to configure it.

This PR introduces a new configuration option to set the$objectClassResolver. You can provide either a callable or a service:

Using a callable:

framework:serializer:object_class_resolver:[ 'Doctrine\ORM\Proxy\DefaultProxyClassNameResolver', 'getClass' ]

Using a service:

services:app.object_class_resolver:class:Closurefrom_callable:[ !service { class: 'Doctrine\ORM\Proxy\DefaultProxyClassNameResolver' }, 'getClass' ]framework:serializer:object_class_resolver:app.object_class_resolver

HypeMC requested a review fromdunglas as acode owner

March 31, 2025 01:10

carsonbot added Status: Needs Review Feature FrameworkBundle Serializer labels

Mar 31, 2025

carsonbot added this to the7.3 milestone

Mar 31, 2025

carsonbot changed the title~~[Serializer][FrameworkBundle] Allow setting$objectClassResolver via configuration~~[FrameworkBundle][Serializer] Allow setting$objectClassResolver via configuration

Mar 31, 2025

[Serializer][FrameworkBundle] Allow setting$objectClassResolver vi…

b20009c

…a configuration

HypeMC force-pushed theallow-setting-object-class-resolver branch fromf737ffb tob20009cCompare

March 31, 2025 01:12

HypeMC commented

Mar 31, 2025

View reviewed changes

src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php

		if (!($enableMaxDepth = $context[self::ENABLE_MAX_DEPTH] ?? $this->defaultContext[self::ENABLE_MAX_DEPTH] ?? false)
		if (!($context[self::ENABLE_MAX_DEPTH] ?? $this->defaultContext[self::ENABLE_MAX_DEPTH] ?? false)

Copy link

MemberAuthor

HypeMCMar 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Not used.

nicolas-grekas reviewed

Mar 31, 2025

View reviewed changes

Copy link

Member

nicolas-grekas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

IIUC, this means everybody using the Serializer with Doctrine entities will need this, isn't it?
Shouldn't we patch DoctrineBundle instead so that there's nothing to configure on the user side?