Modernize codebase for PHP 8

doctrine · Aug 18, 2023 · 5be5221 · 5be5221
1 parent 2dcf355
commit 5be5221
Show file tree

Hide file tree

Showing 108 changed files with 501 additions and 944 deletions.
diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml
@@ -26,4 +26,4 @@ on:
 jobs:
   coding-standards:
     name: "Coding Standards"
-    uses: "doctrine/.github/.github/workflows/coding-standards.yml@2.1.0"
+    uses: "doctrine/.github/.github/workflows/coding-standards.yml@3.0.0"
diff --git a/lib/Doctrine/Migrations/AbstractMigration.php b/lib/Doctrine/Migrations/AbstractMigration.php
@@ -33,17 +33,14 @@ abstract class AbstractMigration
     /** @var AbstractPlatform */
     protected $platform;
 
-    private LoggerInterface $logger;
-
     /** @var Query[] */
     private array $plannedSql = [];
 
-    public function __construct(Connection $connection, LoggerInterface $logger)
+    public function __construct(Connection $connection, private readonly LoggerInterface $logger)
     {
         $this->connection = $connection;
         $this->sm         = $this->connection->createSchemaManager();
         $this->platform   = $this->connection->getDatabasePlatform();
-        $this->logger     = $logger;
     }
 
     /**
@@ -126,7 +123,7 @@ public function down(Schema $schema): void
     protected function addSql(
         string $sql,
         array $params = [],
-        array $types = []
+        array $types = [],
     ): void {
         $this->plannedSql[] = new Query($sql, $params, $types);
     }
@@ -143,7 +140,7 @@ protected function write(string $message): void
     }
 
     /** @throws IrreversibleMigration */
-    protected function throwIrreversibleMigrationException(?string $message = null): void
+    protected function throwIrreversibleMigrationException(string|null $message = null): void
     {
         if ($message === null) {
             $message = 'This migration is irreversible and cannot be reverted.';

diff --git a/lib/Doctrine/Migrations/Configuration/Configuration.php b/lib/Doctrine/Migrations/Configuration/Configuration.php
@@ -30,21 +30,21 @@ final class Configuration
 
     private bool $migrationsAreOrganizedByYearAndMonth = false;
 
-    private ?string $customTemplate = null;
+    private string|null $customTemplate = null;
 
     private bool $isDryRun = false;
 
     private bool $allOrNothing = false;
 
     private bool $transactional = true;
 
-    private ?string $connectionName = null;
+    private string|null $connectionName = null;
 
-    private ?string $entityManagerName = null;
+    private string|null $entityManagerName = null;
 
     private bool $checkDbPlatform = true;
 
-    private ?MetadataStorageConfiguration $metadataStorageConfiguration = null;
+    private MetadataStorageConfiguration|null $metadataStorageConfiguration = null;
 
     private bool $frozen = false;
 
@@ -78,7 +78,7 @@ public function addMigrationClass(string $className): void
         $this->migrationClasses[] = $className;
     }
 
-    public function getMetadataStorageConfiguration(): ?MetadataStorageConfiguration
+    public function getMetadataStorageConfiguration(): MetadataStorageConfiguration|null
     {
         return $this->metadataStorageConfiguration;
     }
@@ -95,35 +95,35 @@ public function getMigrationDirectories(): array
         return $this->migrationsDirectories;
     }
 
-    public function getConnectionName(): ?string
+    public function getConnectionName(): string|null
     {
         return $this->connectionName;
     }
 
-    public function setConnectionName(?string $connectionName): void
+    public function setConnectionName(string|null $connectionName): void
     {
         $this->assertNotFrozen();
         $this->connectionName = $connectionName;
     }
 
-    public function getEntityManagerName(): ?string
+    public function getEntityManagerName(): string|null
     {
         return $this->entityManagerName;
     }
 
-    public function setEntityManagerName(?string $entityManagerName): void
+    public function setEntityManagerName(string|null $entityManagerName): void
     {
         $this->assertNotFrozen();
         $this->entityManagerName = $entityManagerName;
     }
 
-    public function setCustomTemplate(?string $customTemplate): void
+    public function setCustomTemplate(string|null $customTemplate): void
     {
         $this->assertNotFrozen();
         $this->customTemplate = $customTemplate;
     }
 
-    public function getCustomTemplate(): ?string
+    public function getCustomTemplate(): string|null
     {
         return $this->customTemplate;
     }
@@ -135,15 +135,15 @@ public function areMigrationsOrganizedByYear(): bool
 
     /** @throws MigrationException */
     public function setMigrationsAreOrganizedByYear(
-        bool $migrationsAreOrganizedByYear = true
+        bool $migrationsAreOrganizedByYear = true,
     ): void {
         $this->assertNotFrozen();
         $this->migrationsAreOrganizedByYear = $migrationsAreOrganizedByYear;
     }
 
     /** @throws MigrationException */
     public function setMigrationsAreOrganizedByYearAndMonth(
-        bool $migrationsAreOrganizedByYearAndMonth = true
+        bool $migrationsAreOrganizedByYearAndMonth = true,
     ): void {
         $this->assertNotFrozen();
         $this->migrationsAreOrganizedByYear         = $migrationsAreOrganizedByYearAndMonth;
@@ -202,18 +202,11 @@ public function setMigrationOrganization(string $migrationOrganization): void
     {
         $this->assertNotFrozen();
 
-        switch (strtolower($migrationOrganization)) {
-            case self::VERSIONS_ORGANIZATION_NONE:
-                $this->setMigrationsAreOrganizedByYearAndMonth(false);
-                break;
-            case self::VERSIONS_ORGANIZATION_BY_YEAR:
-                $this->setMigrationsAreOrganizedByYear();
-                break;
-            case self::VERSIONS_ORGANIZATION_BY_YEAR_AND_MONTH:
-                $this->setMigrationsAreOrganizedByYearAndMonth();
-                break;
-            default:
-                throw UnknownConfigurationValue::new('organize_migrations', $migrationOrganization);
-        }
+        match (strtolower($migrationOrganization)) {
+            self::VERSIONS_ORGANIZATION_NONE => $this->setMigrationsAreOrganizedByYearAndMonth(false),
+            self::VERSIONS_ORGANIZATION_BY_YEAR => $this->setMigrationsAreOrganizedByYear(),
+            self::VERSIONS_ORGANIZATION_BY_YEAR_AND_MONTH => $this->setMigrationsAreOrganizedByYearAndMonth(),
+            default => throw UnknownConfigurationValue::new('organize_migrations', $migrationOrganization),
+        };
     }
 }
diff --git a/lib/Doctrine/Migrations/Configuration/Connection/ConfigurationFile.php b/lib/Doctrine/Migrations/Configuration/Connection/ConfigurationFile.php
@@ -18,14 +18,11 @@
  */
 final class ConfigurationFile implements ConnectionLoader
 {
-    private string $filename;
-
-    public function __construct(string $filename)
+    public function __construct(private readonly string $filename)
     {
-        $this->filename = $filename;
     }
 
-    public function getConnection(?string $name = null): Connection
+    public function getConnection(string|null $name = null): Connection
     {
         if ($name !== null) {
             throw new InvalidArgumentException('Only one connection is supported');

diff --git a/lib/Doctrine/Migrations/Configuration/Connection/ConnectionLoader.php b/lib/Doctrine/Migrations/Configuration/Connection/ConnectionLoader.php
@@ -19,5 +19,5 @@ interface ConnectionLoader
      *
      * @throws ConnectionNotSpecified
      */
-    public function getConnection(?string $name = null): Connection;
+    public function getConnection(string|null $name = null): Connection;
 }
diff --git a/lib/Doctrine/Migrations/Configuration/Connection/ConnectionRegistryConnection.php b/lib/Doctrine/Migrations/Configuration/Connection/ConnectionRegistryConnection.php
@@ -12,9 +12,9 @@ final class ConnectionRegistryConnection implements ConnectionLoader
 {
     private ConnectionRegistry $registry;
 
-    private ?string $defaultConnectionName = null;
+    private string|null $defaultConnectionName = null;
 
-    public static function withSimpleDefault(ConnectionRegistry $registry, ?string $connectionName = null): self
+    public static function withSimpleDefault(ConnectionRegistry $registry, string|null $connectionName = null): self
     {
         $that                        = new self();
         $that->registry              = $registry;
@@ -27,7 +27,7 @@ private function __construct()
     {
     }
 
-    public function getConnection(?string $name = null): Connection
+    public function getConnection(string|null $name = null): Connection
     {
         $connection = $this->registry->getConnection($name ?? $this->defaultConnectionName);
         if (! $connection instanceof Connection) {

diff --git a/lib/Doctrine/Migrations/Configuration/Connection/Exception/InvalidConfiguration.php b/lib/Doctrine/Migrations/Configuration/Connection/Exception/InvalidConfiguration.php
@@ -7,7 +7,7 @@
 use Doctrine\DBAL\Connection;
 use InvalidArgumentException;
 
-use function get_class;
+use function get_debug_type;
 use function sprintf;
 
 final class InvalidConfiguration extends InvalidArgumentException implements LoaderException
@@ -19,6 +19,10 @@ public static function invalidArrayConfiguration(): self
 
     public static function invalidConnectionType(object $connection): self
     {
-        return new self(sprintf('The returned connection must be a %s instance, %s returned.', Connection::class, get_class($connection)));
+        return new self(sprintf(
+            'The returned connection must be a %s instance, %s returned.',
+            Connection::class,
+            get_debug_type($connection),
+        ));
     }
 }
diff --git a/lib/Doctrine/Migrations/Configuration/Connection/ExistingConnection.php b/lib/Doctrine/Migrations/Configuration/Connection/ExistingConnection.php
@@ -9,14 +9,11 @@
 
 final class ExistingConnection implements ConnectionLoader
 {
-    private Connection $connection;
-
-    public function __construct(Connection $connection)
+    public function __construct(private readonly Connection $connection)
     {
-        $this->connection = $connection;
     }
 
-    public function getConnection(?string $name = null): Connection
+    public function getConnection(string|null $name = null): Connection
     {
         if ($name !== null) {
             throw InvalidLoader::noMultipleConnections($this);

diff --git a/lib/Doctrine/Migrations/Configuration/EntityManager/ConfigurationFile.php b/lib/Doctrine/Migrations/Configuration/EntityManager/ConfigurationFile.php
@@ -16,11 +16,8 @@
  */
 final class ConfigurationFile implements EntityManagerLoader
 {
-    private string $filename;
-
-    public function __construct(string $filename)
+    public function __construct(private readonly string $filename)
     {
-        $this->filename = $filename;
     }
 
     /**
@@ -29,7 +26,7 @@ public function __construct(string $filename)
      *
      * @throws InvalidConfiguration
      */
-    public function getEntityManager(?string $name = null): EntityManagerInterface
+    public function getEntityManager(string|null $name = null): EntityManagerInterface
     {
         if ($name !== null) {
             throw new InvalidArgumentException('Only one connection is supported');

diff --git a/lib/Doctrine/Migrations/Configuration/EntityManager/EntityManagerLoader.php b/lib/Doctrine/Migrations/Configuration/EntityManager/EntityManagerLoader.php
@@ -14,5 +14,5 @@
  */
 interface EntityManagerLoader
 {
-    public function getEntityManager(?string $name = null): EntityManagerInterface;
+    public function getEntityManager(string|null $name = null): EntityManagerInterface;
 }
diff --git a/lib/Doctrine/Migrations/Configuration/EntityManager/Exception/InvalidConfiguration.php b/lib/Doctrine/Migrations/Configuration/EntityManager/Exception/InvalidConfiguration.php
@@ -7,7 +7,7 @@
 use Doctrine\ORM\EntityManagerInterface;
 use InvalidArgumentException;
 
-use function get_class;
+use function get_debug_type;
 use function sprintf;
 
 final class InvalidConfiguration extends InvalidArgumentException implements LoaderException
@@ -19,6 +19,10 @@ public static function invalidArrayConfiguration(): self
 
     public static function invalidManagerType(object $em): self
     {
-        return new self(sprintf('The returned manager must implement %s, %s returned.', EntityManagerInterface::class, get_class($em)));
+        return new self(sprintf(
+            'The returned manager must implement %s, %s returned.',
+            EntityManagerInterface::class,
+            get_debug_type($em),
+        ));
     }
 }
diff --git a/lib/Doctrine/Migrations/Configuration/EntityManager/ExistingEntityManager.php b/lib/Doctrine/Migrations/Configuration/EntityManager/ExistingEntityManager.php
@@ -9,14 +9,11 @@
 
 final class ExistingEntityManager implements EntityManagerLoader
 {
-    private EntityManagerInterface $entityManager;
-
-    public function __construct(EntityManagerInterface $entityManager)
+    public function __construct(private readonly EntityManagerInterface $entityManager)
     {
-        $this->entityManager = $entityManager;
     }
 
-    public function getEntityManager(?string $name = null): EntityManagerInterface
+    public function getEntityManager(string|null $name = null): EntityManagerInterface
     {
         if ($name !== null) {
             throw InvalidLoader::noMultipleEntityManagers($this);

diff --git a/lib/Doctrine/Migrations/Configuration/EntityManager/ManagerRegistryEntityManager.php b/lib/Doctrine/Migrations/Configuration/EntityManager/ManagerRegistryEntityManager.php
@@ -12,9 +12,9 @@ final class ManagerRegistryEntityManager implements EntityManagerLoader
 {
     private ManagerRegistry $registry;
 
-    private ?string $defaultManagerName = null;
+    private string|null $defaultManagerName = null;
 
-    public static function withSimpleDefault(ManagerRegistry $registry, ?string $managerName = null): self
+    public static function withSimpleDefault(ManagerRegistry $registry, string|null $managerName = null): self
     {
         $that                     = new self();
         $that->registry           = $registry;
@@ -27,7 +27,7 @@ private function __construct()
     {
     }
 
-    public function getEntityManager(?string $name = null): EntityManagerInterface
+    public function getEntityManager(string|null $name = null): EntityManagerInterface
     {
         $managerName = $name ?? $this->defaultManagerName;
 

diff --git a/lib/Doctrine/Migrations/Configuration/Exception/InvalidLoader.php b/lib/Doctrine/Migrations/Configuration/Exception/InvalidLoader.php
@@ -8,18 +8,24 @@
 use Doctrine\Migrations\Configuration\EntityManager\EntityManagerLoader;
 use InvalidArgumentException;
 
-use function get_class;
+use function get_debug_type;
 use function sprintf;
 
 final class InvalidLoader extends InvalidArgumentException implements ConfigurationException
 {
     public static function noMultipleConnections(ConnectionLoader $loader): self
     {
-        return new self(sprintf('Only one connection is supported by %s', get_class($loader)));
+        return new self(sprintf(
+            'Only one connection is supported by %s',
+            get_debug_type($loader),
+        ));
     }
 
     public static function noMultipleEntityManagers(EntityManagerLoader $loader): self
     {
-        return new self(sprintf('Only one entity manager is supported by %s', get_class($loader)));
+        return new self(sprintf(
+            'Only one entity manager is supported by %s',
+            get_debug_type($loader),
+        ));
     }
 }
diff --git a/lib/Doctrine/Migrations/Configuration/Exception/UnknownConfigurationValue.php b/lib/Doctrine/Migrations/Configuration/Exception/UnknownConfigurationValue.php
@@ -11,8 +11,7 @@
 
 final class UnknownConfigurationValue extends LogicException implements ConfigurationException
 {
-    /** @param mixed $value */
-    public static function new(string $key, $value): self
+    public static function new(string $key, mixed $value): self
     {
         return new self(
             sprintf(