ilPluginAdmin Class Reference

Administration class for plugins. More...

Collaboration diagram for ilPluginAdmin:

Public Member Functions
	__construct ()
	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...

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	includeClass ( $a_ctype, $a_cname, $a_slot_id, $a_pname, $a_class_file_name)
	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...

Data Fields
	$got_data = false

Static Public Attributes
static	$active_plugins = array()
static	$plugin_objects = 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...

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.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilPluginAdmin::__construct

(

)

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

References $lng.

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

Member Function Documentation

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

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

References data, and getPluginData().

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

Here is the call graph for this function:

getActivePlugins()

static ilPluginAdmin::getActivePlugins ( )

static

Get info for all active plugins.

Returns

array

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

References array, and ilCachedComponentData\getInstance().

Referenced by ilAppEventHandler\raise().

    {
        $cached_component = ilCachedComponentData::getInstance();
        $plugins = $cached_component->getIlPluginActive();
        $buf = array();
        foreach ($plugins as $slot => $plugs) {
            $buf = array_merge($buf, $plugs);
        }
        return $buf;
    }

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.

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

References ilPlugin\getActivePluginsForSlot().

Referenced by ilDclPluginFieldRepresentation\buildFieldCreationInput(), and ilAppEventHandler\raise().

    {
        // cache the list of active plugins
        if (!isset(self::$active_plugins[$a_ctype][$a_cname][$a_slot_id])) {
            include_once "./Services/Component/classes/class.ilPlugin.php";

            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];
    }

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

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

References data, and getPluginData().

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

Here is the call graph for this function:

getAllPlugins()

static ilPluginAdmin::getAllPlugins ( )

static

Get info for all plugins.

Returns

array<string, array>

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

References ilCachedComponentData\getInstance().

    {
        $cached_component = ilCachedComponentData::getInstance();
        return $cached_component->getIlPluginById();
    }

Here is the call 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

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

References data, and getPluginData().

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

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

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

References data, and getPluginData().

    {
        $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"];
    }

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

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

References data, and getPluginData().

    {
        $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"];
    }

Here is the call graph for this function:

getPluginData()

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

finalprivate

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

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

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

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

    {
        //Can not use DIC because it is not initialized if plugin is activated
        global $lng;
        $this->lng = $lng;

        if (!isset($this->got_data[$a_ctype][$a_cname][$a_slot_id][$a_pname])) {
            include_once "./Services/Component/classes/class.ilPluginSlot.php";
            $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;
        }
    }

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 374 of file class.ilPluginAdmin.php.

References ilPlugin\getPluginObject().

Referenced by ilSoapHook\__construct(), ilUIHookProcessor\__construct(), ilTestSignatureGUI\__construct(), ilTabsGUI\__getHTML(), ilStartUpGUI\_checkGoto(), ilTemplate\addBlockFile(), ilDclPluginFieldRepresentation\buildFieldCreationInput(), ilObjComponentSettingsGUI\executeCommand(), ilTemplate\get(), ilContainerGUI\getAsynchItemListObject(), ilInitialisation\initStyle(), ilRendererFactory\loadAvailableRenderers(), ilTemplate\loadTemplatefile(), ilAppEventHandler\raise(), ilCtrl\redirectToURL(), ilObjContentObjectGUI\setilLMMenu(), and ilTemplate\show().

    {
        // 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];
    }

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

Exceptions

InvalidArgumentException

if no plugin with that id is found

Returns

ilPlugin

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

References $id.

    {
        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']
        );
    }

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

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

References data, and getPluginData().

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

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

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

References data, and getPluginData().

    {
        $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"];
    }

Here is the call graph for this function:

includeClass()

static ilPluginAdmin::includeClass (   $a_ctype,   $a_cname,   $a_slot_id,   $a_pname,   $a_class_file_name  )

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 393 of file class.ilPluginAdmin.php.

References ilPlugin\getPluginObject().

      {
        // 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);
        }
        $pl = self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname];
        $pl->includeClass($a_class_file_name);
    }

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

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

References data, and getPluginData().

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

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 472 of file class.ilPluginAdmin.php.

References $id, and ilCachedComponentData\getInstance().

    {
        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;
    }

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

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

References data, and getPluginData().

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

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 216 of file class.ilPluginAdmin.php.

References $id, and $version.

Referenced by getPluginData().

    {
        include_once($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,
            "supports_export" => (bool) $supports_export
        ];

        return $values;
    }

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 92 of file class.ilPluginAdmin.php.

References ILIAS_VERSION_NUMERIC, and ilComponent\isVersionGreaterString().

Referenced by getPluginData().

    {
        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 (is_object($this->lng)) {
                $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 (is_object($this->lng)) {
                $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;
    }

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 200 of file class.ilPluginAdmin.php.

Referenced by getPluginData().

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

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 175 of file class.ilPluginAdmin.php.

Referenced by getPluginData().

    {
        $plugin_data["must_install"] = true;
        $plugin_data["is_active"] = false;
        $plugin_data["needs_update"] = false;
        $plugin_data["activation_possible"] = false;

        if (is_object($this->lng)) {
            $inactive_reason = $this->lng->txt("cmps_must_installed");
        } else {
            $inactive_reason = "Plugin must be installed.";
        }
        $plugin_data["inactive_reason"] = $inactive_reason;
    }

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

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

References data, and getPluginData().

    {
        $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"];
    }

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 134 of file class.ilPluginAdmin.php.

References ilComponent\isVersionGreaterString().

Referenced by getPluginData().

    {
        if ($last_update_version == "") {
            $plugin_data["is_active"] = false;
            if (is_object($this->lng)) {
                $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;
        } elseif (ilComponent::isVersionGreaterString($last_update_version, $plugin_data["version"])) {
            $plugin_data["is_active"] = false;
            if (is_object($this->lng)) {
                $inactive_reason = $this->lng->txt("cmps_needs_upgrade");
            } else {
                $inactive_reason = "Upgrade needed.";
            }
            $plugin_data["inactive_reason"] = $inactive_reason;
            $plugin_data["activation_possible"] = false;
        } elseif ($last_update_version != $plugin_data["version"]) {
            $plugin_data["is_active"] = false;
            if (is_object($this->lng)) {
                $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;
        }
    }

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 24 of file class.ilPluginAdmin.php.

$got_data

ilPluginAdmin::$got_data = false

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

$plugin_objects

ilPluginAdmin::$plugin_objects = array()

static

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

---

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

• Services/Component/classes/class.ilPluginAdmin.php