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)
	configure ()
	execute (InputInterface $input, OutputInterface $output)

Protected Member Functions
	parseAgentMethod (string $agent_method)

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

Static Protected Attributes
static	$defaultName = "achieve"

Detailed Description

Achieves an objective.

Definition at line 24 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 45 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, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

configure()

ILIAS\Setup\CLI\AchieveCommand::configure

(

)

Definition at line 58 of file AchieveCommand.php.

    {
        $this->setDescription("Achieve a named objective from an agent.");
        $this->addArgument("objective", InputArgument::REQUIRED, "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 update.");
    }

execute()

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

Definition at line 67 of file AchieveCommand.php.

    {
        $objective_name = $input->getArgument('objective');
 
        $io = new IOWrapper($input, $output);
        $io->printLicenseMessage();
        $io->title("Achieve objective: $objective_name");
 
        $agent = $this->getRelevantAgent($input);
 
        if ($input->getArgument("config")) {
            $config = $this->readAgentConfig($agent, $input);
        } else {
            $config = null;
        }
 
        $objective = $agent->getNamedObjective($objective_name, $config);
 
        if (count($this->preconditions) > 0) {
            $objective = new ObjectiveWithPreconditions(
                $objective,
                ...$this->preconditions
            );
        }
 
        $environment = new ArrayEnvironment([
            Environment::RESOURCE_ADMIN_INTERACTION => $io
        ]);
        if ($config) {
            $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 $config, Vendor\Package\$e, ILIAS\Setup\CLI\addAgentConfigsToEnvironment(), ILIAS\Setup\CLI\getRelevantAgent(), ILIAS\Setup\CLI\readAgentConfig(), and ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION.

Here is the call graph for this function:

parseAgentMethod()

ILIAS\Setup\CLI\AchieveCommand::parseAgentMethod ( string  $agent_method )

protected

Definition at line 107 of file AchieveCommand.php.

                                                              : ?array
    {
        $result = [];
        if (!preg_match('/^\s*(\w+)::(\w+)\s*$/', $agent_method, $result)) {
            return null;
        }
 
        return [$result[1], $result[2]];
    }

References $result.

Field Documentation

$defaultName

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

staticprotected

Definition at line 30 of file AchieveCommand.php.

$preconditions

ILIAS\Setup\CLI\AchieveCommand::$preconditions

protected

var Objective[]

Definition at line 35 of file AchieveCommand.php.

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

$refinery

ILIAS\Setup\CLI\AchieveCommand::$refinery

protected

Definition at line 40 of file AchieveCommand.php.

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

---

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

• src/Setup/CLI/AchieveCommand.php