ILIAS\Setup\CLI\UpdateCommand Class Reference

Update command. More...

Inheritance diagram for ILIAS\Setup\CLI\UpdateCommand:

Collaboration diagram for ILIAS\Setup\CLI\UpdateCommand:

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

Protected Member Functions
	configure ()
	execute (InputInterface $input, OutputInterface $output)

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

Static Protected Attributes
static	$defaultName = "update"

Detailed Description

Update command.

Definition at line 38 of file UpdateCommand.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\CLI\UpdateCommand::__construct	(	AgentFinder	$agent_finder,
		ConfigReader	$config_reader,
		array	$preconditions
	)

Definition at line 54 of file UpdateCommand.php.

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

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

Here is the call graph for this function:

Member Function Documentation

configure()

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

protected

Definition at line 62 of file UpdateCommand.php.

References ILIAS\Setup\CLI\configureCommandForPlugins(), and null.

                                  : void
    {
        $this->setDescription("Updates an existing ILIAS installation");
        $this->addArgument("config", InputArgument::OPTIONAL, "Configuration file for the update");
        $this->addOption("config", null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, "Define fields in the configuration file that should be overwritten, e.g. \"a.b.c=foo\"", []);
        $this->addOption("ignore-db-update-messages", null, InputOption::VALUE_NONE, "Ignore messages from the database update steps.");
        $this->addOption("yes", "y", InputOption::VALUE_NONE, "Confirm every message of the update.");
        $this->configureCommandForPlugins();
    }

Here is the call graph for this function:

execute()

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

protected

Definition at line 72 of file UpdateCommand.php.

References Vendor\Package\$e, ILIAS\Setup\CLI\addAgentConfigsToEnvironment(), ILIAS\Setup\CLI\getRelevantAgent(), ILIAS\Setup\NoConfirmationException\getRequestedConfirmation(), null, ILIAS\Setup\CLI\readAgentConfig(), and ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION.

                                                                              : int
    {
        // ATTENTION: This is a hack to get around the usage of the echo/exit pattern in
        // the setup for the command line version of the setup. Do not use this.
        if ($input->hasOption("ignore-db-update-messages") && $input->getOption("ignore-db-update-messages")) {
            define("ILIAS_SETUP_IGNORE_DB_UPDATE_STEP_MESSAGES", true);
        }

        $io = new IOWrapper($input, $output);
        $io->printLicenseMessage();
        $io->title("Update ILIAS");

        $agent = $this->getRelevantAgent($input);

        if ($input->getArgument("config")) {
            $config = $this->readAgentConfig($agent, $input);
        } else {
            $config = null;
        }

        $objective = $agent->getUpdateObjective($config);
        if ($this->preconditions !== []) {
            $objective = new ObjectiveWithPreconditions(
                $objective,
                ...$this->preconditions
            );
        }

        $environment = new ArrayEnvironment([
            Environment::RESOURCE_ADMIN_INTERACTION => $io
        ]);
        if ($config !== null) {
            $environment = $this->addAgentConfigsToEnvironment($agent, $config, $environment);
        }

        try {
            $this->achieveObjective($objective, $environment, $io);
            $io->success("Update complete. Thanks and have fun!");
        } catch (NoConfirmationException $e) {
            $io->error("Aborting Update, a necessary confirmation is missing:\n\n" . $e->getRequestedConfirmation());
        }

        return 0;
    }

Here is the call graph for this function:

Field Documentation

$defaultName

ILIAS\Setup\CLI\UpdateCommand::$defaultName = "update"

staticprotected

Definition at line 44 of file UpdateCommand.php.

$preconditions

array ILIAS\Setup\CLI\UpdateCommand::$preconditions

protected

var Objective[]

Definition at line 49 of file UpdateCommand.php.

Referenced by ILIAS\Setup\CLI\UpdateCommand\__construct().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Setup/src/CLI/UpdateCommand.php