ILIAS\Setup\CLI\AchieveCommand Class Reference

Achieves an objective. More...

Inheritance diagram for ILIAS\Setup\CLI\AchieveCommand:

Collaboration diagram for ILIAS\Setup\CLI\AchieveCommand:

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

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

Protected Attributes
array	$preconditions = []
Refinery	$refinery

Static Protected Attributes
static	$defaultName = "achieve"

Private Member Functions
	shouldListNamedObjectives (InputInterface $input)
	executeListNamedObjectives (IOWrapper $io, OutputInterface $output)
	executeAchieveObjective (IOWrapper $io, InputInterface $input)

Detailed Description

Achieves an objective.

Definition at line 41 of file AchieveCommand.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 56 of file AchieveCommand.php.

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

References ILIAS\Setup\CLI\AchieveCommand\$preconditions, ILIAS\Setup\CLI\AchieveCommand\$refinery, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

configure()

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

protected

Definition at line 69 of file AchieveCommand.php.

                                  : void
    {
        $this->setDescription("Achieve a named objective from an agent.");
        $this->addArgument(
            "objective",
            InputArgument::OPTIONAL,
            "Objective to be execute from an agent. Format: \$AGENT::\$OBJECTIVE"
        );
        $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 objective.");
        $this->addOption("list", null, InputOption::VALUE_NONE, "Lists all achievable objectives");
    }

execute()

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

protected

Definition at line 89 of file AchieveCommand.php.

                                                                              : int
    {
        $io = new IOWrapper($input, $output);
        $io->printLicenseMessage();
 
        if ($this->shouldListNamedObjectives($input)) {
            $this->executeListNamedObjectives($io, $output);
            return 0;
        }
 
        $this->executeAchieveObjective($io, $input);
 
        return 0;
    }

References ILIAS\Setup\CLI\AchieveCommand\executeAchieveObjective(), ILIAS\Setup\CLI\AchieveCommand\executeListNamedObjectives(), and ILIAS\Setup\CLI\AchieveCommand\shouldListNamedObjectives().

Here is the call graph for this function:

executeAchieveObjective()

ILIAS\Setup\CLI\AchieveCommand::executeAchieveObjective ( IOWrapper  $io, InputInterface  $input  )

private

Definition at line 131 of file AchieveCommand.php.

                                                                                  : void
    {
        $agent = $this->getRelevantAgent($input);
        $objective_name = $input->getArgument('objective');
 
        $io->title("Achieve objective: $objective_name");
 
        $config = null;
        if ($input->getArgument("config")) {
            $config = $this->readAgentConfig($agent, $input);
        }
 
        $namedObjectives = $agent->getNamedObjectives($config);
 
        if (isset($namedObjectives[$objective_name])) {
            $objective = $namedObjectives[$objective_name];
        } else {
            throw new InvalidArgumentException(
                "There is no named objective '$objective_name'"
            );
        }
 
        if ($this->preconditions !== []) {
            $objective = new ObjectiveWithPreconditions(
                $objective->create(),
                ...$this->preconditions
            );
        } else {
            $objective = $objective->create();
        }
 
        $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("Achieved objective '$objective_name'. Thanks and have fun!");
        } catch (NoConfirmationException $e) {
            $io->error("Aborted the attempt to achieve '$objective_name', a necessary confirmation is missing:\n\n" . $e->getRequestedConfirmation());
        }
    }

References Vendor\Package\$e, ILIAS\Setup\CLI\addAgentConfigsToEnvironment(), ILIAS\Setup\CLI\IOWrapper\error(), ILIAS\Setup\CLI\getRelevantAgent(), ILIAS\Setup\CLI\readAgentConfig(), ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION, ILIAS\Setup\CLI\IOWrapper\success(), and ILIAS\Setup\CLI\IOWrapper\title().

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

Here is the call graph for this function:

Here is the caller graph for this function:

executeListNamedObjectives()

ILIAS\Setup\CLI\AchieveCommand::executeListNamedObjectives ( IOWrapper  $io, OutputInterface  $output  )

private

Definition at line 119 of file AchieveCommand.php.

                                                                                       : void
    {
        $io->title("Listing available objectives");
 
        $agentCollection = $this->agent_finder->getAgents();
        foreach ($agentCollection->getNamedObjectives(null) as $cmd => $objectiveCollection) {
            $output->write(str_pad($cmd, IOWrapper::LABEL_WIDTH));
            $output->writeln($objectiveCollection->getDescription());
        }
        $output->writeln("");
    }

References ILIAS\Setup\CLI\IOWrapper\LABEL_WIDTH, and ILIAS\Setup\CLI\IOWrapper\title().

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

Here is the call graph for this function:

Here is the caller graph for this function:

shouldListNamedObjectives()

ILIAS\Setup\CLI\AchieveCommand::shouldListNamedObjectives ( InputInterface  $input )

private

Definition at line 104 of file AchieveCommand.php.

                                                                     : bool
    {
        return
            (
                $input->getOption("list") !== null
                && is_bool($input->getOption("list"))
                && $input->getOption("list")
            )
            ||
            (
                $input->getArgument("objective") === ""
                || $input->getArgument("objective") === null
            );
    }

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

Here is the caller graph for this function:

Field Documentation

$defaultName

ILIAS\Setup\CLI\AchieveCommand::$defaultName = "achieve"

staticprotected

Definition at line 47 of file AchieveCommand.php.

$preconditions

array ILIAS\Setup\CLI\AchieveCommand::$preconditions = []

protected

Definition at line 49 of file AchieveCommand.php.

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

$refinery

Refinery ILIAS\Setup\CLI\AchieveCommand::$refinery

protected

Definition at line 51 of file AchieveCommand.php.

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

---

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

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