From 133d2b0973022142dcfde57f8ceea2938fb7e537 Mon Sep 17 00:00:00 2001 From: soyuka Date: Thu, 24 Oct 2024 19:04:50 +0200 Subject: [PATCH] [FrameworkBundle] Object Mapper component bindings --- .../Compiler/UnusedTagsPass.php | 2 ++ .../FrameworkExtension.php | 11 +++++++ .../Resources/config/object_mapper.php | 33 +++++++++++++++++++ .../Fixtures/ObjectMapper/ObjectMapped.php | 17 ++++++++++ .../ObjectMapper/ObjectToBeMapped.php | 21 ++++++++++++ .../ObjectMapper/TransformCallable.php | 25 ++++++++++++++ .../Tests/Functional/ObjectMapperTest.php | 31 +++++++++++++++++ .../Functional/app/ObjectMapper/bundles.php | 16 +++++++++ .../Functional/app/ObjectMapper/config.yml | 9 +++++ .../Bundle/FrameworkBundle/composer.json | 1 + 10 files changed, 166 insertions(+) create mode 100644 src/Symfony/Bundle/FrameworkBundle/Resources/config/object_mapper.php create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/ObjectMapped.php create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/ObjectToBeMapped.php create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/TransformCallable.php create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ObjectMapperTest.php create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ObjectMapper/bundles.php create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ObjectMapper/config.yml diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php index c8271d46335cc..53361e3127e34 100644 --- a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php +++ b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php @@ -106,6 +106,8 @@ class UnusedTagsPass implements CompilerPassInterface 'validator.group_provider', 'validator.initializer', 'workflow', + 'object_mapper.transform_callable', + 'object_mapper.condition_callable', ]; public function process(ContainerBuilder $container): void diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php index fed06a6c74814..5044e3cc2751f 100644 --- a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php +++ b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php @@ -144,6 +144,9 @@ use Symfony\Component\Notifier\Recipient\Recipient; use Symfony\Component\Notifier\TexterInterface; use Symfony\Component\Notifier\Transport\TransportFactoryInterface as NotifierTransportFactoryInterface; +use Symfony\Component\ObjectMapper\ConditionCallableInterface; +use Symfony\Component\ObjectMapper\ObjectMapperInterface; +use Symfony\Component\ObjectMapper\TransformCallableInterface; use Symfony\Component\Process\Messenger\RunProcessMessageHandler; use Symfony\Component\PropertyAccess\PropertyAccessor; use Symfony\Component\PropertyInfo\Extractor\ConstructorArgumentTypeExtractorInterface; @@ -863,6 +866,14 @@ private function registerFormConfiguration(array $config, ContainerBuilder $cont if (!ContainerBuilder::willBeAvailable('symfony/translation', Translator::class, ['symfony/framework-bundle', 'symfony/form'])) { $container->removeDefinition('form.type_extension.upload.validator'); } + + if (ContainerBuilder::willBeAvailable('symfony/object-mapper', ObjectMapperInterface::class, ['symfony/framework-bundle'])) { + $loader->load('object_mapper.php'); + $container->registerForAutoconfiguration(TransformCallableInterface::class) + ->addTag('object_mapper.transform_callable'); + $container->registerForAutoconfiguration(ConditionCallableInterface::class) + ->addTag('object_mapper.condition_callable'); + } } private function registerHttpCacheConfiguration(array $config, ContainerBuilder $container, bool $httpMethodOverride): void diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/object_mapper.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/object_mapper.php new file mode 100644 index 0000000000000..8addad4da04fe --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Resources/config/object_mapper.php @@ -0,0 +1,33 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\DependencyInjection\Loader\Configurator; + +use Symfony\Component\ObjectMapper\Metadata\ObjectMapperMetadataFactoryInterface; +use Symfony\Component\ObjectMapper\Metadata\ReflectionObjectMapperMetadataFactory; +use Symfony\Component\ObjectMapper\ObjectMapper; +use Symfony\Component\ObjectMapper\ObjectMapperInterface; + +return static function (ContainerConfigurator $container) { + $container->services() + ->set('object_mapper.metadata_factory', ReflectionObjectMapperMetadataFactory::class) + ->alias(ObjectMapperMetadataFactoryInterface::class, 'object_mapper.metadata_factory') + + ->set('object_mapper', ObjectMapper::class) + ->args([ + service('object_mapper.metadata_factory'), + service('property_accessor')->ignoreOnInvalid(), + tagged_locator('object_mapper.transform_callable'), + tagged_locator('object_mapper.condition_callable'), + ]) + ->alias(ObjectMapperInterface::class, 'object_mapper') + ; +}; diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/ObjectMapped.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/ObjectMapped.php new file mode 100644 index 0000000000000..17edc9dcef465 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/ObjectMapped.php @@ -0,0 +1,17 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures\ObjectMapper; + +final class ObjectMapped +{ + public string $a; +} diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/ObjectToBeMapped.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/ObjectToBeMapped.php new file mode 100644 index 0000000000000..fc5b7080ad11a --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/ObjectToBeMapped.php @@ -0,0 +1,21 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures\ObjectMapper; + +use Symfony\Component\ObjectMapper\Attribute\Map; + +#[Map(target: ObjectMapped::class)] +final class ObjectToBeMapped +{ + #[Map(transform: TransformCallable::class)] + public string $a = 'nottransformed'; +} diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/TransformCallable.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/TransformCallable.php new file mode 100644 index 0000000000000..da4f26a2dd4e6 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/TransformCallable.php @@ -0,0 +1,25 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures\ObjectMapper; + +use Symfony\Component\ObjectMapper\TransformCallableInterface; + +/** + * @implements TransformCallableInterface + */ +final class TransformCallable implements TransformCallableInterface +{ + public function __invoke(mixed $value, object $object): mixed + { + return 'transformed'; + } +} diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ObjectMapperTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ObjectMapperTest.php new file mode 100644 index 0000000000000..e314ee1b029e5 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ObjectMapperTest.php @@ -0,0 +1,31 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Bundle\FrameworkBundle\Tests\Functional; + +use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\ObjectMapper\ObjectMapped; +use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\ObjectMapper\ObjectToBeMapped; + +/** + * @author Kévin Dunglas + */ +class ObjectMapperTest extends AbstractWebTestCase +{ + public function testObjectMapper() + { + static::bootKernel(['test_case' => 'ObjectMapper']); + + /** @var Symfony\Component\ObjectMapper\ObjectMapperInterface */ + $objectMapper = static::getContainer()->get('object_mapper.alias'); + $mapped = $objectMapper->map(new ObjectToBeMapped()); + $this->assertSame($mapped->a, 'transformed'); + } +} diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ObjectMapper/bundles.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ObjectMapper/bundles.php new file mode 100644 index 0000000000000..13ab9fddee4a6 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ObjectMapper/bundles.php @@ -0,0 +1,16 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +use Symfony\Bundle\FrameworkBundle\FrameworkBundle; + +return [ + new FrameworkBundle(), +]; diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ObjectMapper/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ObjectMapper/config.yml new file mode 100644 index 0000000000000..3e3bd8702c6f6 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ObjectMapper/config.yml @@ -0,0 +1,9 @@ +imports: + - { resource: ../config/default.yml } + +services: + object_mapper.alias: + alias: object_mapper + public: true + Symfony\Bundle\FrameworkBundle\Tests\Fixtures\ObjectMapper\TransformCallable: + autoconfigure: true diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json index 72d33ed884df2..6ac3491c730ad 100644 --- a/src/Symfony/Bundle/FrameworkBundle/composer.json +++ b/src/Symfony/Bundle/FrameworkBundle/composer.json @@ -54,6 +54,7 @@ "symfony/messenger": "^6.4|^7.0", "symfony/mime": "^6.4|^7.0", "symfony/notifier": "^6.4|^7.0", + "symfony/object-mapper": "^7.3", "symfony/process": "^6.4|^7.0", "symfony/rate-limiter": "^6.4|^7.0", "symfony/scheduler": "^6.4.4|^7.0.4",