Skip to content

[12.x] Allow Container to build Migrator from class name #55501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 22, 2025
Merged

[12.x] Allow Container to build Migrator from class name #55501

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
15d884a
allow building Migrator from class name
cosmastech Apr 21, 2025
032608e
bind Migrator
cosmastech Apr 21, 2025
3dff06b
remove unneeded change
cosmastech Apr 21, 2025
36f55c1
remove unneeded change
cosmastech Apr 21, 2025
a10bcc0
Update MigrationServiceProvider.php
taylorotwell Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/Illuminate/Database/MigrationServiceProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ protected function registerMigrator()

return new Migrator($repository, $app['db'], $app['files'], $app['events']);
});
$this->app->bind(Migrator::class, fn ($app) => $app['migrator']);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would use Container@alias instead of bind.

Besides saving a closure call, as Migrator::class would be an alias to migrator, and migrator is a singleton, it would be automatically considered the same singleton.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe I tried it with a container alias, but because it's a singleton, $app->forget('migrator') still keeps the aliases version in memory.

15d884a

https://github.com/laravel/framework/actions/runs/14579501724/job/40892877095

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is weird, maybe we need to call $this->getAlias($abstract) when forgetting instances, much like is done when forgetting extenders:

framework/src/Illuminate/Container/Container.php

Lines 1555 to 1564 in b6a2af2

/**
* Remove a resolved instance from the instance cache.
*
* @param string $abstract
* @return void
*/
public function forgetInstance($abstract)
{
unset($this->instances[$abstract]);
}

framework/src/Illuminate/Container/Container.php

Lines 1533 to 1542 in b6a2af2

/**
* Remove all of the extender callbacks for a given type.
*
* @param string $abstract
* @return void
*/
public function forgetExtenders($abstract)
{
unset($this->extenders[$this->getAlias($abstract)]);
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that makes sense, however, that definitely belongs in a separate PR. Also potentially a breaking-change?

}

/**
Expand Down Expand Up @@ -220,7 +221,7 @@ protected function registerMigrateStatusCommand()
public function provides()
{
return array_merge([
'migrator', 'migration.repository', 'migration.creator',
'migrator', 'migration.repository', 'migration.creator', Migrator::class,
], array_values($this->commands));
}
}
16 changes: 16 additions & 0 deletions tests/Integration/Database/MigrationServiceProviderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

namespace Illuminate\Tests\Integration\Database;

use Illuminate\Database\Migrations\Migrator;

class MigrationServiceProviderTest extends DatabaseTestCase
{
public function testContainerCanBuildMigrator()
{
$fromString = $this->app->make('migrator');
$fromClass = $this->app->make(Migrator::class);

$this->assertSame($fromString, $fromClass);
}
}