Inheritance diagram for ILIAS\Setup\CLI\MigrateCommand:

Collaboration diagram for ILIAS\Setup\CLI\MigrateCommand:

Public Member Functions
	__construct (AgentFinder $agent_finder, array $preconditions)

	configure ()

	execute (InputInterface $input, OutputInterface $output)

Protected Member Functions
	runMigration (InputInterface $input, IOWrapper $io)

	listMigrations (InputInterface $input, IOWrapper $io)

	prepareEnvironmentForMigration (Environment $environment, Migration $migration)

Protected Attributes
	$preconditions
	var Objective[] More...

Static Protected Attributes
static	$defaultName = "migrate"

Detailed Description

Migration command.

Definition at line 20 of file MigrateCommand.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\CLI\MigrateCommand::__construct	(	AgentFinder	$agent_finder,
		array	$preconditions
	)

Definition at line 35 of file MigrateCommand.php.

References ILIAS\Setup\CLI\MigrateCommand\$preconditions, and ILIAS\GlobalScreen\Provider\__construct().

     {
         parent::__construct();
         $this->agent_finder = $agent_finder;
         $this->preconditions = $preconditions;
     }

Here is the call graph for this function:

Member Function Documentation

◆ configure()

ILIAS\Setup\CLI\MigrateCommand::configure ( )

Definition at line 42 of file MigrateCommand.php.

References ILIAS\Setup\CLI\configureCommandForPlugins(), and ILIAS\Setup\Migration\INFINITE.

     {
         $this->setDescription("Starts and manages migrations needed after an update of ILIAS");
         $this->addOption("yes", "y", InputOption::VALUE_NONE, "Confirm every message of the installation.");
         $this->addOption("run", "R", InputOption::VALUE_REQUIRED, "Run the migration with the name given.");
         $this->addOption(
             "steps",
             "S",
             InputOption::VALUE_REQUIRED,
             "Run the selected migration with X steps. Pass " . Migration::INFINITE . " for all remaining steps."
         );
         $this->configureCommandForPlugins();
     }

Here is the call graph for this function:

◆ execute()

ILIAS\Setup\CLI\MigrateCommand::execute	(	InputInterface	$input,
		OutputInterface	$output
	)

Definition at line 56 of file MigrateCommand.php.

References ILIAS\Setup\CLI\MigrateCommand\listMigrations(), and ILIAS\Setup\CLI\MigrateCommand\runMigration().

     {
         $io = new IOWrapper($input, $output);
         $io->printLicenseMessage();
         $io->title("Trigger migrations in ILIAS");
 
         // Dispatching further sub-commands
         if ($input->hasOption('run') && !empty($input->getOption('run'))) {
             $this->runMigration($input, $io);
         } else {
             $this->listMigrations($input, $io);
         }
     }

Here is the call graph for this function:

◆ listMigrations()

ILIAS\Setup\CLI\MigrateCommand::listMigrations	(	InputInterface	$input,
		IOWrapper	$io
	)

protected

Definition at line 119 of file MigrateCommand.php.

References $steps, ILIAS\Setup\CLI\getRelevantAgent(), ILIAS\Setup\CLI\IOWrapper\inform(), ILIAS\Setup\CLI\MigrateCommand\prepareEnvironmentForMigration(), ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION, and ILIAS\Setup\CLI\IOWrapper\text().

Referenced by ILIAS\Setup\CLI\MigrateCommand\execute().

                                                                             : void
     {
         $agent = $this->getRelevantAgent($input);
         $migrations = $agent->getMigrations();
         $count = count($migrations);
         if ($count === 0) {
             $io->inform("There are currently no migrations to run.");
             return;
         }
 
         $env = new ArrayEnvironment([
             Environment::RESOURCE_ADMIN_INTERACTION => $io
         ]);
 
         $io->inform("There are {$count} to run:");
         foreach ($migrations as $migration_key => $migration) {
             $env = $this->prepareEnvironmentForMigration($env, $migration);
             $migration->prepare($env);
             $steps = $migration->getRemainingAmountOfSteps();
             $status = $steps === 0 ? "[done]" : "[remaining steps: {$steps}]";
             $io->text($migration_key . ": " . $migration->getLabel() . " " . $status);
         }
         $io->inform("Run them by passing --run <migration_id>, e.g. --run $migration_key");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareEnvironmentForMigration()

ILIAS\Setup\CLI\MigrateCommand::prepareEnvironmentForMigration	(	Environment	$environment,
		Migration	$migration
	)

protected

Definition at line 144 of file MigrateCommand.php.

References ILIAS\Setup\CLI\MigrateCommand\$preconditions, and ILIAS\Setup\Migration\getPreconditions().

Referenced by ILIAS\Setup\CLI\MigrateCommand\listMigrations().

       : Environment {
         $preconditions = $migration->getPreconditions($environment);
         if (count($preconditions) > 0) {
             $objective = new Objective\ObjectiveWithPreconditions(
                 new Objective\NullObjective(),
                 ...$preconditions
             );
 
             $environment = $this->achieveObjective($objective, $environment);
         }
 
         return $environment;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ runMigration()

ILIAS\Setup\CLI\MigrateCommand::runMigration	(	InputInterface	$input,
		IOWrapper	$io
	)

protected

Definition at line 70 of file MigrateCommand.php.

References Vendor\Package\$e, ILIAS\Setup\CLI\MigrateCommand\$preconditions, $steps, ILIAS\Setup\CLI\IOWrapper\error(), ILIAS\Setup\CLI\getRelevantAgent(), ILIAS\Setup\NoConfirmationException\getRequestedConfirmation(), ILIAS\Setup\Migration\INFINITE, ILIAS\Setup\CLI\IOWrapper\inform(), ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION, and ILIAS\Setup\CLI\IOWrapper\text().

Referenced by ILIAS\Setup\CLI\MigrateCommand\execute().

                                                                           : void
     {
         $agent = $this->getRelevantAgent($input);
 
         $migration_name = $input->getOption('run');
         $migrations = $agent->getMigrations();
         if (!isset($migrations[$migration_name]) || !($migrations[$migration_name] instanceof Migration)) {
             $io->error("Aborting Migration, did not find {$migration_name}.");
             return;
         }
         $migration = $migrations[$migration_name];
 
         $steps = (int)$input->getOption('steps');
 
         switch ($steps) {
             case Migration::INFINITE:
                 $io->text("Determined infinite steps to run.");
                 break;
             case 0:
                 $steps = $migration->getDefaultAmountOfStepsPerRun();
                 $io->text("no --steps option found, fallback to default amount of steps of migration. ($steps)");
                 break;
             default:
                 $io->text("Determined $steps step(s) to run.");
                 break;
 
         }
         $objective = new Objective\MigrationObjective($migration, $steps);
 
         $env = new ArrayEnvironment([
             Environment::RESOURCE_ADMIN_INTERACTION => $io
         ]);
 
         $preconditions = $migration->getPreconditions($env);
         if (count($preconditions) > 0) {
             $objective = new Objective\ObjectiveWithPreconditions(
                 $objective,
                 ...$preconditions
             );
         }
         $steps_text = $steps === Migration::INFINITE ? 'all' : (string)$steps;
         $io->inform("Preparing Environment for {$steps_text} steps in {$migration_name}");
         try {
             $this->achieveObjective($objective, $env, $io);
         } catch (NoConfirmationException $e) {
             $io->error("Aborting Migration, a necessary confirmation is missing:\n\n" . $e->getRequestedConfirmation());
         }
     }