This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Data Structures
class	AchieveCommand
	Achieves an objective. More...

class	App
	The ILIAS-setup-console-application. More...

class	BuildCommand
	Installation command. More...

class	ConfigReader
	Read a json-formatted config from a file and overwrite some fields. More...

class	ImportFileUnzippedFileObjective

class	InstallCommand
	Installation command. More...

class	IOWrapper
	Wrapper around symfonies input and output facilities to provide just the functionality required for the ILIAS-setup. More...

class	MigrateCommand
	Migration command. More...

class	StatusCommand
	Command to output status information about the installation. More...

class	UpdateCommand
	Update command. More...

Functions
	configureCommandForPlugins ()

	getRelevantAgent (InputInterface $input)

	readAgentConfig (Agent $agent, InputInterface $input, string $use_config_field=null)

	addAgentConfigsToEnvironment (Agent $agent, Config $config, Environment $environment)

	isConfigInRoot (string $config_file)

Variables
trait	HasAgent
	Add this to an Command that has an agent. More...

trait	HasConfigReader
	Add this to an Command that has an config reader. More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Function Documentation

◆ addAgentConfigsToEnvironment()

ILIAS\Setup\CLI\addAgentConfigsToEnvironment	(	Agent	$agent,
		Config	$config,
		Environment	$environment
	)

protected

Definition at line 70 of file HasConfigReader.php.

References ILIAS\Setup\Environment\withConfigFor().

Referenced by ILIAS\Setup\CLI\UpdateCommand\execute(), ILIAS\Setup\CLI\AchieveCommand\executeAchieveObjective(), ILIAS\Setup\CLI\InstallCommand\prepareILIASInstallation(), and ILIAS\Setup\CLI\InstallCommand\preparePluginInstallation().

      : Environment {
         if ($agent instanceof AgentCollection) {
             foreach ($config->getKeys() as $k) {
                 $environment = $environment->withConfigFor($k, $config->getConfig($k));
             }
         }
 
         return $environment;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ configureCommandForPlugins()

ILIAS\Setup\CLI\configureCommandForPlugins ( )

protected

Definition at line 33 of file HasAgent.php.

Referenced by ILIAS\Setup\CLI\StatusCommand\configure(), ILIAS\Setup\CLI\BuildCommand\configure(), ILIAS\Setup\CLI\MigrateCommand\configure(), ILIAS\Setup\CLI\UpdateCommand\configure(), and ILIAS\Setup\CLI\InstallCommand\configure().

                                                    : void
     {
         $this->addOption("legacy-plugin", null, InputOption::VALUE_REQUIRED, "Name of the plugin to run the command for.");
         $this->addOption("no-legacy-plugins", null, InputOption::VALUE_NONE, "Ignore all plugins when running the command.");
         $this->addOption("skip-legacy-plugin", null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, "Skip plugin with the supplied <plugin-name> when running the command.");
     }

Here is the caller graph for this function:

◆ getRelevantAgent()

ILIAS\Setup\CLI\getRelevantAgent ( InputInterface $input )

protected

Definition at line 40 of file HasAgent.php.

Referenced by ILIAS\Setup\CLI\StatusCommand\execute(), ILIAS\Setup\CLI\BuildCommand\execute(), ILIAS\Setup\CLI\UpdateCommand\execute(), ILIAS\Setup\CLI\AchieveCommand\executeAchieveObjective(), ILIAS\Setup\CLI\MigrateCommand\listMigrations(), ILIAS\Setup\CLI\InstallCommand\prepareILIASInstallation(), ILIAS\Setup\CLI\InstallCommand\preparePluginInstallation(), ILIAS\Setup\CLI\MigrateCommand\runMigration(), and ILIAS\Tests\Setup\CLI\HasAgentTest\setUp().

                                                               : Agent
     {
         if (!$this->agent_finder) {
             throw new \LogicException(
                 "\$this->agent_finder needs to intialized with an AgentFinder."
             );
         }
 
         if ($input->hasOption("no-legacy-plugins") && $input->getOption("no-legacy-plugins")) {
             // The agents of the core are in all folders but the customizing folder.
             return $this->agent_finder->getComponentAgents();
         }
 
         if ($input->hasOption("legacy-plugin")) {
             $plugin_name = $input->getOption("legacy-plugin");
             if ($plugin_name) {
                 return $this->agent_finder->getPluginAgent($plugin_name);
             }
         }
 
         $agents = $this->agent_finder->getAgents();
         if ($input->hasOption("skip-legacy-plugin")) {
             foreach (($input->getOption("skip-legacy-plugin") ?? []) as $plugin_name) {
                 $agents = $agents->withRemovedAgent($plugin_name);
             }
         }
 
         return $agents;
     }

Here is the caller graph for this function:

◆ isConfigInRoot()

ILIAS\Setup\CLI\isConfigInRoot ( string $config_file )

protected

Definition at line 84 of file HasConfigReader.php.

Referenced by ILIAS\Setup\CLI\readAgentConfig().

                                                           : bool
     {
         $webroot = realpath(__DIR__ . "/../../../../../");
         $config_file = realpath($config_file);
 
         $common_prefix = substr($config_file, 0, strlen($webroot));
         return $webroot === $common_prefix;
     }

Here is the caller graph for this function:

◆ readAgentConfig()

ILIAS\Setup\CLI\readAgentConfig	(	Agent	$agent,
		InputInterface	$input,
		string	$use_config_field = `null`
	)

protected

Definition at line 36 of file HasConfigReader.php.

References ILIAS\Setup\CLI\isConfigInRoot().

Referenced by ILIAS\Setup\CLI\UpdateCommand\execute(), ILIAS\Setup\CLI\AchieveCommand\executeAchieveObjective(), ILIAS\Setup\CLI\InstallCommand\prepareILIASInstallation(), ILIAS\Setup\CLI\InstallCommand\preparePluginInstallation(), and ILIAS\Tests\Setup\CLI\HasConfigReaderTest\setUp().

                                                                                                             : ?Config
     {
         if (!($this->config_reader instanceof ConfigReader)) {
             throw new \LogicException("\$this->config_reader not properly initialized.");
         }
 
         if (!$agent->hasConfig()) {
             return null;
         }
 
         $config_file = $input->getArgument("config");
         if ($this->isConfigInRoot($config_file)) {
             throw new \LogicException("Thou shall not put your config file in the webroot!!");
         }
 
         $config_overwrites_raw = $input->getOption("config");
         $config_overwrites = [];
         foreach ($config_overwrites_raw as $o) {
             $vs = explode("=", $o);
             if (count($vs) !== 2) {
                 throw new \Exception("Cannot read config-option: '$o'");
             }
             $config_overwrites[$vs[0]] = $vs[1];
         }
 
         $config_content = $this->config_reader->readConfigFile($config_file, $config_overwrites);
         if ($use_config_field !== null) {
             $config_content = $config_content[$use_config_field] ?? null;
         }
 
         $trafo = $agent->getArrayToConfigTransformation();
         return $trafo->transform($config_content);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ HasAgent

trait ILIAS::Setup::CLI\HasAgent

Initial value:

{

protected ?AgentFinder $agent_finder = null

Add this to an Command that has an agent.

Definition at line 30 of file HasAgent.php.

Referenced by ILIAS\Tests\Setup\CLI\HasAgentTest\setUp().

◆ HasConfigReader

trait ILIAS::Setup::CLI\HasConfigReader

Initial value:

{
    
    protected ConfigReader $config_reader

Add this to an Command that has an config reader.

Definition at line 30 of file HasConfigReader.php.

Referenced by ILIAS\Tests\Setup\CLI\HasConfigReaderTest\setUp().

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ addAgentConfigsToEnvironment()

◆ configureCommandForPlugins()

◆ getRelevantAgent()

◆ isConfigInRoot()

◆ readAgentConfig()

Variable Documentation

◆ HasAgent

◆ HasConfigReader