[11.x] Enhance doc blocks of the Migrator class (#52033)

* Enhance doc blocks of the Migrator.php

* Convert closures to arrow functions

Author: imanghafoori1

src/Illuminate/Database/Console/Migrations/BaseCommand.php

@@ -9,7 +9,7 @@ class BaseCommand extends Command
     /**
      * Get all of the migration paths.
      *
-     * @return array
+     * @return string[]
      */
     protected function getMigrationPaths()
     {

src/Illuminate/Database/Migrations/Migrator.php

@@ -60,7 +60,7 @@ class Migrator
     /**
      * The paths to all of the migration files.
      *
-     * @var array
+     * @var string[]
      */
     protected $paths = [];
 
@@ -101,9 +101,9 @@ public function __construct(MigrationRepositoryInterface $repository,
     /**
      * Run the pending migrations at a given path.
      *
-     * @param  array|string  $paths
-     * @param  array  $options
-     * @return array
+     * @param  string[]|string  $paths
+     * @param  array<string, mixed>  $options
+     * @return string[]
      */
     public function run($paths = [], array $options = [])
     {
@@ -127,23 +127,23 @@ public function run($paths = [], array $options = [])
     /**
      * Get the migration files that have not yet run.
      *
-     * @param  array  $files
-     * @param  array  $ran
-     * @return array
+     * @param  string[]  $files
+     * @param  string[]  $ran
+     * @return string[]
      */
     protected function pendingMigrations($files, $ran)
     {
         return Collection::make($files)
-                ->reject(function ($file) use ($ran) {
-                    return in_array($this->getMigrationName($file), $ran);
-                })->values()->all();
+            ->reject(fn ($file) => in_array($this->getMigrationName($file), $ran))
+            ->values()
+            ->all();
     }
 
     /**
      * Run an array of migrations.
      *
-     * @param  array  $migrations
-     * @param  array  $options
+     * @param  string[]  $migrations
+     * @param  array<string, mixed>  $options
      * @return void
      */
     public function runPending(array $migrations, array $options = [])
@@ -220,9 +220,9 @@ protected function runUp($file, $batch, $pretend)
     /**
      * Rollback the last migration operation.
      *
-     * @param  array|string  $paths
-     * @param  array  $options
-     * @return array
+     * @param  string[]|string  $paths
+     * @param  array<string, mixed>  $options
+     * @return string[]
      */
     public function rollback($paths = [], array $options = [])
     {
@@ -247,7 +247,7 @@ public function rollback($paths = [], array $options = [])
     /**
      * Get the migrations for a rollback operation.
      *
-     * @param  array  $options
+     * @param  array<string, mixed>  $options
      * @return array
      */
     protected function getMigrationsForRollback(array $options)
@@ -267,9 +267,9 @@ protected function getMigrationsForRollback(array $options)
      * Rollback the given migrations.
      *
      * @param  array  $migrations
-     * @param  array|string  $paths
-     * @param  array  $options
-     * @return array
+     * @param  string[]|string  $paths
+     * @param  array<string, mixed>  $options
+     * @return string[]
      */
     protected function rollbackMigrations(array $migrations, $paths, array $options)
     {
@@ -309,7 +309,7 @@ protected function rollbackMigrations(array $migrations, $paths, array $options)
     /**
      * Rolls all of the currently applied migrations back.
      *
-     * @param  array|string  $paths
+     * @param  string[]|string  $paths
      * @param  bool  $pretend
      * @return array
      */
@@ -334,8 +334,8 @@ public function reset($paths = [], $pretend = false)
     /**
      * Reset the given migrations.
      *
-     * @param  array  $migrations
-     * @param  array  $paths
+     * @param  string[]  $migrations
+     * @param  string[]  $paths
      * @param  bool  $pretend
      * @return array
      */
@@ -344,9 +344,7 @@ protected function resetMigrations(array $migrations, array $paths, $pretend = f
         // Since the getRan method that retrieves the migration name just gives us the
         // migration name, we will format the names into objects with the name as a
         // property on the objects so that we can pass it to the rollback method.
-        $migrations = collect($migrations)->map(function ($m) {
-            return (object) ['migration' => $m];
-        })->all();
+        $migrations = collect($migrations)->map(fn ($m) => (object) ['migration' => $m])->all();
 
         return $this->rollbackMigrations(
             $migrations, $paths, compact('pretend')
@@ -430,9 +428,10 @@ protected function pretendToRun($migration, $method)
 
         $this->write(TwoColumnDetail::class, $name);
 
-        $this->write(BulletList::class, collect($this->getQueries($migration, $method))->map(function ($query) {
-            return $query['query'];
-        }));
+        $this->write(
+            BulletList::class,
+            collect($this->getQueries($migration, $method))->map(fn ($query) => $query['query'])
+        );
     }
 
     /**
@@ -532,23 +531,23 @@ protected function getMigrationClass(string $migrationName): string
      * Get all of the migration files in a given path.
      *
      * @param  string|array  $paths
-     * @return array
+     * @return array<string, string>
      */
     public function getMigrationFiles($paths)
     {
-        return Collection::make($paths)->flatMap(function ($path) {
-            return str_ends_with($path, '.php') ? [$path] : $this->files->glob($path.'/*_*.php');
-        })->filter()->values()->keyBy(function ($file) {
-            return $this->getMigrationName($file);
-        })->sortBy(function ($file, $key) {
-            return $key;
-        })->all();
+        return Collection::make($paths)
+            ->flatMap(fn ($path) => str_ends_with($path, '.php') ? [$path] : $this->files->glob($path.'/*_*.php'))
+            ->filter()
+            ->values()
+            ->keyBy(fn ($file) => $this->getMigrationName($file))
+            ->sortBy(fn ($file, $key) => $key)
+            ->all();
     }
 
     /**
      * Require in all the migration files in a given path.
      *
-     * @param  array  $files
+     * @param  string[]  $files
      * @return void
      */
     public function requireFiles(array $files)
@@ -583,7 +582,7 @@ public function path($path)
     /**
      * Get all of the custom migration paths.
      *
-     * @return array
+     * @return string[]
      */
     public function paths()
     {
@@ -613,9 +612,7 @@ public function usingConnection($name, callable $callback)
 
         $this->setConnection($name);
 
-        return tap($callback(), function () use ($previousConnection) {
-            $this->setConnection($previousConnection);
-        });
+        return tap($callback(), fn () => $this->setConnection($previousConnection));
     }
 
     /**