vendor/doctrine/migrations/src/Finder/Finder.php line 26

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\Migrations\Finder;
  7. use Doctrine\Migrations\Finder\Exception\InvalidDirectory;
  8. use Doctrine\Migrations\Finder\Exception\NameIsReserved;
  9. use ReflectionClass;
  11. use function assert;
  12. use function get_declared_classes;
  13. use function in_array;
  14. use function is_dir;
  15. use function realpath;
  16. use function strlen;
  17. use function strncmp;
  19. /**
  20.  * The Finder class is responsible for for finding migrations on disk at a given path.
  21.  */
  22. abstract class Finder implements MigrationFinder
  23. {
  24.     protected static function requireOnce(string $path): void
  25.     {
  26.         require_once $path;
  27.     }
  29.     /** @throws InvalidDirectory */
  30.     protected function getRealPath(string $directory): string
  31.     {
  32.         $dir = realpath($directory);
  34.         if ($dir === false || ! is_dir($dir)) {
  35.             throw InvalidDirectory::new($directory);
  36.         }
  38.         return $dir;
  39.     }
  41.     /**
  42.      * @param string[] $files
  43.      *
  44.      * @return string[]
  45.      *
  46.      * @throws NameIsReserved
  47.      */
  48.     protected function loadMigrations(array $files, string|null $namespace): array
  49.     {
  50.         $includedFiles = [];
  51.         foreach ($files as $file) {
  52.             static::requireOnce($file);
  54.             $realFile = realpath($file);
  55.             assert($realFile !== false);
  57.             $includedFiles[] = $realFile;
  58.         }
  60.         $classes  = $this->loadMigrationClasses($includedFiles, $namespace);
  61.         $versions = [];
  62.         foreach ($classes as $class) {
  63.             $versions[] = $class->getName();
  64.         }
  66.         return $versions;
  67.     }
  69.     /**
  70.      * Look up all declared classes and find those classes contained
  71.      * in the given `$files` array.
  72.      *
  73.      * @param string[]    $files     The set of files that were `required`
  74.      * @param string|null $namespace If not null only classes in this namespace will be returned
  75.      *
  76.      * @return ReflectionClass<object>[] the classes in `$files`
  77.      */
  78.     protected function loadMigrationClasses(array $files, string|null $namespace = null): array
  79.     {
  80.         $classes = [];
  81.         foreach (get_declared_classes() as $class) {
  82.             $reflectionClass = new ReflectionClass($class);
  84.             if (! in_array($reflectionClass->getFileName(), $files, true)) {
  85.                 continue;
  86.             }
  88.             if ($namespace !== null && ! $this->isReflectionClassInNamespace($reflectionClass, $namespace)) {
  89.                 continue;
  90.             }
  92.             $classes[] = $reflectionClass;
  93.         }
  95.         return $classes;
  96.     }
  98.     /** @param ReflectionClass<object> $reflectionClass */
  99.     private function isReflectionClassInNamespace(ReflectionClass $reflectionClass, string $namespace): bool
  100.     {
  101.         return strncmp($reflectionClass->getName(), $namespace . '\\', strlen($namespace) + 1) === 0;
  102.     }
  103. }