0

Final Class Yiisoft\Db\Migration\Command\HistoryCommand

All Classes | Methods
InheritanceYiisoft\Db\Migration\Command\HistoryCommand » Yiisoft\Db\Migration\Command\DatabaseCommand » Symfony\Component\Console\Command\Command

Displays the migration history.

This command will show the list of migrations that have been applied so far.

For example:

./yii migrate:history           # last 10 migrations
./yii migrate:history --limit=5 # last 5 migrations
./yii migrate:history --all     # whole history

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Db\Migration\Command\HistoryCommand

Protected Methods

Hide inherited methods

Method Description Defined By
configure() Yiisoft\Db\Migration\Command\HistoryCommand
createContext() Yiisoft\Db\Migration\Command\HistoryCommand
createDefaultContext() Yiisoft\Db\Migration\Command\HistoryCommand
execute() Yiisoft\Db\Migration\Command\DatabaseCommand
executeForDatabase() Yiisoft\Db\Migration\Command\HistoryCommand
getAvailableDatabaseNames() Yiisoft\Db\Migration\Command\DatabaseCommand
isMultipleDatabases() Yiisoft\Db\Migration\Command\DatabaseCommand
resolveDatabaseNamesWithMissingOption() Yiisoft\Db\Migration\Command\HistoryCommand

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( Yiisoft\Db\Migration\Service\MigrationService $migrationService, Yiisoft\Db\Migration\Migrator $migrator, ?\Yiisoft\Db\Migration\DatabaseRegistry $additionalDatabases = null )
$migrationService Yiisoft\Db\Migration\Service\MigrationService
$migrator Yiisoft\Db\Migration\Migrator
$additionalDatabases ?\Yiisoft\Db\Migration\DatabaseRegistry 

                public function __construct(
    private readonly MigrationService $migrationService,
    private readonly Migrator $migrator,
    ?DatabaseRegistry $additionalDatabases = null,
) {
    parent::__construct($additionalDatabases);
}
configure() protected method

protected void configure ( )

                protected function configure(): void
{
    $this
        ->addOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Number of migrations to display.', 10)
        ->addOption('all', 'a', InputOption::VALUE_NONE, 'All migrations.');
}
createContext() protected method

protected Yiisoft\Db\Migration\Command\Context\MigrationContext createContext ( Yiisoft\Db\Migration\DatabaseSetup $setup )
$setup Yiisoft\Db\Migration\DatabaseSetup 

                protected function createContext(DatabaseSetup $setup): MigrationContext
{
    return new MigrationContext($setup->migrator, $setup->migrationService);
}
createDefaultContext() protected method

protected Yiisoft\Db\Migration\Command\Context\MigrationContext createDefaultContext ( )

                protected function createDefaultContext(): MigrationContext
{
    return new MigrationContext($this->migrator, $this->migrationService);
}
execute() protected method

Defined in: Yiisoft\Db\Migration\Command\DatabaseCommand::execute()

protected integer execute ( \Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output )
$input \Symfony\Component\Console\Input\InputInterface
$output \Symfony\Component\Console\Output\OutputInterface 

                final protected function execute(InputInterface $input, OutputInterface $output): int
{
    $io = new SymfonyStyle($input, $output);
    $names = $this->resolveDatabaseNames($input);
    if (is_string($names)) {
        $io->error($names);
        return Command::INVALID;
    }
    $multipleDatabases = $this->isMultipleDatabases();
    $hasResults = false;
    foreach ($names as $name) {
        if (!$multipleDatabases || $name === DatabaseRegistry::DEFAULT_DATABASE) {
            $context = $this->createDefaultContext();
        } else {
            /** @psalm-var DatabaseRegistry $this->additionalDatabases */
            $context = $this->createContext($this->additionalDatabases->createSetup($name));
        }
        if ($multipleDatabases) {
            $io->section('Database: ' . OutputFormatter::escape($name));
        }
        $status = $this->executeForDatabase($input, $output, $context);
        if ($status === null) {
            continue;
        }
        if ($status !== Command::SUCCESS) {
            return $status;
        }
        $hasResults = true;
    }
    return $hasResults ? Command::SUCCESS : Command::FAILURE;
}
executeForDatabase() protected method

protected ?int executeForDatabase ( \Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output, object $context )
$input \Symfony\Component\Console\Input\InputInterface
$output \Symfony\Component\Console\Output\OutputInterface
$context object 

                protected function executeForDatabase(
    InputInterface $input,
    OutputInterface $output,
    object $context,
): ?int {
    $io = new SymfonyStyle($input, $output);
    $context->migrator->setIo($io);
    $context->migrationService->setIo($io);
    $context->migrationService->databaseConnection();
    $context->migrationService->before($this->getName() ?? '');
    $limit = !$input->getOption('all')
        ? (int) $input->getOption('limit')
        : null;
    if ($limit !== null && $limit <= 0) {
        $io->error('The limit option must be greater than 0.');
        return Command::INVALID;
    }
    $migrations = $context->migrator->getHistory($limit);
    if (empty($migrations)) {
        $io->warning('No migration has been done before.');
        return null;
    }
    $countMigrations = count($migrations);
    if ($limit === $countMigrations) {
        $io->section("Last $countMigrations applied " . ($countMigrations === 1 ? 'migration' : 'migrations') . ':');
    } else {
        $io->section("Total $countMigrations " . ($countMigrations === 1 ? 'migration has' : 'migrations have') . ' been applied before:');
    }
    foreach ($migrations as $version => $time) {
        $output->writeln("\t<info>(" . date('Y-m-d H:i:s', (int) $time) . ') ' . $version . '</info>');
    }
    $output->writeln("\n");
    $io->success('Success.');
    return Command::SUCCESS;
}
getAvailableDatabaseNames() protected method

Defined in: Yiisoft\Db\Migration\Command\DatabaseCommand::getAvailableDatabaseNames()

protected string[] getAvailableDatabaseNames ( )

                protected function getAvailableDatabaseNames(): array
{
    return [DatabaseRegistry::DEFAULT_DATABASE, ...($this->additionalDatabases?->getNames() ?? [])];
}
isMultipleDatabases() protected method

Defined in: Yiisoft\Db\Migration\Command\DatabaseCommand::isMultipleDatabases()

protected boolean isMultipleDatabases ( )

                protected function isMultipleDatabases(): bool
{
    return $this->additionalDatabases !== null && $this->additionalDatabases->getNames() !== [];
}
resolveDatabaseNamesWithMissingOption() protected method

protected array resolveDatabaseNamesWithMissingOption ( \Symfony\Component\Console\Input\InputInterface $input )
$input \Symfony\Component\Console\Input\InputInterface 

                protected function resolveDatabaseNamesWithMissingOption(InputInterface $input): array
{
    return $this->getAvailableDatabaseNames();
}