Inheritance diagram for ilComponentInstallPluginObjective:

Collaboration diagram for ilComponentInstallPluginObjective:

Public Member Functions
	__construct (string $plugin_name)

	getHash ()

	getLabel ()

	isNotable ()

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Protected Member Functions
	initEnvironment (Setup\Environment $environment, \ilComponentRepository $component_repository, \ilComponentFactory $component_factory)

Protected Attributes
	$plugin_name

Detailed Description

Definition at line 26 of file class.ilComponentInstallPluginObjective.php.

Constructor & Destructor Documentation

◆ __construct()

ilComponentInstallPluginObjective::__construct ( string $plugin_name )

Definition at line 33 of file class.ilComponentInstallPluginObjective.php.

    {
        $this->plugin_name = $plugin_name;
    }

References $plugin_name.

Referenced by initEnvironment().

Here is the caller graph for this function:

Member Function Documentation

◆ achieve()

ilComponentInstallPluginObjective::achieve ( Setup\Environment $environment )

Definition at line 80 of file class.ilComponentInstallPluginObjective.php.

                                                           : Setup\Environment
    {
        $component_repository = $environment->getResource(Setup\Environment::RESOURCE_COMPONENT_REPOSITORY);
        $component_factory = $environment->getResource(Setup\Environment::RESOURCE_COMPONENT_FACTORY);
        $info = $component_repository->getPluginByName($this->plugin_name);
 
        if (!$info->supportsCLISetup()) {
            throw new \RuntimeException(
                "Plugin $this->plugin_name does not support command line setup."
            );
        }
 
        if ($info->isInstalled()) {
            throw new \RuntimeException(
                "Plugin $this->plugin_name is already installed."
            );
        }
 
        $ORIG_DIC = $this->initEnvironment($environment, $component_repository, $component_factory);
        $plugin = $component_factory->getPlugin($info->getId());
        $plugin->install();
        $plugin->update();
        $GLOBALS["DIC"] = $ORIG_DIC;
 
        return $environment;
    }

References $GLOBALS, XapiProxy\$plugin, ILIAS\Setup\Environment\getResource(), and initEnvironment().

Here is the call graph for this function:

◆ getHash()

ilComponentInstallPluginObjective::getHash ( )

Definition at line 41 of file class.ilComponentInstallPluginObjective.php.

                             : string
    {
        return hash("sha256", self::class . $this->plugin_name);
    }

◆ getLabel()

ilComponentInstallPluginObjective::getLabel ( )

Definition at line 49 of file class.ilComponentInstallPluginObjective.php.

                              : string
    {
        return "Install plugin $this->plugin_name.";
    }

◆ getPreconditions()

ilComponentInstallPluginObjective::getPreconditions ( Setup\Environment $environment )

Definition at line 65 of file class.ilComponentInstallPluginObjective.php.

                                                                    : array
    {
        return [
            new ClientIdReadObjective(),
            new \ilIniFilesPopulatedObjective(),
            new \ilDatabaseUpdatedObjective(),
            new \ilComponentPluginAdminInitObjective(),
            new \ilComponentRepositoryExistsObjective(),
            new \ilComponentFactoryExistsObjective()
        ];
    }

◆ initEnvironment()

ilComponentInstallPluginObjective::initEnvironment	(	Setup\Environment	$environment,
		\ilComponentRepository	$component_repository,
		\ilComponentFactory	$component_factory
	)

protected

Definition at line 118 of file class.ilComponentInstallPluginObjective.php.

      {
        $db = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);
        $plugin_admin = $environment->getResource(Setup\Environment::RESOURCE_PLUGIN_ADMIN);
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
        $client_ini = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_INI);
 
        // ATTENTION: This is a total abomination. It only exists to allow various
        // sub components of the various readers to run. This is a memento to the
        // fact, that dependency injection is something we want. Currently, every
        // component could just service locate the whole world via the global $DIC.
        $DIC = $GLOBALS["DIC"];
        $GLOBALS["DIC"] = new DI\Container();
        $GLOBALS["DIC"]["ilDB"] = $db;
        $GLOBALS["DIC"]["ilIliasIniFile"] = $ini;
        $GLOBALS["DIC"]["ilClientIniFile"] = $client_ini;
        $GLOBALS["DIC"]["ilLog"] = new class () extends ilLogger {
            public function __construct()
            {
            }
            public function write(string $a_message, $a_level = ilLogLevel::INFO): void
            {
            }
            public function info(string $a_message): void
            {
            }
            public function warning(string $a_message): void
            {
            }
            public function error(string $a_message): void
            {
            }
            public function debug(string $a_message, array $a_context = []): void
            {
            }
            public function dump($a_variable, int $a_level = ilLogLevel::INFO): void
            {
            }
        };
        $GLOBALS["DIC"]["ilLoggerFactory"] = new class () extends ilLoggerFactory {
            public function __construct()
            {
            }
            public static function getRootLogger(): ilLogger
            {
                return $GLOBALS["DIC"]["ilLog"];
            }
            public static function getLogger(string $a_component_id): ilLogger
            {
                return $GLOBALS["DIC"]["ilLog"];
            }
        };
        $GLOBALS["ilLog"] = $GLOBALS["DIC"]["ilLog"];
        $GLOBALS["DIC"]["ilBench"] = null;
        $GLOBALS["DIC"]["lng"] = new ilLanguage('en');
        $GLOBALS["DIC"]["lng"]->lang_user = 'en';
        $GLOBALS["DIC"]["ilPluginAdmin"] = $plugin_admin;
        $GLOBALS["DIC"]["ilias"] = null;
        $GLOBALS["DIC"]["ilErr"] = null;
        $GLOBALS["DIC"]["tree"] = null;
        $GLOBALS["DIC"]["ilAppEventHandler"] = null;
        $GLOBALS["DIC"]["ilSetting"] = new ilSetting();
        $GLOBALS["DIC"]["component.repository"] = $component_repository;
        $GLOBALS["DIC"]["component.factory"] = $component_factory;
        $GLOBALS["DIC"]["ilUser"] = new class () extends ilObjUser {
            public array $prefs = [];
 
            public function __construct()
            {
                $this->prefs["language"] = "en";
            }
        };
        $GLOBALS["DIC"]["tree"] = new class () extends ilTree {
            public function __construct()
            {
            }
        };
 
        if (!defined('DEBUG')) {
            define('DEBUG', false);
        }
 
        if (!defined('SYSTEM_ROLE_ID')) {
            define('SYSTEM_ROLE_ID', '2');
        }
 
        if (!defined("ILIAS_ABSOLUTE_PATH")) {
            define("ILIAS_ABSOLUTE_PATH", dirname(__FILE__, 5));
        }
 
        if (!defined("CLIENT_ID")) {
            define('CLIENT_ID', $client_ini->readVariable('client', 'name'));
        }
 
        if (!defined("ILIAS_WEB_DIR")) {
            define('ILIAS_WEB_DIR', dirname(__DIR__, 4) . "/data/");
        }
 
        // initialise this last to make sure the environment defined here
        // will be available for plugins, ilObjectDefinition will create
        // plugin instances, see https://mantis.ilias.de/view.php?id=40890
        $GLOBALS["DIC"]["objDefinition"] = new ilObjectDefinition();
 
        return $DIC;
    }

References $DIC, $GLOBALS, $ini, __construct(), error(), ilLogLevel\INFO, and ILIAS\UI\examples\MessageBox\Info\info().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isApplicable()

ilComponentInstallPluginObjective::isApplicable ( Setup\Environment $environment )

@inheritDoc

Definition at line 110 of file class.ilComponentInstallPluginObjective.php.

                                                                : bool
    {
        $component_repository = $environment->getResource(Setup\Environment::RESOURCE_COMPONENT_REPOSITORY);
        $plugin = $component_repository->getPluginByName($this->plugin_name);
 
        return !$plugin->isInstalled();
    }

References XapiProxy\$plugin.

◆ isNotable()

ilComponentInstallPluginObjective::isNotable ( )

Definition at line 57 of file class.ilComponentInstallPluginObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

◆ $plugin_name

ilComponentInstallPluginObjective::$plugin_name