Command base class. More...

Inheritance diagram for ILIAS\Setup\CLI\BaseCommand:

Collaboration diagram for ILIAS\Setup\CLI\BaseCommand:

Public Member Functions
	__construct (callable $lazy_agent, ConfigReader $config_reader, array $preconditions)

	configure ()

	execute (InputInterface $input, OutputInterface $output)

Protected Member Functions
	getAgent ()

	shouldSayYes (InputInterface $input)

	printLicenseMessage (IOWrapper $io, InputInterface $input)

	printIntroMessage (IOWrapper $io)

	printOutroMessage (IOWrapper $io)

	readAgentConfig (Agent $agent, InputInterface $input)

	buildEnvironment (Agent $agent, ?Config $config, IOWrapper $io)

	getObjective (Agent $agent, ?Config $config)

Protected Attributes
	$lazy_agent

	$agent

	$config_reader

	$preconditions
	var Objective[] More...

Static Protected Attributes
static	$defaultName = "install"

Detailed Description

Command base class.

Definition at line 23 of file BaseCommand.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\CLI\BaseCommand::__construct	(	callable	$lazy_agent,
		ConfigReader	$config_reader,
		array	$preconditions
	)

Definition at line 51 of file BaseCommand.php.

    {
        parent::__construct();
        $this->lazy_agent = $lazy_agent;
        $this->agent = null;
        $this->config_reader = $config_reader;
        $this->preconditions = $preconditions;
    }

References ILIAS\Setup\CLI\BaseCommand\$config_reader, ILIAS\Setup\CLI\BaseCommand\$lazy_agent, ILIAS\Setup\CLI\BaseCommand\$preconditions, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ buildEnvironment()

ILIAS\Setup\CLI\BaseCommand::buildEnvironment	(	Agent	$agent,
		?Config	$config,
		IOWrapper	$io
	)

abstractprotected

Reimplemented in ILIAS\Setup\CLI\BuildArtifactsCommand, ILIAS\Setup\CLI\InstallCommand, ILIAS\Setup\CLI\ReloadControlStructureCommand, and ILIAS\Setup\CLI\UpdateCommand.

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

Here is the caller graph for this function:

◆ configure()

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

Reimplemented in ILIAS\Setup\CLI\BuildArtifactsCommand, ILIAS\Setup\CLI\InstallCommand, ILIAS\Setup\CLI\ReloadControlStructureCommand, and ILIAS\Setup\CLI\UpdateCommand.

Definition at line 69 of file BaseCommand.php.

    {
        $this
            ->addArgument("config", InputArgument::REQUIRED, "Configuration file for the Setup")
            ->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\"", [])
            ->addOption("yes", "y", InputOption::VALUE_NONE, "Confirm every message of the setup.");
    }

◆ execute()

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

Reimplemented in ILIAS\Setup\CLI\InstallCommand, and ILIAS\Setup\CLI\UpdateCommand.

Definition at line 77 of file BaseCommand.php.

    {
        $io = new IOWrapper($input, $output, $this->shouldSayYes($input));
 
        $this->printLicenseMessage($io, $input);
 
        $this->printIntroMessage($io);
 
        $config = $this->readAgentConfig($this->getAgent(), $input);
        $environment = $this->buildEnvironment($this->getAgent(), $config, $io);
        $goal = $this->getObjective($this->getAgent(), $config);
        if (count($this->preconditions) > 0) {
            $goal = new ObjectiveWithPreconditions(
                $goal,
                ...$this->preconditions
            );
        }
        $goals = new ObjectiveIterator($environment, $goal);
 
        try {
            while ($goals->valid()) {
                $current = $goals->current();
                $io->startObjective($current->getLabel(), $current->isNotable());
                try {
                    $environment = $current->achieve($environment);
                    $io->finishedLastObjective($current->getLabel(), $current->isNotable());
                    $goals->setEnvironment($environment);
                } catch (UnachievableException $e) {
                    $goals->markAsFailed($current);
                    $io->error($e->getMessage());
                    $io->failedLastObjective($current->getLabel());
                }
                $goals->next();
            }
            $this->printOutroMessage($io);
        } catch (NoConfirmationException $e) {
            $io->error("Aborting Setup, a necessary confirmation is missing:\n\n" . $e->getRequestedConfirmation());
        }
    }

References $config, Vendor\Package\$e, ILIAS\Setup\CLI\BaseCommand\buildEnvironment(), ILIAS\Setup\CLI\BaseCommand\getAgent(), ILIAS\Setup\CLI\BaseCommand\getObjective(), ILIAS\Setup\CLI\BaseCommand\printIntroMessage(), ILIAS\Setup\CLI\BaseCommand\printLicenseMessage(), ILIAS\Setup\CLI\BaseCommand\printOutroMessage(), ILIAS\Setup\CLI\BaseCommand\readAgentConfig(), and ILIAS\Setup\CLI\BaseCommand\shouldSayYes().

Here is the call graph for this function:

◆ getAgent()

ILIAS\Setup\CLI\BaseCommand::getAgent ( )

protected

Definition at line 60 of file BaseCommand.php.

                                  : Agent
    {
        if ($this->agent !== null) {
            return $this->agent;
        }
        $this->agent = ($this->lazy_agent)();
        return $this->agent;
    }

References ILIAS\Setup\CLI\BaseCommand\$agent, and ILIAS\Setup\CLI\BaseCommand\$lazy_agent.

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

Here is the caller graph for this function:

◆ getObjective()

ILIAS\Setup\CLI\BaseCommand::getObjective	(	Agent	$agent,
		?Config	$config
	)

abstractprotected

Reimplemented in ILIAS\Setup\CLI\BuildArtifactsCommand, ILIAS\Setup\CLI\InstallCommand, ILIAS\Setup\CLI\ReloadControlStructureCommand, and ILIAS\Setup\CLI\UpdateCommand.

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

Here is the caller graph for this function:

◆ printIntroMessage()

ILIAS\Setup\CLI\BaseCommand::printIntroMessage ( IOWrapper $io )

abstractprotected

Reimplemented in ILIAS\Setup\CLI\BuildArtifactsCommand, ILIAS\Setup\CLI\InstallCommand, ILIAS\Setup\CLI\ReloadControlStructureCommand, and ILIAS\Setup\CLI\UpdateCommand.

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

Here is the caller graph for this function:

◆ printLicenseMessage()

ILIAS\Setup\CLI\BaseCommand::printLicenseMessage	(	IOWrapper	$io,
		InputInterface	$input
	)

protected

Definition at line 122 of file BaseCommand.php.

                                                                                 : void
    {
        if ($this->shouldSayYes($input) || ($input->hasOption("no-interaction") && $input->getOption("no-interaction"))) {
            return;
        }
        $io->text(
            "   ILIAS Copyright (C) 1998-2019 ILIAS Open Source e.V. - GPLv3\n\n" .
            "This program comes with ABSOLUTELY NO WARRANTY. This is free software,\n" .
            "and you are welcome to redistribute it under certain conditions. Look\n" .
            "into the LICENSE file for details."
        );
    }

References ILIAS\Setup\CLI\BaseCommand\shouldSayYes(), and ILIAS\Setup\CLI\IOWrapper\text().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printOutroMessage()

ILIAS\Setup\CLI\BaseCommand::printOutroMessage ( IOWrapper $io )

abstractprotected

Reimplemented in ILIAS\Setup\CLI\BuildArtifactsCommand, ILIAS\Setup\CLI\InstallCommand, ILIAS\Setup\CLI\ReloadControlStructureCommand, and ILIAS\Setup\CLI\UpdateCommand.

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

Here is the caller graph for this function:

◆ readAgentConfig()

ILIAS\Setup\CLI\BaseCommand::readAgentConfig	(	Agent	$agent,
		InputInterface	$input
	)

protected

Reimplemented in ILIAS\Setup\CLI\BuildArtifactsCommand.

Definition at line 139 of file BaseCommand.php.

                                                                            : ?Config
    {
        if (!$agent->hasConfig()) {
            return null;
        }
 
        $config_file = $input->getArgument("config");
        $config_overwrites_raw = $input->getOption("config");
        $config_overwrites = [];
        foreach ($config_overwrites_raw as $o) {
            list($k, $v) = explode("=", $o);
            $config_overwrites[$k] = $v;
        }
        $config_content = $this->config_reader->readConfigFile($config_file, $config_overwrites);
        $trafo = $this->agent->getArrayToConfigTransformation();
        return $trafo->transform($config_content);
    }

References ILIAS\Setup\CLI\BaseCommand\$agent.

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

Here is the caller graph for this function:

◆ shouldSayYes()

ILIAS\Setup\CLI\BaseCommand::shouldSayYes ( InputInterface $input )

protected

Definition at line 117 of file BaseCommand.php.

                                                           : bool
    {
        return $input->getOption("yes") ?? false;
    }

Referenced by ILIAS\Setup\CLI\BaseCommand\execute(), and ILIAS\Setup\CLI\BaseCommand\printLicenseMessage().

Here is the caller graph for this function:

Field Documentation

◆ $agent

ILIAS\Setup\CLI\BaseCommand::$agent

protected

Definition at line 35 of file BaseCommand.php.

Referenced by ILIAS\Setup\CLI\InstallCommand\buildEnvironment(), ILIAS\Setup\CLI\ReloadControlStructureCommand\buildEnvironment(), ILIAS\Setup\CLI\UpdateCommand\buildEnvironment(), ILIAS\Setup\CLI\BaseCommand\getAgent(), ILIAS\Setup\CLI\BuildArtifactsCommand\getObjective(), ILIAS\Setup\CLI\InstallCommand\getObjective(), ILIAS\Setup\CLI\UpdateCommand\getObjective(), and ILIAS\Setup\CLI\BaseCommand\readAgentConfig().

◆ $config_reader

ILIAS\Setup\CLI\BaseCommand::$config_reader

protected

Definition at line 40 of file BaseCommand.php.

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

◆ $defaultName

ILIAS\Setup\CLI\BaseCommand::$defaultName = "install"

staticprotected

Definition at line 25 of file BaseCommand.php.

◆ $lazy_agent

ILIAS\Setup\CLI\BaseCommand::$lazy_agent

protected

Definition at line 30 of file BaseCommand.php.

Referenced by ILIAS\Setup\CLI\BaseCommand\__construct(), and ILIAS\Setup\CLI\BaseCommand\getAgent().

◆ $preconditions

ILIAS\Setup\CLI\BaseCommand::$preconditions

protected

var Objective[]

Definition at line 45 of file BaseCommand.php.

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

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

src/Setup/CLI/BaseCommand.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildEnvironment()

◆ configure()

◆ execute()

◆ getAgent()

◆ getObjective()

◆ printIntroMessage()

◆ printLicenseMessage()

◆ printOutroMessage()

◆ readAgentConfig()

◆ shouldSayYes()

Field Documentation

◆ $agent

◆ $config_reader

◆ $defaultName

◆ $lazy_agent

◆ $preconditions