vendor/doctrine/migrations/lib/Doctrine/Migrations/FilesystemMigrationsRepository.php line 90

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\Migrations;
  7. use Doctrine\Migrations\Exception\DuplicateMigrationVersion;
  8. use Doctrine\Migrations\Exception\MigrationClassNotFound;
  9. use Doctrine\Migrations\Exception\MigrationException;
  10. use Doctrine\Migrations\Finder\MigrationFinder;
  11. use Doctrine\Migrations\Metadata\AvailableMigration;
  12. use Doctrine\Migrations\Metadata\AvailableMigrationsSet;
  13. use Doctrine\Migrations\Version\MigrationFactory;
  14. use Doctrine\Migrations\Version\Version;
  16. use function class_exists;
  18. /**
  19.  * The FilesystemMigrationsRepository class is responsible for retrieving migrations, determining what the current migration
  20.  * version, etc.
  21.  *
  22.  * @internal
  23.  */
  24. class FilesystemMigrationsRepository implements MigrationsRepository
  25. {
  26.     private bool $migrationsLoaded = false;
  28.     /** @var array<string, string> */
  29.     private array $migrationDirectories;
  31.     private MigrationFinder $migrationFinder;
  33.     private MigrationFactory $versionFactory;
  35.     /** @var AvailableMigration[] */
  36.     private array $migrations = [];
  38.     /**
  39.      * @param string[]              $classes
  40.      * @param array<string, string> $migrationDirectories
  41.      */
  42.     public function __construct(
  43.         array $classes,
  44.         array $migrationDirectories,
  45.         MigrationFinder $migrationFinder,
  46.         MigrationFactory $versionFactory
  47.     ) {
  48.         $this->migrationDirectories = $migrationDirectories;
  49.         $this->migrationFinder      = $migrationFinder;
  50.         $this->versionFactory       = $versionFactory;
  52.         $this->registerMigrations($classes);
  53.     }
  55.     private function registerMigrationInstance(Version $version, AbstractMigration $migration): AvailableMigration
  56.     {
  57.         if (isset($this->migrations[(string) $version])) {
  58.             throw DuplicateMigrationVersion::new(
  59.                 (string) $version,
  60.                 (string) $version
  61.             );
  62.         }
  64.         $this->migrations[(string) $version] = new AvailableMigration($version, $migration);
  66.         return $this->migrations[(string) $version];
  67.     }
  69.     /** @throws MigrationException */
  70.     public function registerMigration(string $migrationClassName): AvailableMigration
  71.     {
  72.         $this->ensureMigrationClassExists($migrationClassName);
  74.         $version   = new Version($migrationClassName);
  75.         $migration = $this->versionFactory->createVersion($migrationClassName);
  77.         return $this->registerMigrationInstance($version, $migration);
  78.     }
  80.     /**
  81.      * @param string[] $migrations
  82.      *
  83.      * @return AvailableMigration[]
  84.      */
  85.     private function registerMigrations(array $migrations): array
  86.     {
  87.         $versions = [];
  89.         foreach ($migrations as $class) {
  90.             $versions[] = $this->registerMigration($class);
  91.         }
  93.         return $versions;
  94.     }
  96.     public function hasMigration(string $version): bool
  97.     {
  98.         $this->loadMigrationsFromDirectories();
  100.         return isset($this->migrations[$version]);
  101.     }
  103.     public function getMigration(Version $version): AvailableMigration
  104.     {
  105.         $this->loadMigrationsFromDirectories();
  107.         if (! isset($this->migrations[(string) $version])) {
  108.             throw MigrationClassNotFound::new((string) $version);
  109.         }
  111.         return $this->migrations[(string) $version];
  112.     }
  114.     /**
  115.      * Returns a non-sorted set of migrations.
  116.      */
  117.     public function getMigrations(): AvailableMigrationsSet
  118.     {
  119.         $this->loadMigrationsFromDirectories();
  121.         return new AvailableMigrationsSet($this->migrations);
  122.     }
  124.     /** @throws MigrationException */
  125.     private function ensureMigrationClassExists(string $class): void
  126.     {
  127.         if (! class_exists($class)) {
  128.             throw MigrationClassNotFound::new($class);
  129.         }
  130.     }
  132.     private function loadMigrationsFromDirectories(): void
  133.     {
  134.         $migrationDirectories = $this->migrationDirectories;
  136.         if ($this->migrationsLoaded) {
  137.             return;
  138.         }
  140.         $this->migrationsLoaded = true;
  142.         foreach ($migrationDirectories as $namespace => $path) {
  143.                 $migrations = $this->migrationFinder->findMigrations(
  144.                     $path,
  145.                     $namespace
  146.                 );
  147.                 $this->registerMigrations($migrations);
  148.         }
  149.     }
  150. }