[Serializer] Add a 'make:serializer:normalizer' command

Author: lyrixx

src/Maker/MakeSerializerNormalizer.php

@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Maker;
+
+use Symfony\Bundle\MakerBundle\ConsoleStyle;
+use Symfony\Bundle\MakerBundle\DependencyBuilder;
+use Symfony\Bundle\MakerBundle\Generator;
+use Symfony\Bundle\MakerBundle\InputConfiguration;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Serializer\Serializer;
+
+/**
+ * @author Grégoire Pineau <[email protected]>
+ */
+final class MakeSerializerNormalizer extends AbstractMaker
+{
+    public static function getCommandName(): string
+    {
+        return 'make:serializer:normalizer';
+    }
+
+    public function configureCommand(Command $command, InputConfiguration $inputConf)
+    {
+        $command
+            ->setDescription('Creates a new serializer normalizer class')
+            ->addArgument('name', InputArgument::OPTIONAL, 'Choose a class name for your normalizer (e.g. <fg=yellow>UserNormalizer</>)')
+            ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeSerializerNormalizer.txt'))
+        ;
+    }
+
+    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator)
+    {
+        $normalizerClassNameDetails = $generator->createClassNameDetails(
+            $input->getArgument('name'),
+            'Serializer\\Normalizer\\',
+            'Normalizer'
+        );
+
+        $generator->generateClass(
+            $normalizerClassNameDetails->getFullName(),
+            'serializer/Normalizer.tpl.php'
+        );
+
+        $generator->writeChanges();
+
+        $this->writeSuccessMessage($io);
+
+        $io->text([
+            'Next: Open your new serializer normalizer class and start customizing it.',
+            // Wait for https://github.com/symfony/symfony-docs/pull/10515
+            // 'Find the documentation at <fg=yellow>http://symfony.com/doc/current/serializer/custom_normalizers.html</>',
+        ]);
+    }
+
+    public function configureDependencies(DependencyBuilder $dependencies)
+    {
+        $dependencies->addClassDependency(
+            Serializer::class,
+            'serializer'
+        );
+    }
+}

src/Resources/config/makers.xml

@@ -54,6 +54,10 @@
                 <tag name="maker.command" />
             </service>
 
+            <service id="maker.maker.make_serializer_normalizer" class="Symfony\Bundle\MakerBundle\Maker\MakeSerializerNormalizer">
+                <tag name="maker.command" />
+            </service>
+
             <service id="maker.maker.make_subscriber" class="Symfony\Bundle\MakerBundle\Maker\MakeSubscriber">
                 <tag name="maker.command" />
                 <argument type="service" id="maker.event_registry" />

src/Resources/help/MakeSerializerNormalizer.txt

@@ -0,0 +1,5 @@
+The <info>%command.name%</info> command generates a new serializer normalizer class.
+
+<info>php %command.full_name% UserNormalizer</info>
+
+If the argument is missing, the command will ask for the class name interactively.

src/Resources/skeleton/serializer/Normalizer.tpl.php

@@ -0,0 +1,30 @@
+<?= "<?php\n" ?>
+
+namespace <?= $namespace; ?>;
+
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
+
+class <?= $class_name ?> implements NormalizerInterface
+{
+    private $normalizer;
+
+    public function __construct(ObjectNormalizer $normalizer)
+    {
+        $this->normalizer = $normalizer;
+    }
+
+    public function normalize($object, $format = null, array $context = array()): array
+    {
+        $data = $this->normalizer->normalize($object, $format, $context);
+
+        // Here: add, edit, or delete some data
+
+        return $data;
+    }
+
+    public function supportsNormalization($data, $format = null): bool
+    {
+        return $data instanceof \App\Entity\BlogPost;
+    }
+}