|
ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
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... | |
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... | |
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... | |
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.
Definition at line 17 of file class.ilPluginAdmin.php.
| ilPluginAdmin::__construct | ( | ) |
ilPluginAdmin constructor.
Definition at line 49 of file class.ilPluginAdmin.php.
References $DIC.
| ilPluginAdmin::exists | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Checks whether plugin exists.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 361 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:
|
static |
Get info for all active plugins.
Definition at line 533 of file class.ilPluginAdmin.php.
References ilCachedComponentData\getInstance().
Here is the call graph for this function:
|
static |
Get all active plugins for a slot.
| string | $a_ctype | |
| string | $a_cname | |
| string | $a_slot_id |
Definition at line 416 of file class.ilPluginAdmin.php.
References ilPlugin\getActivePluginsForSlot().
Referenced by ilDclPluginFieldRepresentation\buildFieldCreationInput().
Here is the call graph for this function:
Here is the caller graph for this function:| ilPluginAdmin::getAllData | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Get all data from file in an array.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 399 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:
|
static |
Definition at line 595 of file class.ilPluginAdmin.php.
References getPluginObjectById(), and ilPlugin\isActive().
Referenced by ilGSProviderFactory\appendPlugins(), and ilMMItemRepository\sync().
Here is the call graph for this function:
Here is the caller graph for this function:
|
static |
Get info for all plugins.
Definition at line 520 of file class.ilPluginAdmin.php.
References ilCachedComponentData\getInstance().
Referenced by getPluginObjectById().
Here is the call graph for this function:
Here is the caller graph for this function:| ilPluginAdmin::getId | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Get ID.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 320 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:| ilPluginAdmin::getIliasMaxVersion | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Get Ilias Max Version.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 301 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:| ilPluginAdmin::getIliasMinVersion | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Get Ilias Min Version.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 282 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:
|
finalprivate |
Get basic data of plugin from plugin.php.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 67 of file class.ilPluginAdmin.php.
References data, 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:
|
static |
Get Plugin Object.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
Definition at line 438 of file class.ilPluginAdmin.php.
References ilPlugin\getPluginObject().
Referenced by ilUIHookProcessor\__construct(), ilTestSignatureGUI\__construct(), ilTabsGUI\__getHTML(), ilStartUpGUI\_checkGoto(), ilTemplate\addBlockFile(), ilDclPluginFieldRepresentation\buildFieldCreationInput(), ilObjComponentSettingsGUI\executeCommand(), ilTemplate\get(), ilContainerGUI\getAsynchItemListObject(), getPluginObjectById(), ilInitialisation\initStyle(), ilRendererFactory\loadAvailableRenderers(), ilTemplate\loadTemplatefile(), ilCtrl\redirectToURL(), ilObjContentObjectGUI\setilLMMenu(), and ilTemplate\show().
Here is the call graph for this function:
Here is the caller graph for this function:
|
static |
Get a plugin-object by id.
| string | $id | id of the plugin |
| InvalidArgumentException | if no plugin with that id is found |
Definition at line 574 of file class.ilPluginAdmin.php.
References $id, getAllPlugins(), and getPluginObject().
Referenced by getAllGlobalScreenProviders().
Here is the call graph for this function:
Here is the caller graph for this function:| ilPluginAdmin::getVersion | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Get version of plugin.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 263 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:| ilPluginAdmin::hasLearningProgress | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Checks whether plugin has active learning progress.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 488 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:| ilPluginAdmin::isActive | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Checks whether plugin is active (include version checks)
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
Definition at line 338 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:
|
static |
Check, if a plugin is active.
| string | $id | id of the plugin |
Definition at line 553 of file class.ilPluginAdmin.php.
References $id, and ilCachedComponentData\getInstance().
Here is the call graph for this function:| ilPluginAdmin::needsUpdate | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Get version.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 380 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:
|
protected |
Get informations from plugin php file.
| string | $plugin_php_file |
Definition at line 235 of file class.ilPluginAdmin.php.
References $id, $values, and $version.
Referenced by getPluginData().
Here is the caller graph for this function:
|
protected |
Plugin supports current ILIAS.
| string[] | &$plugin_data |
Definition at line 103 of file class.ilPluginAdmin.php.
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:
|
protected |
Set current state to static values, excluding active and activatoin possible.
There will be set from db value $active
| string[] | &$plugin_data | |
| bool | $active |
Definition at line 218 of file class.ilPluginAdmin.php.
Referenced by getPluginData().
Here is the caller graph for this function:
|
protected |
Set plugin data for intall.
| string[] | &$plugin_data |
Definition at line 192 of file class.ilPluginAdmin.php.
Referenced by getPluginData().
Here is the caller graph for this function:| ilPluginAdmin::supportsExport | ( | $a_ctype, | |
| $a_cname, | |||
| $a_slot_id, | |||
| $a_pname | |||
| ) |
Checks whether plugin supports export/import.
| string | $a_ctype | Component Type |
| string | $a_cname | Component Name |
| string | $a_slot_id | Slot ID |
| string | $a_pname | Plugin Name |
| ilPluginException |
Definition at line 507 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:
|
protected |
Should the plugin be updated.
| string[] | &$plugin_data | |
| string | $last_update_version |
Definition at line 146 of file class.ilPluginAdmin.php.
References ilComponent\isVersionGreaterString().
Referenced by getPluginData().
Here is the call graph for this function:
Here is the caller graph for this function:
|
static |
Definition at line 33 of file class.ilPluginAdmin.php.
|
protected |
Definition at line 23 of file class.ilPluginAdmin.php.
|
protected |
Definition at line 27 of file class.ilPluginAdmin.php.
|
protected |
Definition at line 43 of file class.ilPluginAdmin.php.
|
staticprotected |
Definition at line 39 of file class.ilPluginAdmin.php.