Inheritance diagram for ilComponentUpdatePluginObjective:

Collaboration diagram for ilComponentUpdatePluginObjective:

Public Member Functions
	__construct (string $plugin_name)

	getHash ()

	getLabel ()

	isNotable ()

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

	isApplicable (Setup\Environment $environment)

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.ilComponentUpdatePluginObjective.php.

Constructor & Destructor Documentation

◆ __construct()

ilComponentUpdatePluginObjective::__construct ( string $plugin_name )

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

References $plugin_name.

Referenced by initEnvironment().

     {
         $this->plugin_name = $plugin_name;
     }

Here is the caller graph for this function:

Member Function Documentation

◆ achieve()

ilComponentUpdatePluginObjective::achieve ( Setup\Environment $environment )

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

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

                                                            : 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->isUpdateRequired()) {
             throw new \RuntimeException(
                 "Plugin $this->plugin_name is already updated."
             );
         }
 
         [$ORIG_DIC, $ORIG_ilDB] = $this->initEnvironment($environment, $component_repository, $component_factory);
         $plugin = $component_factory->getPlugin($info->getId());
         $plugin->update();
         $GLOBALS["DIC"] = $ORIG_DIC;
         $GLOBALS["ilDB"] = $ORIG_ilDB;
 
         return $environment;
     }

Here is the call graph for this function:

◆ getHash()

ilComponentUpdatePluginObjective::getHash ( )

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

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

◆ getLabel()

ilComponentUpdatePluginObjective::getLabel ( )

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

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

◆ getPreconditions()

ilComponentUpdatePluginObjective::getPreconditions ( Setup\Environment $environment )

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

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

◆ initEnvironment()

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

protected

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

References $GLOBALS, $ini, __construct(), and null.

Referenced by achieve().

      : array {
         $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.
         $ORIG_DIC = $GLOBALS["DIC"];
         $ORIG_ilDB = $GLOBALS["ilDB"];
 
         $GLOBALS["DIC"] = new DI\Container();
         $GLOBALS["DIC"]["component.repository"] = $component_repository;
         $GLOBALS["DIC"]["component.factory"] = $component_factory;
         $GLOBALS["DIC"]["ilDB"] = $db;
         $GLOBALS["ilDB"] = $db;
         $GLOBALS["DIC"]["ilIliasIniFile"] = $ini;
         $GLOBALS["DIC"]["ilClientIniFile"] = $client_ini;
         $GLOBALS["DIC"]["ilLogger"] = new NullLogger();
         $GLOBALS["DIC"]["ilLog"] = new NullLogger();
         $GLOBALS["DIC"]["ilLoggerFactory"] = new class () extends ilLoggerFactory {
             public function __construct()
             {
             }
             public static function getRootLogger(): ilLogger
             {
                 return $GLOBALS["DIC"]["ilLogger"];
             }
             public static function getLogger(string $a_component_id): ilLogger
             {
                 return $GLOBALS["DIC"]["ilLogger"];
             }
         };
         $GLOBALS["ilLog"] = $GLOBALS["DIC"]["ilLog"];
         $GLOBALS["DIC"]["ilBench"] = null;
         $GLOBALS["DIC"]["lng"] = new ilLanguage('en');
         $GLOBALS["DIC"]["ilPluginAdmin"] = $plugin_admin;
         $GLOBALS["DIC"]["ilias"] = null;
         $GLOBALS["DIC"]["ilErr"] = null;
         $GLOBALS["DIC"]["tree"] = new class () extends ilTree {
             public function __construct()
             {
             }
         };
         $GLOBALS["DIC"]["ilAppEventHandler"] = new class () extends ilAppEventHandler {
             public function __construct()
             {
             }
             public function raise($a_component, $a_event, $a_parameter = ""): void
             {
             }
         };
         $GLOBALS["DIC"]["ilObjDataCache"] = new ilObjectDataCache();
         $GLOBALS["DIC"]["ilSetting"] = new ilSetting();
         $GLOBALS["DIC"]["rbacadmin"] = new class () extends ilRbacAdmin {
             public function __construct()
             {
             }
         };
         $GLOBALS["DIC"]["rbacreview"] = new class () extends ilRbacReview {
             public function __construct()
             {
             }
         };
         $GLOBALS["DIC"]["ilUser"] = new class () extends ilObjUser {
             public array $prefs = [];
 
             public function __construct()
             {
                 $this->prefs["language"] = "en";
             }
         };
 
         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__, 6));
         }
 
         if (!defined("CLIENT_ID")) {
             define('CLIENT_ID', $client_ini->readVariable('client', 'name'));
         }
 
         if (!defined("ILIAS_WEB_DIR")) {
             define('ILIAS_WEB_DIR', "public/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 [$ORIG_DIC, $ORIG_ilDB];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isApplicable()

ilComponentUpdatePluginObjective::isApplicable ( Setup\Environment $environment )

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

References XapiProxy\$plugin.

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

◆ isNotable()

ilComponentUpdatePluginObjective::isNotable ( )

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

                                : bool
     {
         return true;
     }

Field Documentation

◆ $plugin_name

ilComponentUpdatePluginObjective::$plugin_name