symfony · fabpot · Sep 5, 2020 · Jul 29, 2020 · Sep 5, 2020
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1217,6 +1217,8 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
     private function registerValidationConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, bool $propertyInfoEnabled)
     {
         if (!$this->validatorConfigEnabled = $this->isConfigEnabled($container, $config)) {
+            $container->removeDefinition('console.command.validator_debug');
+
             return;
         }
 

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.php
@@ -47,6 +47,7 @@
 use Symfony\Component\Messenger\Command\SetupTransportsCommand;
 use Symfony\Component\Messenger\Command\StopWorkersCommand;
 use Symfony\Component\Translation\Command\XliffLintCommand;
+use Symfony\Component\Validator\Command\DebugCommand as ValidatorDebugCommand;
 
 return static function (ContainerConfigurator $container) {
     $container->services()
@@ -225,6 +226,12 @@
             ])
             ->tag('console.command', ['command' => 'translation:update'])
 
+        ->set('console.command.validator_debug', ValidatorDebugCommand::class)
+            ->args([
+                service('validator'),
+            ])
+            ->tag('console.command', ['command' => 'debug:validator'])
+
         ->set('console.command.workflow_dump', WorkflowDumpCommand::class)
             ->tag('console.command', ['command' => 'workflow:dump'])
 

diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -57,7 +57,7 @@
         "symfony/string": "^5.0",
         "symfony/translation": "^5.0",
         "symfony/twig-bundle": "^4.4|^5.0",
-        "symfony/validator": "^4.4|^5.0",
+        "symfony/validator": "^5.2",
         "symfony/workflow": "^5.2",
         "symfony/yaml": "^4.4|^5.0",
         "symfony/property-info": "^4.4|^5.0",
@@ -88,7 +88,7 @@
         "symfony/translation": "<5.0",
         "symfony/twig-bridge": "<4.4",
         "symfony/twig-bundle": "<4.4",
-        "symfony/validator": "<4.4",
+        "symfony/validator": "<5.2",
         "symfony/web-profiler-bundle": "<4.4",
         "symfony/workflow": "<5.2"
     },

diff --git a/src/Symfony/Component/Validator/Command/DebugCommand.php b/src/Symfony/Component/Validator/Command/DebugCommand.php
@@ -0,0 +1,200 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Dumper;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\Finder\Exception\DirectoryNotFoundException;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Mapping\ClassMetadataInterface;
+use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface;
+
+/**
+ * A console command to debug Validators information.
+ *
+ * @author Loïc Frémont <lc.fremont@gmail.com>
+ */
+class DebugCommand extends Command
+{
+    protected static $defaultName = 'debug:validator';
+
+    private $validator;
+
+    public function __construct(MetadataFactoryInterface $validator)
+    {
+        parent::__construct();
+
+        $this->validator = $validator;
+    }
+
+    protected function configure()
+    {
+        $this
+            ->addArgument('class', InputArgument::REQUIRED, 'A fully qualified class name or a path')
+            ->addOption('show-all', null, InputOption::VALUE_NONE, 'Show all classes even if they have no validation constraints')
+            ->setDescription('Displays validation constraints for classes')
+            ->setHelp(<<<'EOF'
+The <info>%command.name% 'App\Entity\Dummy'</info> command dumps the validators for the dummy class.
+
+The <info>%command.name% src/</info> command dumps the validators for the `src` directory.
+EOF
+            )
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $class = $input->getArgument('class');
+
+        if (class_exists($class)) {
+            $this->dumpValidatorsForClass($input, $output, $class);
+
+            return 0;
+        }
+
+        try {
+            foreach ($this->getResourcesByPath($class) as $class) {
+                $this->dumpValidatorsForClass($input, $output, $class);
+            }
+        } catch (DirectoryNotFoundException $exception) {
+            $io = new SymfonyStyle($input, $output);
+            $io->error(sprintf('Neither class nor path were found with "%s" argument.', $input->getArgument('class')));
+
+            return 1;
+        }
+
+        return 0;
+    }
+
+    private function dumpValidatorsForClass(InputInterface $input, OutputInterface $output, string $class): void
+    {
+        $io = new SymfonyStyle($input, $output);
+        $title = sprintf('<info>%s</info>', $class);
+        $rows = [];
+        $dump = new Dumper($output);
+
+        foreach ($this->getConstrainedPropertiesData($class) as $propertyName => $constraintsData) {
+            foreach ($constraintsData as $data) {
+                $rows[] = [
+                    $propertyName,
+                    $data['class'],
+                    implode(', ', $data['groups']),
+                    $dump($data['options']),
+                ];
+            }
+        }
+
+        if (!$rows) {
+            if (false === $input->getOption('show-all')) {
+                return;
+            }
+
+            $io->section($title);
+            $io->text('No validators were found for this class.');
+
+            return;
+        }
+
+        $io->section($title);
+
+        $table = new Table($output);
+        $table->setHeaders(['Property', 'Name', 'Groups', 'Options']);
+        $table->setRows($rows);
+        $table->setColumnMaxWidth(3, 80);
+        $table->render();
+    }
+
+    private function getConstrainedPropertiesData(string $class): array
+    {
+        $data = [];
+
+        /** @var ClassMetadataInterface $classMetadata */
+        $classMetadata = $this->validator->getMetadataFor($class);
+
+        foreach ($classMetadata->getConstrainedProperties() as $constrainedProperty) {
+            $data[$constrainedProperty] = $this->getPropertyData($classMetadata, $constrainedProperty);
+        }
+
+        return $data;
+    }
+
+    private function getPropertyData(ClassMetadataInterface $classMetadata, string $constrainedProperty): array
+    {
+        $data = [];
+
+        $propertyMetadata = $classMetadata->getPropertyMetadata($constrainedProperty);
+        foreach ($propertyMetadata as $metadata) {
+            foreach ($metadata->getConstraints() as $constraint) {
+                $data[] = [
+                    'class' => \get_class($constraint),
+                    'groups' => $constraint->groups,
+                    'options' => $this->getConstraintOptions($constraint),
+                ];
+            }
+        }
+
+        return $data;
+    }
+
+    private function getConstraintOptions(Constraint $constraint): array
+    {
+        $options = [];
+
+        foreach (array_keys(get_object_vars($constraint)) as $propertyName) {
+            // Groups are dumped on a specific column.
+            if ('groups' === $propertyName) {
+                continue;
+            }
+
+            $options[$propertyName] = $constraint->$propertyName;
+        }
+
+        return $options;
+    }
+
+    private function getResourcesByPath(string $path): array
+    {
+        $finder = new Finder();
+        $finder->files()->in($path)->name('*.php')->sortByName(true);
+        $classes = [];
+
+        foreach ($finder as $file) {
+            $fileContent = file_get_contents($file->getRealPath());
+
+            preg_match('/namespace (.+);/', $fileContent, $matches);
+
+            $namespace = $matches[1] ?? null;
+
+            if (false === preg_match('/class +([^{ ]+)/', $fileContent, $matches)) {
+                // no class found
+                continue;
+            }
+
+            $className = trim($matches[1]);
+
+            if (null !== $namespace) {
+                $classes[] = $namespace.'\\'.$className;
+            } else {
+                $classes[] = $className;
+            }
+        }
+
+        return $classes;
+    }
+}
-Original file line number
+Diff line change
@@ Expand Up @@
         private function registerValidationConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, bool $propertyInfoEnabled)
         {
             if (!$this->validatorConfigEnabled = $this->isConfigEnabled($container, $config)) {
+                $container->removeDefinition('console.command.validator_debug');
                 return;
             }
@@ Expand Down @@