Add native types to command classes (#9359)

derrabus · web-flow · commit 9f85e2769cf7 · 2022-01-11T08:53:17.000+01:00
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/AbstractEntityManagerCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/AbstractEntityManagerCommand.php
@@ -12,14 +12,9 @@
 
 abstract class AbstractEntityManagerCommand extends Command
 {
-    /** @var EntityManagerProvider|null */
-    private $entityManagerProvider;
-
-    public function __construct(?EntityManagerProvider $entityManagerProvider = null)
+    public function __construct(private ?EntityManagerProvider $entityManagerProvider = null)
     {
         parent::__construct();
-
-        $this->entityManagerProvider = $entityManagerProvider;
     }
 
     final protected function getEntityManager(InputInterface $input): EntityManagerInterface
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/CollectionRegionCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/CollectionRegionCommand.php
@@ -20,10 +20,7 @@
  */
 class CollectionRegionCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:clear-cache:region:collection')
              ->setDescription('Clear a second-level cache collection region')
@@ -60,12 +57,7 @@ protected function configure()
              );
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/EntityRegionCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/EntityRegionCommand.php
@@ -20,10 +20,7 @@
  */
 class EntityRegionCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:clear-cache:region:entity')
              ->setDescription('Clear a second-level cache entity region')
@@ -59,12 +56,7 @@ protected function configure()
              );
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/MetadataCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/MetadataCommand.php
@@ -18,10 +18,7 @@
  */
 class MetadataCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:clear-cache:metadata')
              ->setDescription('Clear all metadata cache of the various cache drivers')
@@ -33,12 +30,7 @@ protected function configure()
              );
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/QueryCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/QueryCommand.php
@@ -27,10 +27,7 @@
  */
 class QueryCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:clear-cache:query')
              ->setDescription('Clear all query cache of the various cache drivers')
@@ -56,12 +53,7 @@ protected function configure()
              );
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/QueryRegionCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/QueryRegionCommand.php
@@ -20,10 +20,7 @@
  */
 class QueryRegionCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:clear-cache:region:query')
              ->setDescription('Clear a second-level cache query region')
@@ -58,12 +55,7 @@ protected function configure()
              );
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/ResultCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/ClearCache/ResultCommand.php
@@ -29,10 +29,7 @@
  */
 class ResultCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:clear-cache:result')
              ->setDescription('Clear all result cache of the various cache drivers')
@@ -58,12 +55,7 @@ protected function configure()
              );
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/GenerateProxiesCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/GenerateProxiesCommand.php
@@ -26,10 +26,7 @@
  */
 class GenerateProxiesCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:generate-proxies')
              ->setAliases(['orm:generate:proxies'])
@@ -40,12 +37,7 @@ protected function configure()
              ->setHelp('Generates proxy classes for entity classes.');
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/InfoCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/InfoCommand.php
@@ -20,10 +20,7 @@
  */
 class InfoCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:info')
              ->setDescription('Show basic information about all mapped entities')
@@ -36,12 +33,7 @@ protected function configure()
              );
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/MappingDescribeCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/MappingDescribeCommand.php
@@ -188,10 +188,8 @@ static function ($mappedEntity) use ($entityName) {
 
     /**
      * Format the given value for console output
-     *
-     * @param mixed $value
      */
-    private function formatValue($value): string
+    private function formatValue(mixed $value): string
     {
         if ($value === '') {
             return '';
@@ -233,7 +231,7 @@ private function formatValue($value): string
      * @return string[]
      * @psalm-return array{0: string, 1: string}
      */
-    private function formatField(string $label, $value): array
+    private function formatField(string $label, mixed $value): array
     {
         if ($value === null) {
             $value = '<comment>None</comment>';
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/RunDqlCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/RunDqlCommand.php
@@ -27,10 +27,7 @@
  */
 class RunDqlCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:run-dql')
              ->setDescription('Executes arbitrary DQL directly from the command line')
@@ -44,12 +41,7 @@ protected function configure()
              ->setHelp('Executes arbitrary DQL directly from the command line.');
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/SchemaTool/AbstractCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/SchemaTool/AbstractCommand.php
@@ -19,17 +19,10 @@ abstract class AbstractCommand extends AbstractEntityManagerCommand
 {
     /**
      * @param mixed[] $metadatas
-     *
-     * @return int|null Null or 0 if everything went fine, or an error code.
      */
-    abstract protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas, SymfonyStyle $ui);
+    abstract protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas, SymfonyStyle $ui): int;
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/SchemaTool/CreateCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/SchemaTool/CreateCommand.php
@@ -19,10 +19,7 @@
  */
 class CreateCommand extends AbstractCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:schema-tool:create')
              ->setDescription('Processes the schema and either create it directly on EntityManager Storage Connection or generate the SQL output')
@@ -43,7 +40,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas, SymfonyStyle $ui)
+    protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas, SymfonyStyle $ui): int
     {
         $dumpSql = $input->getOption('dump-sql') === true;
 
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/SchemaTool/DropCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/SchemaTool/DropCommand.php
@@ -20,10 +20,7 @@
  */
 class DropCommand extends AbstractCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:schema-tool:drop')
              ->setDescription('Drop the complete database schema of EntityManager Storage Connection or generate the corresponding SQL output')
@@ -47,7 +44,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas, SymfonyStyle $ui)
+    protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas, SymfonyStyle $ui): int
     {
         $isFullDatabaseDrop = $input->getOption('full-database');
         $dumpSql            = $input->getOption('dump-sql') === true;
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/SchemaTool/UpdateCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/SchemaTool/UpdateCommand.php
@@ -24,10 +24,7 @@ class UpdateCommand extends AbstractCommand
     /** @var string */
     protected $name = 'orm:schema-tool:update';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName($this->name)
              ->setDescription('Executes (or dumps) the SQL needed to update the database schema to match the current mapping metadata')
@@ -71,7 +68,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas, SymfonyStyle $ui)
+    protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas, SymfonyStyle $ui): int
     {
         // Defining if update is complete or not (--complete not defined means $saveMode = true)
         $saveMode = ! $input->getOption('complete');
diff --git a/lib/Doctrine/ORM/Tools/Console/Command/ValidateSchemaCommand.php b/lib/Doctrine/ORM/Tools/Console/Command/ValidateSchemaCommand.php
@@ -19,10 +19,7 @@
  */
 class ValidateSchemaCommand extends AbstractEntityManagerCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('orm:validate-schema')
              ->setDescription('Validate the mapping files')
@@ -32,12 +29,7 @@ protected function configure()
              ->setHelp('Validate that the mapping files are correct and in sync with the database.');
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $ui = new SymfonyStyle($input, $output);
 
diff --git a/lib/Doctrine/ORM/Tools/Console/ConsoleRunner.php b/lib/Doctrine/ORM/Tools/Console/ConsoleRunner.php
diff --git a/lib/Doctrine/ORM/Tools/Console/EntityManagerProvider/ConnectionFromManagerProvider.php b/lib/Doctrine/ORM/Tools/Console/EntityManagerProvider/ConnectionFromManagerProvider.php
diff --git a/lib/Doctrine/ORM/Tools/Console/EntityManagerProvider/HelperSetManagerProvider.php b/lib/Doctrine/ORM/Tools/Console/EntityManagerProvider/HelperSetManagerProvider.php
diff --git a/lib/Doctrine/ORM/Tools/Console/EntityManagerProvider/SingleManagerProvider.php b/lib/Doctrine/ORM/Tools/Console/EntityManagerProvider/SingleManagerProvider.php
diff --git a/lib/Doctrine/ORM/Tools/Console/Helper/EntityManagerHelper.php b/lib/Doctrine/ORM/Tools/Console/Helper/EntityManagerHelper.php
diff --git a/lib/Doctrine/ORM/Tools/Console/MetadataFilter.php b/lib/Doctrine/ORM/Tools/Console/MetadataFilter.php
diff --git a/psalm-baseline.xml b/psalm-baseline.xml

Original file line number	Diff line number	Diff line change
`@@ -12,14 +12,9 @@`
`12`	`12`
`13`	`13`	`abstract class AbstractEntityManagerCommand extends Command`
`14`	`14`	`{`
`15`		`- /** @var EntityManagerProvider\|null */`
`16`		`- private $entityManagerProvider;`
`17`		`-`
`18`		`- public function __construct(?EntityManagerProvider $entityManagerProvider = null)`
	`15`	`+ public function __construct(private ?EntityManagerProvider $entityManagerProvider = null)`
`19`	`16`	`{`
`20`	`17`	`parent::__construct();`
`21`		`-`
`22`		`- $this->entityManagerProvider = $entityManagerProvider;`
`23`	`18`	`}`
`24`	`19`
`25`	`20`	`final protected function getEntityManager(InputInterface $input): EntityManagerInterface`
Original file line number	Diff line number	Diff line change
`@@ -20,10 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`class CollectionRegionCommand extends AbstractEntityManagerCommand`
`22`	`22`	`{`
`23`		`- /**`
`24`		`- * {@inheritdoc}`
`25`		`- */`
`26`		`- protected function configure()`
	`23`	`+ protected function configure(): void`
`27`	`24`	`{`
`28`	`25`	`$this->setName('orm:clear-cache:region:collection')`
`29`	`26`	`->setDescription('Clear a second-level cache collection region')`
`@@ -60,12 +57,7 @@ protected function configure()`
`60`	`57`	`);`
`61`	`58`	`}`
`62`	`59`
`63`		`- /**`
`64`		`- * {@inheritdoc}`
`65`		`- *`
`66`		`- * @return int`
`67`		`- */`
`68`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`60`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`69`	`61`	`{`
`70`	`62`	`$ui = new SymfonyStyle($input, $output);`
`71`	`63`
Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,7 @@`
`18`	`18`	`*/`
`19`	`19`	`class MetadataCommand extends AbstractEntityManagerCommand`
`20`	`20`	`{`
`21`		`- /**`
`22`		`- * {@inheritdoc}`
`23`		`- */`
`24`		`- protected function configure()`
	`21`	`+ protected function configure(): void`
`25`	`22`	`{`
`26`	`23`	`$this->setName('orm:clear-cache:metadata')`
`27`	`24`	`->setDescription('Clear all metadata cache of the various cache drivers')`
`@@ -33,12 +30,7 @@ protected function configure()`
`33`	`30`	`);`
`34`	`31`	`}`
`35`	`32`
`36`		`- /**`
`37`		`- * {@inheritdoc}`
`38`		`- *`
`39`		`- * @return int`
`40`		`- */`
`41`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`33`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`42`	`34`	`{`
`43`	`35`	`$ui = new SymfonyStyle($input, $output);`
`44`	`36`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,7 @@`
`27`	`27`	`*/`
`28`	`28`	`class QueryCommand extends AbstractEntityManagerCommand`
`29`	`29`	`{`
`30`		`- /**`
`31`		`- * {@inheritdoc}`
`32`		`- */`
`33`		`- protected function configure()`
	`30`	`+ protected function configure(): void`
`34`	`31`	`{`
`35`	`32`	`$this->setName('orm:clear-cache:query')`
`36`	`33`	`->setDescription('Clear all query cache of the various cache drivers')`
`@@ -56,12 +53,7 @@ protected function configure()`
`56`	`53`	`);`
`57`	`54`	`}`
`58`	`55`
`59`		`- /**`
`60`		`- * {@inheritdoc}`
`61`		`- *`
`62`		`- * @return int`
`63`		`- */`
`64`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`56`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`65`	`57`	`{`
`66`	`58`	`$ui = new SymfonyStyle($input, $output);`
`67`	`59`
Original file line number	Diff line number	Diff line change
`@@ -29,10 +29,7 @@`
`29`	`29`	`*/`
`30`	`30`	`class ResultCommand extends AbstractEntityManagerCommand`
`31`	`31`	`{`
`32`		`- /**`
`33`		`- * {@inheritdoc}`
`34`		`- */`
`35`		`- protected function configure()`
	`32`	`+ protected function configure(): void`
`36`	`33`	`{`
`37`	`34`	`$this->setName('orm:clear-cache:result')`
`38`	`35`	`->setDescription('Clear all result cache of the various cache drivers')`
`@@ -58,12 +55,7 @@ protected function configure()`
`58`	`55`	`);`
`59`	`56`	`}`
`60`	`57`
`61`		`- /**`
`62`		`- * {@inheritdoc}`
`63`		`- *`
`64`		`- * @return int`
`65`		`- */`
`66`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`58`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`67`	`59`	`{`
`68`	`60`	`$ui = new SymfonyStyle($input, $output);`
`69`	`61`
Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,7 @@`
`26`	`26`	`*/`
`27`	`27`	`class GenerateProxiesCommand extends AbstractEntityManagerCommand`
`28`	`28`	`{`
`29`		`- /**`
`30`		`- * {@inheritdoc}`
`31`		`- */`
`32`		`- protected function configure()`
	`29`	`+ protected function configure(): void`
`33`	`30`	`{`
`34`	`31`	`$this->setName('orm:generate-proxies')`
`35`	`32`	`->setAliases(['orm:generate:proxies'])`
`@@ -40,12 +37,7 @@ protected function configure()`
`40`	`37`	`->setHelp('Generates proxy classes for entity classes.');`
`41`	`38`	`}`
`42`	`39`
`43`		`- /**`
`44`		`- * {@inheritdoc}`
`45`		`- *`
`46`		`- * @return int`
`47`		`- */`
`48`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`40`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`49`	`41`	`{`
`50`	`42`	`$ui = new SymfonyStyle($input, $output);`
`51`	`43`