vendor/doctrine/migrations/lib/Doctrine/Migrations/Finder/Finder.php line 24

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.     /**
  30.      * @throws InvalidDirectory
  31.      */
  32.     protected function getRealPath(string $directory): string
  33.     {
  34.         $dir = realpath($directory);
  36.         if ($dir === false || ! is_dir($dir)) {
  37.             throw InvalidDirectory::new($directory);
  38.         }
  40.         return $dir;
  41.     }
  43.     /**
  44.      * @param string[] $files
  45.      *
  46.      * @return string[]
  47.      *
  48.      * @throws NameIsReserved
  49.      */
  50.     protected function loadMigrations(array $files, ?string $namespace): array
  51.     {
  52.         $includedFiles = [];
  53.         foreach ($files as $file) {
  54.             static::requireOnce($file);
  56.             $realFile = realpath($file);
  57.             assert($realFile !== false);
  59.             $includedFiles[] = $realFile;
  60.         }
  62.         $classes  = $this->loadMigrationClasses($includedFiles, $namespace);
  63.         $versions = [];
  64.         foreach ($classes as $class) {
  65.             $versions[] = $class->getName();
  66.         }
  68.         return $versions;
  69.     }
  71.     /**
  72.      * Look up all declared classes and find those classes contained
  73.      * in the given `$files` array.
  74.      *
  75.      * @param string[]    $files     The set of files that were `required`
  76.      * @param string|null $namespace If not null only classes in this namespace will be returned
  77.      *
  78.      * @return ReflectionClass<object>[] the classes in `$files`
  79.      */
  80.     protected function loadMigrationClasses(array $files, ?string $namespace = null): array
  81.     {
  82.         $classes = [];
  83.         foreach (get_declared_classes() as $class) {
  84.             $reflectionClass = new ReflectionClass($class);
  86.             if (! in_array($reflectionClass->getFileName(), $files, true)) {
  87.                 continue;
  88.             }
  90.             if ($namespace !== null && ! $this->isReflectionClassInNamespace($reflectionClass, $namespace)) {
  91.                 continue;
  92.             }
  94.             $classes[] = $reflectionClass;
  95.         }
  97.         return $classes;
  98.     }
  100.     /**
  101.      * @param ReflectionClass<object> $reflectionClass
  102.      */
  103.     private function isReflectionClassInNamespace(ReflectionClass $reflectionClass, string $namespace): bool
  104.     {
  105.         return strncmp($reflectionClass->getName(), $namespace . '\\', strlen($namespace) + 1) === 0;
  106.     }
  107. }