ilComponentUpdatePluginObjective Class Reference

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)

Protected Attributes
	$plugin_name

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilComponentUpdatePluginObjective::__construct

(

string

$plugin_name

)

Definition at line 17 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 62 of file class.ilComponentUpdatePluginObjective.php.

References $GLOBALS, XapiProxy\$plugin, ilPlugin\getPluginObject(), and initEnvironment().

                                                            : Setup\Environment
    {
        list($ORIG_DIC, $ORIG_ilDB) = $this->initEnvironment($environment);

        $plugin = $GLOBALS["DIC"]["ilPluginAdmin"]->getRawPluginDataFor($this->plugin_name);

        if (!is_null($plugin) && $plugin['needs_update'] && $plugin['supports_cli_setup']) {
            $pl = ilPlugin::getPluginObject(
                $plugin['component_type'],
                $plugin['component_name'],
                $plugin['slot_id'],
                $plugin['name']
            );

            $pl->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 25 of file class.ilComponentUpdatePluginObjective.php.

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

getLabel()

ilComponentUpdatePluginObjective::getLabel

(

)

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

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

getPreconditions()

ilComponentUpdatePluginObjective::getPreconditions

(

Setup\Environment

$environment

)

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

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

initEnvironment()

ilComponentUpdatePluginObjective::initEnvironment ( Setup\Environment  $environment )

protected

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

References Vendor\Package\$a, $GLOBALS, $ini, __construct(), info(), and ilLogLevel\INFO.

Referenced by achieve(), and isApplicable().

                                                                       : 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"]["ilDB"] = $db;
        $GLOBALS["ilDB"] = $db;
        $GLOBALS["DIC"]["ilIliasIniFile"] = $ini;
        $GLOBALS["DIC"]["ilClientIniFile"] = $client_ini;
        $GLOBALS["DIC"]["ilLogger"] = new class() extends ilLogger {
            public function __construct()
            {
            }
            public function isHandling($a_level)
            {
                return true;
            }
            public function log($a_message, $a_level = ilLogLevel::INFO)
            {
            }
            public function dump($a_variable, $a_level = ilLogLevel::INFO)
            {
            }
            public function debug($a_message, $a_context = array())
            {
            }
            public function info($a_message)
            {
            }
            public function notice($a_message)
            {
            }
            public function warning($a_message)
            {
            }
            public function error($a_message)
            {
            }
            public function critical($a_message)
            {
            }
            public function alert($a_message)
            {
            }
            public function emergency($a_message)
            {
            }
            public function write($a_message, $a_level = ilLogLevel::INFO)
            {
            }
            public function writeLanguageLog($a_topic, $a_lang_key)
            {
            }
            public function logStack($a_level = null, $a_message = '')
            {
            }
            public function writeMemoryPeakUsage($a_level)
            {
            }
        };
        $GLOBALS["DIC"]["ilLog"] = new class() extends ilLog {
            public function __construct()
            {
            }
            public function write($m, $l = ilLogLevel::INFO)
            {
            }
            public function info($msg)
            {
            }
            public function warning($msg)
            {
            }
            public function error($msg)
            {
            }
            public function debug($msg, $a = [])
            {
            }
            public function dump($msg, $a = ilLogLevel::INFO)
            {
            }
        };
        $GLOBALS["DIC"]["ilLoggerFactory"] = new class() extends ilLoggerFactory {
            public function __construct()
            {
            }
            public static function getRootLogger()
            {
                return $GLOBALS["DIC"]["ilLogger"];
            }
            public static function getLogger($a)
            {
                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"]["ilCtrl"] = new ilCtrl();
        $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"]["objDefinition"] = new ilObjectDefinition();
        $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 $prefs = [];

            public function __construct()
            {
                $this->prefs["language"] = "en";
            }
        };

        if (!defined('DEBUG')) {
            define('DEBUG', false);
        }

        if (!defined("ILIAS_ABSOLUTE_PATH")) {
            define("ILIAS_ABSOLUTE_PATH", dirname(__FILE__, 5));
        }

        if (!defined('SYSTEM_ROLE_ID')) {
            define('SYSTEM_ROLE_ID', '2');
        }

        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/");
        }

        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 88 of file class.ilComponentUpdatePluginObjective.php.

References $GLOBALS, XapiProxy\$plugin, and initEnvironment().

                                                                 : bool
    {
        list($ORIG_DIC, $ORIG_ilDB) = $this->initEnvironment($environment);

        $plugin = $GLOBALS["DIC"]["ilPluginAdmin"]->getRawPluginDataFor($this->plugin_name);

        if (is_null($plugin) || !$plugin['supports_cli_setup']) {
            return false;
        }

        $GLOBALS["DIC"] = $ORIG_DIC;
        $GLOBALS["ilDB"] = $ORIG_ilDB;

        return $plugin['needs_update'];
    }

Here is the call graph for this function:

isNotable()

ilComponentUpdatePluginObjective::isNotable

(

)

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

                                : bool
    {
        return true;
    }

Field Documentation

$plugin_name

ilComponentUpdatePluginObjective::$plugin_name

protected

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

Referenced by __construct().

---

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

• Services/Component/classes/Setup/class.ilComponentUpdatePluginObjective.php