aboutsummaryrefslogtreecommitdiff
path: root/cli/Commands/Plugins/PluginListMigrations.php
blob: 2af092f88a71b6b2c470ab434cd3532459df6996 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<?php

namespace Studip\Cli\Commands\Plugins;

use Studip\Cli\Commands\AbstractPluginCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class PluginListMigrations extends AbstractPluginCommand
{
    protected static $defaultName = 'plugin:list-migrations';

    protected function configure(): void
    {
        $this->setDescription('List all migrations of a plugin.');
        $this->setHelp('This command lists all migrations of a plugin.');
        $this->addArgument('pluginname', InputArgument::REQUIRED, 'name of the plugin');
        $this->addOption('branch', 'b', InputOption::VALUE_OPTIONAL, 'branch of the migrations', '0');
        $this->addOption('target', 't', InputOption::VALUE_OPTIONAL, 'target of the migrator', null);
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $pluginname = $input->getArgument('pluginname');
        $branch = $input->getOption('branch');
        $target = $input->getOption('target');
        $verbose = $input->getOption('verbose');

        $pluginManager = \PluginManager::getInstance();
        $plugin = $this->findPluginByName($pluginManager, $pluginname);
        if (null === $plugin) {
            $output->writeln('<error>Could not find plugin of that name.</error>');

            return Command::FAILURE;
        }

        $pluginpath = \Config::get()->PLUGINS_PATH . '/' . $plugin['path'];

        if (!is_dir($pluginpath . '/migrations')) {
            $output->writeln('<comment>Could not find any migrations of that plugin.</comment>');

            return Command::SUCCESS;
        }

        // if there are migrations, migrate
        $schemaVersion = new \DBSchemaVersion($plugin['name'], $branch);
        $migrator = new \Migrator($pluginpath . '/migrations', $schemaVersion, $verbose);

        $migrations = $migrator->relevantMigrations($target);

        $rows = [];
        foreach ($migrations as $number => $migration) {
            $description = $migration->description() ?: '(no description)';
            $rows[] = [$number, get_class($migration), $description];
        }

        $table = new Table($output);
        $table->setHeaders(['ID', 'Class', 'Description'])->setRows($rows);
        $table->setStyle('box');
        $table->render();

        return Command::SUCCESS;
    }
}