Administration class for plugins. More...

Collaboration diagram for ilPluginAdmin:

Public Member Functions
	__construct ()
	ilPluginAdmin constructor. More...

	getVersion ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get version of plugin. More...

	getIliasMinVersion ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get Ilias Min Version. More...

	getIliasMaxVersion ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get Ilias Max Version. More...

	getId ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get ID. More...

	isActive ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Checks whether plugin is active (include version checks) More...

	exists ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Checks whether plugin exists. More...

	needsUpdate ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get version. More...

	getAllData ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get all data from file in an array. More...

	hasLearningProgress ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Checks whether plugin has active learning progress. More...

	supportsExport ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Checks whether plugin supports export/import. More...

	getRawPluginDataFor (string $name)

	clearCachedData ()

Static Public Member Functions
static	getActivePluginsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get all active plugins for a slot. More...

static	getPluginObject ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get Plugin Object. More...

static	getAllPlugins ()
	Get info for all plugins. More...

static	getActivePlugins ()
	Get info for all active plugins. More...

static	isPluginActive ($id)
	Check, if a plugin is active. More...

static	getPluginObjectById ($id)
	Get a plugin-object by id. More...

static	getAllGlobalScreenProviders ()

Static Public Attributes
static	$active_plugins = array()

Protected Member Functions
	pluginSupportCurrentILIAS (array &$plugin_data)
	Plugin supports current ILIAS. More...

	updateRequired (array &$plugin_data, $last_update_version)
	Should the plugin be updated. More...

	setMustInstall (array &$plugin_data)
	Set plugin data for intall. More...

	setCurrentState (array &$plugin_data, $active)
	Set current state to static values, excluding active and activatoin possible. More...

	parsePluginPhp ($plugin_php_file)
	Get informations from plugin php file. More...

	getPluginSlots (array $components, string $type)

	getComponentSlotsByType (array $components, string $type)

Protected Attributes
	$data

	$got_data = false

	$lng

Static Protected Attributes
static	$plugin_objects = array()

Private Member Functions
	getPluginData ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get basic data of plugin from plugin.php. More...

Detailed Description

Administration class for plugins.

Handles basic data from plugin.php files.

This class currently needs refactoring. There are a lot of methods which are related to some specific slots.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 17 of file class.ilPluginAdmin.php.

Constructor & Destructor Documentation

◆ __construct()

ilPluginAdmin::__construct ( )

ilPluginAdmin constructor.

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

    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule("cmps");
    }

References $DIC.

Member Function Documentation

◆ clearCachedData()

ilPluginAdmin::clearCachedData ( )

final

Definition at line 681 of file class.ilPluginAdmin.php.

    {
        unset($this->data);
        unset($this->got_data);
        ilCachedComponentData::flush();
    }

References ilCachedComponentData\flush().

Referenced by getRawPluginDataFor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exists()

ilPluginAdmin::exists	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Checks whether plugin exists.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: bool

Exceptions

ilPluginException

Definition at line 363 of file class.ilPluginAdmin.php.

    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        return isset($this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]);
    }

References getPluginData().

Here is the call graph for this function:

◆ getActivePlugins()

static ilPluginAdmin::getActivePlugins ( )

static

Get info for all active plugins.

Returns: array

Definition at line 538 of file class.ilPluginAdmin.php.

    {
        static $active_plugins;
        if (!isset($active_plugins)) {
            $cached_component = ilCachedComponentData::getInstance();
            $plugins = $cached_component->getIlPluginActive();
            $buf = array();
            foreach ($plugins as $slot => $plugs) {
                $buf[] = $plugs;
            }
 
            $active_plugins = array_merge([], ...$buf);
        }
 
        return $active_plugins;
    }

References $active_plugins, and ilCachedComponentData\getInstance().

Referenced by ilInitialisation\initUIFramework().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActivePluginsForSlot()

static ilPluginAdmin::getActivePluginsForSlot	(	$a_ctype,
		$a_cname,
		$a_slot_id
	)

static

Get all active plugins for a slot.

Parameters

string	$a_ctype
string	$a_cname
string	$a_slot_id

Returns: array

Definition at line 418 of file class.ilPluginAdmin.php.

    {
        // cache the list of active plugins
        if (!isset(self::$active_plugins[$a_ctype][$a_cname][$a_slot_id])) {
            self::$active_plugins[$a_ctype][$a_cname][$a_slot_id]
                = ilPlugin::getActivePluginsForSlot($a_ctype, $a_cname, $a_slot_id);
        }
 
        return self::$active_plugins[$a_ctype][$a_cname][$a_slot_id];
    }

References ilPlugin\getActivePluginsForSlot().

Referenced by ilDclPluginFieldRepresentation\buildFieldCreationInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllData()

ilPluginAdmin::getAllData	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Get all data from file in an array.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: array

Exceptions

ilPluginException

Definition at line 401 of file class.ilPluginAdmin.php.

    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname];
    }

References getPluginData().

Here is the call graph for this function:

◆ getAllGlobalScreenProviders()

static ilPluginAdmin::getAllGlobalScreenProviders ( )

static

Deprecated:

Returns: \ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticPluginMainMenuProvider[]

Definition at line 606 of file class.ilPluginAdmin.php.

                                                         : array
    {
        $providers = array();
        // return array(); // current fix
        foreach (self::getActivePlugins() as $plugin) {
            $pl = self::getPluginObjectById($plugin['plugin_id']);
            if ($pl->isActive()) {
                array_push($providers, $pl->promoteGlobalScreenProvider());
            }
        }
 
        return $providers;
    }

References XapiProxy\$plugin, and getPluginObjectById().

Referenced by ilGSProviderFactory\appendPlugins().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllPlugins()

static ilPluginAdmin::getAllPlugins ( )

static

Get info for all plugins.

Returns: array<string, array>

Definition at line 521 of file class.ilPluginAdmin.php.

    {
        static $all_plugins;
        if (!isset($all_plugins)) {
            $cached_component = ilCachedComponentData::getInstance();
            $all_plugins = $cached_component->getIlPluginById();
        }
 
        return $all_plugins;
    }

References ilCachedComponentData\getInstance().

Referenced by getPluginObjectById().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponentSlotsByType()

ilPluginAdmin::getComponentSlotsByType	(	array	$components,
		string	$type
	)

protected

Definition at line 669 of file class.ilPluginAdmin.php.

                                                                                : \Iterator
    {
        foreach ($components as $component) {
            $component_slots = ilComponent::lookupPluginSlots($type, $component["subdir"]);
            foreach ($component_slots as $component_slot) {
                if (count($component_slot) > 0) {
                    yield $component_slot;
                }
            }
        }
    }

References $type, and ilComponent\lookupPluginSlots().

Referenced by getPluginSlots().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilPluginAdmin::getId	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Get ID.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: string

Exceptions

ilPluginException

Definition at line 322 of file class.ilPluginAdmin.php.

    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["id"];
    }

References getPluginData().

Here is the call graph for this function:

◆ getIliasMaxVersion()

ilPluginAdmin::getIliasMaxVersion	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Get Ilias Max Version.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: string

Exceptions

ilPluginException

Definition at line 303 of file class.ilPluginAdmin.php.

    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["ilias_max_version"];
    }

References getPluginData().

Here is the call graph for this function:

◆ getIliasMinVersion()

ilPluginAdmin::getIliasMinVersion	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Get Ilias Min Version.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: string

Exceptions

ilPluginException

Definition at line 284 of file class.ilPluginAdmin.php.

    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["ilias_min_version"];
    }

References getPluginData().

Here is the call graph for this function:

◆ getPluginData()

ilPluginAdmin::getPluginData	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

private

Get basic data of plugin from plugin.php.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Exceptions

ilPluginException

Definition at line 67 of file class.ilPluginAdmin.php.

    {
        if (!isset($this->got_data[$a_ctype][$a_cname][$a_slot_id][$a_pname])) {
            $slot_name = ilPluginSlot::lookupSlotName($a_ctype, $a_cname, $a_slot_id);
 
            $plugin_php_file = "./Customizing/global/plugins/" . $a_ctype . "/" . $a_cname . "/" . $slot_name . "/" . $a_pname . "/plugin.php";
 
            if (!is_file($plugin_php_file)) {
                throw new ilPluginException("No plugin.php file found for Plugin :" . $a_pname . ".");
            }
            $plugin_db_data = ilPlugin::getPluginRecord($a_ctype, $a_cname, $a_slot_id, $a_pname);
            $plugin_data = $this->parsePluginPhp($plugin_php_file);
 
            if ($plugin_db_data["plugin_id"] === null) {
                $this->setMustInstall($plugin_data);
            } else {
                $this->setCurrentState($plugin_data, (bool) $plugin_db_data["active"]);
                if ($this->pluginSupportCurrentILIAS($plugin_data)) {
                    $this->updateRequired($plugin_data, $plugin_db_data["last_update_version"]);
                }
            }
 
            $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname] = $plugin_data;
            $this->got_data[$a_ctype][$a_cname][$a_slot_id][$a_pname] = true;
        }
    }

References ilPlugin\getPluginRecord(), ilPluginSlot\lookupSlotName(), parsePluginPhp(), pluginSupportCurrentILIAS(), setCurrentState(), setMustInstall(), and updateRequired().

Referenced by exists(), getAllData(), getId(), getIliasMaxVersion(), getIliasMinVersion(), getVersion(), hasLearningProgress(), isActive(), needsUpdate(), and supportsExport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginObject()

static ilPluginAdmin::getPluginObject	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

static

Get Plugin Object.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: ilPlugin the plugin

Definition at line 440 of file class.ilPluginAdmin.php.

    {
        // cache the plugin objects
        if (!isset(self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname])) {
            self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname]
                = ilPlugin::getPluginObject($a_ctype, $a_cname, $a_slot_id, $a_pname);
        }
 
        return self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname];
    }

References ilPlugin\getPluginObject().

Referenced by ilTestSignatureGUI\__construct(), ilTabsGUI\__getHTML(), ilStartUpGUI\_checkGoto(), ilTemplate\addBlockFile(), ilDclPluginFieldRepresentation\buildFieldCreationInput(), ilObjComponentSettingsGUI\executeCommand(), ilTemplate\get(), ilContainerGUI\getAsynchItemListObject(), getPluginObjectById(), ilInitialisation\initStyle(), ilInitialisation\initUIFramework(), ilRendererFactory\loadAvailableRenderers(), ilTemplate\loadTemplatefile(), ilDataCollectionGlobalTemplate\printToStdout(), ilCOPageGlobalTemplate\printToStdout(), ilRTEGlobalTemplate\printToStdout(), ilCtrl\redirectToURL(), ILIAS\Services\UICore\MetaTemplate\PageContentGUI\renderPage(), ilGlobalTemplate\renderPage(), and ilObjContentObjectGUI\setilLMMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginObjectById()

static ilPluginAdmin::getPluginObjectById ( $id )

static

Get a plugin-object by id.

Parameters

string $id id of the plugin

Returns: ilPlugin

Exceptions

InvalidArgumentException if no plugin with that id is found

Definition at line 584 of file class.ilPluginAdmin.php.

    {
        assert(is_string($id));
        $plugs = self::getAllPlugins();
        if (!array_key_exists($id, $plugs)) {
            throw new \InvalidArgumentException("Plugin does not exist: " . $id, 1);
        }
        $pdata = $plugs[$id];
 
        return self::getPluginObject(
            $pdata['component_type'],
            $pdata['component_name'],
            $pdata['slot_id'],
            $pdata['name']
        );
    }

References getAllPlugins(), and getPluginObject().

Referenced by getAllGlobalScreenProviders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginSlots()

ilPluginAdmin::getPluginSlots	(	array	$components,
		string	$type
	)

protected

Definition at line 661 of file class.ilPluginAdmin.php.

                                                                       : \Iterator
    {
        foreach ($this->getComponentSlotsByType($components, $type) as $slot) {
            $subdir = (explode('/', $slot['component']))[1];
            yield new ilPluginSlot($type, $subdir, $slot['id']);
        }
    }

References $type, and getComponentSlotsByType().

Referenced by getRawPluginDataFor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRawPluginDataFor()

ilPluginAdmin::getRawPluginDataFor ( string $name )

Definition at line 637 of file class.ilPluginAdmin.php.

                                                      : ?array
    {
        $this->clearCachedData();
 
        $modules = ilModule::getAvailableCoreModules();
        $services = ilService::getAvailableCoreServices();
 
        foreach ($this->getPluginSlots($modules, IL_COMP_MODULE) as $plugin_slot) {
            $plugin = $plugin_slot->getPluginInformationFor($name);
            if (!is_null($plugin)) {
                return $plugin;
            }
        }
 
        foreach ($this->getPluginSlots($services, IL_COMP_SERVICE) as $plugin_slot) {
            $plugin = $plugin_slot->getPluginInformationFor($name);
            if (!is_null($plugin)) {
                return $plugin;
            }
        }
 
        return null;
    }

References $name, XapiProxy\$plugin, clearCachedData(), ilModule\getAvailableCoreModules(), ilService\getAvailableCoreServices(), getPluginSlots(), IL_COMP_MODULE, and IL_COMP_SERVICE.

Here is the call graph for this function:

◆ getVersion()

ilPluginAdmin::getVersion	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Get version of plugin.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: string

Exceptions

ilPluginException

Definition at line 265 of file class.ilPluginAdmin.php.

    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["version"];
    }

References getPluginData().

Here is the call graph for this function:

◆ hasLearningProgress()

ilPluginAdmin::hasLearningProgress	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Checks whether plugin has active learning progress.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: bool

Exceptions

ilPluginException

Definition at line 490 of file class.ilPluginAdmin.php.

    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["learning_progress"];
    }

References getPluginData().

Here is the call graph for this function:

◆ isActive()

ilPluginAdmin::isActive	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Checks whether plugin is active (include version checks)

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: bool

Definition at line 340 of file class.ilPluginAdmin.php.

    {
        try {
            $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
        } catch (ilPluginException $e) {
            return false;
        }
 
        return (bool) $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["is_active"];
    }

References Vendor\Package\$e, and getPluginData().

Here is the call graph for this function:

◆ isPluginActive()

static ilPluginAdmin::isPluginActive ( $id )

static

Check, if a plugin is active.

Parameters

string $id id of the plugin

Returns: boolean

Definition at line 563 of file class.ilPluginAdmin.php.

    {
        assert(is_string($id));
        $cached_component = ilCachedComponentData::getInstance();
        $plugs = $cached_component->getIlPluginById();
        if (array_key_exists($id, $plugs) && $plugs[$id]['active']) {
            return true;
        }
 
        return false;
    }

References ilCachedComponentData\getInstance().

Here is the call graph for this function:

◆ needsUpdate()

ilPluginAdmin::needsUpdate	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Get version.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: bool

Exceptions

ilPluginException

Definition at line 382 of file class.ilPluginAdmin.php.

    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        return (bool) $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["needs_update"];
    }

References getPluginData().

Here is the call graph for this function:

◆ parsePluginPhp()

ilPluginAdmin::parsePluginPhp ( $plugin_php_file )

protected

Get informations from plugin php file.

Parameters

string $plugin_php_file

Returns: string[]

Definition at line 234 of file class.ilPluginAdmin.php.

    {
        include($plugin_php_file);
 
        $values = [
            "version" => $version,
            "id" => $id,
            "ilias_min_version" => $ilias_min_version,
            "ilias_max_version" => $ilias_max_version,
            "responsible" => $responsible,
            "responsible_mail" => $responsible_mail,
            "learning_progress" => (bool) ($learning_progress ?? false),
            "supports_export" => (bool) ($supports_export ?? false),
            "supports_cli_setup" => (bool) ($supports_cli_setup ?? true)
        ];
 
        return $values;
    }

Referenced by getPluginData().

Here is the caller graph for this function:

◆ pluginSupportCurrentILIAS()

ilPluginAdmin::pluginSupportCurrentILIAS ( array & $plugin_data )

protected

Plugin supports current ILIAS.

Parameters

string[] &$plugin_data

Returns: bool

Definition at line 102 of file class.ilPluginAdmin.php.

    {
        if (ilComponent::isVersionGreaterString($plugin_data["ilias_min_version"], ILIAS_VERSION_NUMERIC)) {
            $plugin_data["is_active"] = false;
            $plugin_data["needs_update"] = false;
            $plugin_data["activation_possible"] = false;
 
            if ($this->lng instanceof ilLanguage) {
                $inactive_reason = $this->lng->txt("cmps_needs_newer_ilias_version");
            } else {
                $inactive_reason = "Plugin needs a newer version of ILIAS.";
            }
            $plugin_data["inactive_reason"] = $inactive_reason;
 
            return false;
        }
 
        if (ilComponent::isVersionGreaterString(ILIAS_VERSION_NUMERIC, $plugin_data["ilias_max_version"])) {
            $plugin_data["is_active"] = false;
            $plugin_data["needs_update"] = false;
            $plugin_data["activation_possible"] = false;
            if ($this->lng instanceof ilLanguage) {
                $inactive_reason = $this->lng->txt("cmps_needs_newer_plugin_version");
            } else {
                $inactive_reason = "Plugin does not support current version of ILIAS. Newer version of plugin needed.";
            }
            $plugin_data["inactive_reason"] = $inactive_reason;
 
            return false;
        }
 
        return true;
    }

References ILIAS_VERSION_NUMERIC, and ilComponent\isVersionGreaterString().

Referenced by getPluginData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentState()

ilPluginAdmin::setCurrentState	(	array &	$plugin_data,
			$active
	)

protected

Set current state to static values, excluding active and activatoin possible.

There will be set from db value $active

Parameters

string[]	&$plugin_data
bool	$active

Returns: void

Definition at line 217 of file class.ilPluginAdmin.php.

    {
        $plugin_data["is_active"] = $active;
        $plugin_data["activation_possible"] = !$active;
        $plugin_data["must_install"] = false;
        $plugin_data["needs_update"] = false;
        $plugin_data["inactive_reason"] = "";
    }

Referenced by getPluginData().

Here is the caller graph for this function:

◆ setMustInstall()

ilPluginAdmin::setMustInstall ( array & $plugin_data )

protected

Set plugin data for intall.

Parameters

string[] &$plugin_data

Returns: void

Definition at line 191 of file class.ilPluginAdmin.php.

    {
        $plugin_data["must_install"] = true;
        $plugin_data["is_active"] = false;
        $plugin_data["needs_update"] = false;
        $plugin_data["activation_possible"] = false;
 
        if ($this->lng instanceof ilLanguage) {
            $inactive_reason = $this->lng->txt("cmps_must_installed");
        } else {
            $inactive_reason = "Plugin must be installed.";
        }
        $plugin_data["inactive_reason"] = $inactive_reason;
    }

Referenced by getPluginData().

Here is the caller graph for this function:

◆ supportsExport()

ilPluginAdmin::supportsExport	(	$a_ctype,
		$a_cname,
		$a_slot_id,
		$a_pname
	)

Checks whether plugin supports export/import.

Parameters

string	$a_ctype	Component Type
string	$a_cname	Component Name
string	$a_slot_id	Slot ID
string	$a_pname	Plugin Name

Returns: bool

Exceptions

ilPluginException

Definition at line 509 of file class.ilPluginAdmin.php.

    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["supports_export"];
    }

References getPluginData().

Here is the call graph for this function:

◆ updateRequired()

ilPluginAdmin::updateRequired	(	array &	$plugin_data,
			$last_update_version
	)

protected

Should the plugin be updated.

Parameters

string[]	&$plugin_data
string	$last_update_version

Returns: void

Definition at line 145 of file class.ilPluginAdmin.php.

    {
        if ($last_update_version == "") {
            $plugin_data["is_active"] = false;
            if ($this->lng instanceof ilLanguage) {
                $inactive_reason = $this->lng->txt("cmps_needs_update");
            } else {
                $inactive_reason = "Update needed.";
            }
            $plugin_data["inactive_reason"] = $inactive_reason;
            $plugin_data["needs_update"] = true;
            $plugin_data["activation_possible"] = false;
        } else {
            if (ilComponent::isVersionGreaterString($last_update_version, $plugin_data["version"])) {
                $plugin_data["is_active"] = false;
                if ($this->lng instanceof ilLanguage) {
                    $inactive_reason = $this->lng->txt("cmps_needs_upgrade");
                } else {
                    $inactive_reason = "Upgrade needed.";
                }
                $plugin_data["inactive_reason"] = $inactive_reason;
                $plugin_data["activation_possible"] = false;
            } else {
                if ($last_update_version != $plugin_data["version"]) {
                    $plugin_data["is_active"] = false;
                    if ($this->lng instanceof ilLanguage) {
                        $inactive_reason = $this->lng->txt("cmps_needs_update");
                    } else {
                        $inactive_reason = "Update needed.";
                    }
                    $plugin_data["inactive_reason"] = $inactive_reason;
                    $plugin_data["needs_update"] = true;
                    $plugin_data["activation_possible"] = false;
                }
            }
        }
    }

References ilComponent\isVersionGreaterString().

Referenced by getPluginData().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $active_plugins

ilPluginAdmin::$active_plugins = array()

static

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

Referenced by getActivePlugins().

◆ $data

ilPluginAdmin::$data

protected

Definition at line 23 of file class.ilPluginAdmin.php.

◆ $got_data

ilPluginAdmin::$got_data = false

protected

Definition at line 27 of file class.ilPluginAdmin.php.

◆ $lng

ilPluginAdmin::$lng

protected

Definition at line 43 of file class.ilPluginAdmin.php.

◆ $plugin_objects

ilPluginAdmin::$plugin_objects = array()

staticprotected

Definition at line 39 of file class.ilPluginAdmin.php.

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

Services/Component/classes/class.ilPluginAdmin.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearCachedData()

◆ exists()

◆ getActivePlugins()

◆ getActivePluginsForSlot()

◆ getAllData()

◆ getAllGlobalScreenProviders()

◆ getAllPlugins()

◆ getComponentSlotsByType()

◆ getId()

◆ getIliasMaxVersion()

◆ getIliasMinVersion()

◆ getPluginData()

◆ getPluginObject()

◆ getPluginObjectById()

◆ getPluginSlots()

◆ getRawPluginDataFor()

◆ getVersion()

◆ hasLearningProgress()

◆ isActive()

◆ isPluginActive()

◆ needsUpdate()

◆ parsePluginPhp()

◆ pluginSupportCurrentILIAS()

◆ setCurrentState()

◆ setMustInstall()

◆ supportsExport()

◆ updateRequired()

Field Documentation

◆ $active_plugins

◆ $data

◆ $got_data

◆ $lng

◆ $plugin_objects