Installation command. More...

Inheritance diagram for ILIAS\Setup\CLI\InstallCommand:

Collaboration diagram for ILIAS\Setup\CLI\InstallCommand:

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

Protected Member Functions
	configure ()

	execute (InputInterface $input, OutputInterface $output)

	prepareILIASInstallation (InputInterface $input, OutputInterface $output)

	preparePluginInstallation (InputInterface $input, OutputInterface $output)

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

Static Protected Attributes
static	$defaultName = "install"

Detailed Description

Installation command.

Definition at line 39 of file InstallCommand.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 55 of file InstallCommand.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ configure()

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

protected

Definition at line 63 of file InstallCommand.php.

                                  : void
    {
        $this->setDescription("Creates a fresh ILIAS installation based on the config");
        $this->addArgument("config", InputArgument::OPTIONAL, "Configuration file for the installation");
        $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("yes", "y", InputOption::VALUE_NONE, "Confirm every message of the installation.");
        $this->configureCommandForPlugins();
    }

References ILIAS\Setup\CLI\configureCommandForPlugins().

Here is the call graph for this function:

◆ execute()

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

protected

Definition at line 72 of file InstallCommand.php.

                                                                              : 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 (!defined("ILIAS_SETUP_IGNORE_DB_UPDATE_STEP_MESSAGES")) {
            define("ILIAS_SETUP_IGNORE_DB_UPDATE_STEP_MESSAGES", true);
        }
 
        if ($input->hasOption('plugin') && $input->getOption('plugin') != "") {
            list($objective, $environment, $io) = $this->preparePluginInstallation($input, $output);
        } else {
            list($objective, $environment, $io) = $this->prepareILIASInstallation($input, $output);
        }
 
        try {
            $this->achieveObjective($objective, $environment, $io);
            $io->success("Installation complete. Thanks and have fun!");
        } catch (NoConfirmationException $e) {
            $io->error("Aborting Installation, a necessary confirmation is missing:\n\n" . $e->getRequestedConfirmation());
        }
 
        return 0;
    }

References Vendor\Package\$e, ILIAS\Setup\CLI\InstallCommand\prepareILIASInstallation(), and ILIAS\Setup\CLI\InstallCommand\preparePluginInstallation().

Here is the call graph for this function:

◆ prepareILIASInstallation()

ILIAS\Setup\CLI\InstallCommand::prepareILIASInstallation	(	InputInterface	$input,
		OutputInterface	$output
	)

protected

Definition at line 96 of file InstallCommand.php.

                                                                                               : array
    {
        $io = new IOWrapper($input, $output);
        $io->printLicenseMessage();
        $io->title("Install ILIAS");
 
        $agent = $this->getRelevantAgent($input);
 
        $config = $this->readAgentConfig($agent, $input);
 
        $objective = new ObjectiveCollection(
            "Install and Update ILIAS",
            false,
            $agent->getInstallObjective($config),
            $agent->getUpdateObjective($config)
        );
        if ($this->preconditions !== []) {
            $objective = new ObjectiveWithPreconditions(
                $objective,
                ...$this->preconditions
            );
        }
 
        $environment = new ArrayEnvironment([
            Environment::RESOURCE_ADMIN_INTERACTION => $io
        ]);
        $environment = $this->addAgentConfigsToEnvironment($agent, $config, $environment);
        // ATTENTION: This is bad because we strongly couple this generic command
        // to something very specific here. This can go away once we have got rid of
        // everything related to clients, since we do not need that client-id then.
        // This will require some more work, though.
        $common_config = $config->getConfig("common");
        $environment = $environment->withResource(
            Environment::RESOURCE_CLIENT_ID,
            $common_config->getClientId()
        );
 
        return [$objective, $environment, $io];
    }

References $config, ILIAS\Setup\CLI\addAgentConfigsToEnvironment(), ILIAS\Setup\CLI\getRelevantAgent(), ILIAS\Setup\CLI\readAgentConfig(), ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION, and ILIAS\Setup\Environment\RESOURCE_CLIENT_ID.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preparePluginInstallation()

ILIAS\Setup\CLI\InstallCommand::preparePluginInstallation	(	InputInterface	$input,
		OutputInterface	$output
	)

protected

Definition at line 136 of file InstallCommand.php.

                                                                                                : array
    {
        $io = new IOWrapper($input, $output);
        $io->printLicenseMessage();
        $io->title("Install ILIAS Plugin");
 
        $agent = $this->getRelevantAgent($input);
 
        $config = $this->readAgentConfig($agent, $input, $input->getOption("plugin"));
 
        $objective = new ObjectiveCollection(
            "Install and Update ILIAS Plugin",
            false,
            $agent->getInstallObjective($config),
            $agent->getUpdateObjective($config)
        );
        if ($this->preconditions !== []) {
            $objective = new ObjectiveWithPreconditions(
                $objective,
                ...$this->preconditions
            );
        }
 
        $environment = new ArrayEnvironment([
            Environment::RESOURCE_ADMIN_INTERACTION => $io
        ]);
 
        if (!is_null($config)) {
            $environment = $this->addAgentConfigsToEnvironment($agent, $config, $environment);
        }
 
        return [$objective, $environment, $io];
    }