|
ILIAS
release_5-3 Revision v5.3.23-19-g915713cf615
|
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... | |
Administration class for plugins.
Handles basic data from plugin.php files.
Definition at line 16 of file class.ilPluginAdmin.php.
| ilPluginAdmin::__construct | ( | ) |
Definition at line 36 of file class.ilPluginAdmin.php.
References $lng.
| 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 |
Definition at line 316 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 455 of file class.ilPluginAdmin.php.
References ilCachedComponentData\getInstance().
Referenced by ilAppEventHandler\raise().
Here is the call graph for this function:
Here is the caller graph for this function:
|
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().
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 |
Definition at line 344 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call graph for this function:
|
static |
Get info for all plugins.
Definition at line 444 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 |
Definition at line 284 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 |
Definition at line 270 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 |
Definition at line 256 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 |
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().
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 374 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(), ilAppEventHandler\raise(), 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 490 of file class.ilPluginAdmin.php.
References $id, getAllPlugins(), and getPluginObject().
Here is the call 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 |
Definition at line 242 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 |
Definition at line 418 of file class.ilPluginAdmin.php.
References data, and getPluginData().
Here is the call 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 393 of file class.ilPluginAdmin.php.
References ilPlugin\getPluginObject().
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 298 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 472 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 |
Definition at line 330 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 216 of file class.ilPluginAdmin.php.
Referenced by getPluginData().
Here is the caller graph for this function:
|
protected |
Plugin supports current ILIAS.
| string[] | &$plugin_data |
Definition at line 92 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 200 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 175 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 |
Definition at line 433 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 134 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 24 of file class.ilPluginAdmin.php.
| ilPluginAdmin::$got_data = false |
Definition at line 18 of file class.ilPluginAdmin.php.
|
static |
Definition at line 30 of file class.ilPluginAdmin.php.