Inheritance diagram for ilPlugin:

Collaboration diagram for ilPlugin:

Public Member Functions
	__construct ()

	getComponentType ()
	Get Component Type. More...

	getComponentName ()
	Get Component Name. More...

	getSlot ()
	Get Slot Name. More...

	getSlotId ()
	Get Slot ID. More...

	getPluginName ()
	Get Plugin Name. More...

	getId ()

	getLastUpdateVersion ()
	Get Version of last update. More...

	getVersion ()

	getIliasMinVersion ()

	getIliasMaxVersion ()
	Get Required ILIAS max. More...

	getActive ()

	setDBVersion (int $a_dbversion)

	getDBVersion ()

	writeDBVersion (int $a_dbversion)

	getDirectory ()
	Get Plugin Directory. More...

	includeClass ($a_class_file_name)
	Include (once) a class file. More...

	getPrefix ()
	Get plugin prefix, used for lang vars. More...

	getTablePrefix ()
	Get db table plugin prefix. More...

	updateLanguages ($a_lang_keys=null)

	updateDatabase ()
	Update database. More...

	loadLanguageModule ()
	Load language module for plugin. More...

	txt (string $a_var)
	Get Language Variable (prefix will be prepended automatically) More...

	getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true)
	gets a ilTemplate instance of a html-file in the plugin /templates More...

	getImagePath (string $a_img)
	Get image path. More...

	getStyleSheetLocation (string $a_css_file)

	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	Add template content to placeholder variable. More...

	isActive ()
	Check whether plugin is active. More...

	needsUpdate ()
	Check whether update is needed. More...

	install ()

	activate ()
	Activate. More...

	deactivate ()
	Deactivate. More...

	uninstall ()

	update ()
	Update plugin. More...

	promoteGlobalScreenProvider ()

	getGlobalScreenProviderCollection ()

	exchangeUIRendererAfterInitialization (\ILIAS\DI\Container $dic)
	This methods allows to replace the UI Renderer (see src/UI) of ILIAS after initialization by returning a closure returning a custom renderer. More...

	exchangeUIFactoryAfterInitialization (string $dic_key, \ILIAS\DI\Container $dic)
	This methods allows to replace some factory for UI Components (see src/UI) of ILIAS after initialization by returning a closure returning a custom factory. More...

Static Public Member Functions
static	_getDirectory (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
	Get plugin directory. More...

static	getAvailableLangFiles (string $a_lang_directory)
	Get array of all language files in the plugin. More...

static	hasConfigureClass (string $a_slot_dir, array $plugin_data, array $plugin_db_data)
	Has the plugin a configure class? More...

static	getConfigureClassName (array $plugin_data)
	Get plugin configure class name. More...

static	getDBUpdateScriptName (string $a_ctype, string $a_cname, string $a_slot_name, string $a_pname)

static	lookupTxt (string $a_mod_prefix, string $a_pl_id, string $a_lang_var)

static	langExitsById (string $pluginId, string $langVar)
	Is searched lang var available in plugin lang files. More...

static	_getImagePath (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname, string $a_img)

static	createPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

static	getPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

static	getPluginObject (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

static	lookupStoredData (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
	Lookup information data in il_plugin. More...

static	getActivePluginsForSlot (string $a_ctype, string $a_cname, string $a_slot_id)

static	getActivePluginIdsForSlot (string $a_ctype, string $a_cname, string $a_slot_id)
	Get All active plugin ids for a slot. More...

static	lookupNameForId (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_id)

static	lookupIdForName (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_name)

static	lookupTypeInformationsForId (string $id)

Protected Member Functions
	setSlotObject (ilPluginSlot $a_slot)

	getSlotObject ()

	getClassesDirectory ()

	getLanguageDirectory ()

	slotInit ()
	Object initialization done by slot. More...

	init ()
	Object initialization. More...

	afterInstall ()
	After install processing. More...

	beforeActivation ()
	Before activation processing. More...

	afterActivation ()
	After activation processing. More...

	afterDeactivation ()
	After deactivation processing. More...

	beforeUninstall ()

	afterUninstall ()
	This is Plugin-Specific and is triggered after the uninstall command of a plugin. More...

	readEventListening ()
	Read the event listening definitions from the plugin.xml (if file exists) More...

	clearEventListening ()
	Clear the entries of this plugin in the event handling table. More...

	beforeUpdate ()
	Before update processing. More...

	afterUpdate ()
	After update processing. More...

Protected Attributes
	$slot

	$active = false

	$iliasmaxversion = ""

	$iliasminversion = ""

	$version = ""

	$lastupdateversion = ""

	$dbversion = 0

	$lang_initialised = false

	$id = ''

	$provider_collection

Private Member Functions
	setId ($a_id)
	Set Id. More...

	setLastUpdateVersion (string $a_lastupdateversion)
	Set Version of last update. More...

	setVersion (string $a_version)

	setIliasMinVersion (string $a_iliasminversion)

	setIliasMaxVersion (string $a_iliasmaxversion)

	setActive (bool $a_active)

	__init ()
	Default initialization. More...

Detailed Description

Abstract Class ilPlugin.

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 14 of file class.ilPlugin.php.

Constructor & Destructor Documentation

◆ __construct()

ilPlugin::__construct ( )

Definition at line 59 of file class.ilPlugin.php.

References __init(), getComponentName(), getComponentType(), getPluginName(), getSlot(), and getSlotId().

     {
         $this->__init();
         $this->provider_collection = new PluginProviderCollection();
     }

Here is the call graph for this function:

Member Function Documentation

◆ __init()

ilPlugin::__init ( )

private

Default initialization.

Definition at line 743 of file class.ilPlugin.php.

References $DIC, getComponentName(), getComponentType(), getPluginName(), getPluginRecord(), getSlotId(), init(), loadLanguageModule(), setActive(), setDBVersion(), setId(), setIliasMaxVersion(), setIliasMinVersion(), setLastUpdateVersion(), setSlotObject(), setVersion(), and slotInit().

Referenced by __construct().

     {
         global $DIC;
         $ilPluginAdmin = $DIC['ilPluginAdmin'];
 
         // read/set basic data
         $rec = ilPlugin::getPluginRecord(
             $this->getComponentType(),
             $this->getComponentName(),
             $this->getSlotId(),
             $this->getPluginName()
         );
         $this->setLastUpdateVersion((string) $rec["last_update_version"]);
         $this->setDBVersion((int) $rec["db_version"]);
         $this->setActive((bool) $rec["active"]);
 
         // get id
         $this->setId(
             $ilPluginAdmin->getId(
                 $this->getComponentType(),
                 $this->getComponentName(),
                 $this->getSlotId(),
                 $this->getPluginName()
             )
         );
 
         // get version
         $this->setVersion(
             $ilPluginAdmin->getVersion(
                 $this->getComponentType(),
                 $this->getComponentName(),
                 $this->getSlotId(),
                 $this->getPluginName()
             )
         );
 
         // get ilias min version
         $this->setIliasMinVersion(
             $ilPluginAdmin->getIliasMinVersion(
                 $this->getComponentType(),
                 $this->getComponentName(),
                 $this->getSlotId(),
                 $this->getPluginName()
             )
         );
 
         // get ilias max version
         $this->setIliasMaxVersion(
             $ilPluginAdmin->getIliasMaxVersion(
                 $this->getComponentType(),
                 $this->getComponentName(),
                 $this->getSlotId(),
                 $this->getPluginName()
             )
         );
 
         // get slot object
         $this->setSlotObject(
             new ilPluginSlot(
                 $this->getComponentType(),
                 $this->getComponentName(),
                 $this->getSlotId()
             )
         );
 
         // load language module
 
         // Fix for authentication plugins
         $this->loadLanguageModule();
 
         // call slot and plugin init methods
         $this->slotInit();
         $this->init();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getDirectory()

static ilPlugin::_getDirectory	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id,
		string	$a_pname
	)

static

Get plugin directory.

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

References ilPluginSlot\_getPluginsDirectory().

Referenced by _getImagePath(), and ilObjectDefinition\parsePluginData().

                                                                                                                : string
     {
         return ilPluginSlot::_getPluginsDirectory($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:

◆ _getImagePath()

static ilPlugin::_getImagePath	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id,
		string	$a_pname,
		string	$a_img
	)

static

Parameters

string	$a_ctype
string	$a_cname
string	$a_slot_id
string	$a_pname
string	$a_img

Returns: string

Definition at line 630 of file class.ilPlugin.php.

References $d, $img, _getDirectory(), ilUtil\getImagePath(), ilComponent\lookupId(), and lookupIdForName().

Referenced by ilOrgUnitExtensionPlugin\_getIcon(), and ilRepositoryObjectPlugin\_getIcon().

                                                                                                                               : string
     {
         $d2 = ilComponent::lookupId($a_ctype, $a_cname) . "_" . $a_slot_id . "_" .
             ilPlugin::lookupIdForName($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
         $img = ilUtil::getImagePath($d2 . "/" . $a_img);
         if (is_int(strpos($img, "Customizing"))) {
             return $img;
         }
 
         $d = ilPlugin::_getDirectory($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
         return $d . "/templates/images/" . $a_img;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ activate()

ilPlugin::activate ( )

Activate.

Definition at line 891 of file class.ilPlugin.php.

References $DIC, $ilDB, $result, afterActivation(), beforeActivation(), ilCachedComponentData\flush(), getComponentName(), getComponentType(), getPluginName(), getSlotId(), needsUpdate(), and update().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         ilCachedComponentData::flush();
 
         $result = true;
 
         // check whether update is necessary
         if ($this->needsUpdate()) {
             //$result = $this->isUpdatePossible();
 
             // do update
             if ($result === true) {
                 $result = $this->update();
             }
         }
         if ($result === true) {
             $result = $this->beforeActivation();
             // activate plugin
             if ($result === true) {
                 $q = "UPDATE il_plugin SET active = " . $ilDB->quote(1, "integer") .
                     " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
                     " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
                     " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
                     " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
                 $ilDB->manipulate($q);
                 $this->afterActivation();
             }
         }
         ilCachedComponentData::flush();
 
         return $result;
     }

Here is the call graph for this function:

◆ addBlockFile()

ilPlugin::addBlockFile	(	$a_tpl,
		$a_var,
		$a_block,
		$a_tplname
	)

Add template content to placeholder variable.

Definition at line 683 of file class.ilPlugin.php.

References getDirectory().

     {
         $a_tpl->addBlockFile(
             $a_var,
             $a_block,
             $this->getDirectory() . "/templates/" . $a_tplname
         );
     }

Here is the call graph for this function:

◆ afterActivation()

ilPlugin::afterActivation ( )

protected

After activation processing.

Definition at line 954 of file class.ilPlugin.php.

Referenced by activate().

955 {

956 }

Here is the caller graph for this function:

◆ afterDeactivation()

ilPlugin::afterDeactivation ( )

protected

After deactivation processing.

Definition at line 987 of file class.ilPlugin.php.

Referenced by deactivate().

988 {

989 }

Here is the caller graph for this function:

◆ afterInstall()

ilPlugin::afterInstall ( )

protected

After install processing.

Returns: void

Definition at line 934 of file class.ilPlugin.php.

Referenced by install().

935 {

936 }

Here is the caller graph for this function:

◆ afterUninstall()

ilPlugin::afterUninstall ( )

protected

This is Plugin-Specific and is triggered after the uninstall command of a plugin.

Definition at line 1048 of file class.ilPlugin.php.

Referenced by uninstall().

1049 {

1050 }

Here is the caller graph for this function:

◆ afterUpdate()

ilPlugin::afterUpdate ( )

protected

After update processing.

Definition at line 1160 of file class.ilPlugin.php.

Referenced by update().

1161 {

1162 }

Here is the caller graph for this function:

◆ beforeActivation()

ilPlugin::beforeActivation ( )

protected

Before activation processing.

Definition at line 942 of file class.ilPlugin.php.

Referenced by activate().

     {
         return true;    // false would indicate that anything went wrong
         // activation would not proceed
         // throw an exception in this case
         //throw new ilPluginException($lng->txt(""));
     }

Here is the caller graph for this function:

◆ beforeUninstall()

ilPlugin::beforeUninstall ( )

protected

Definition at line 992 of file class.ilPlugin.php.

Referenced by uninstall().

     {
         // plugin-specific
         // false would indicate that anything went wrong
         return true;
     }

Here is the caller graph for this function:

◆ beforeUpdate()

ilPlugin::beforeUpdate ( )

protected

Before update processing.

Definition at line 1148 of file class.ilPlugin.php.

Referenced by update().

     {
         return true;    // false would indicate that anything went wrong
         // update would not proceed
         // throw an exception in this case
         //throw new ilPluginException($lng->txt(""));
     }

Here is the caller graph for this function:

◆ clearEventListening()

ilPlugin::clearEventListening ( )

protected

Clear the entries of this plugin in the event handling table.

Definition at line 1132 of file class.ilPlugin.php.

References $reader, getComponentName(), getComponentType(), getDirectory(), getPluginName(), and getSlotId().

Referenced by uninstall().

     {
         $reader = new ilPluginReader(
             $this->getDirectory() . '/plugin.xml',
             $this->getComponentType(),
             $this->getComponentName(),
             $this->getSlotId(),
             $this->getPluginName()
         );
         $reader->clearEvents();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createPluginRecord()

static ilPlugin::createPluginRecord	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id,
		string	$a_pname
	)

static

Parameters

$a_ctype
$a_cname
$a_slot_id
$a_pname	Create plugin record

Definition at line 701 of file class.ilPlugin.php.

References $DIC, $ilDB, and ilCachedComponentData\flush().

Referenced by ilPluginSlot\getPluginsInformation().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         ilCachedComponentData::flush();
 
         $q = "INSERT INTO il_plugin (component_type, component_name, slot_id, name)" .
             " VALUES (" . $ilDB->quote($a_ctype, "text") . "," .
             $ilDB->quote($a_cname, "text") . "," .
             $ilDB->quote($a_slot_id, "text") . "," .
             $ilDB->quote($a_pname, "text") . ")";
 
         $ilDB->manipulate($q);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deactivate()

ilPlugin::deactivate ( )

Deactivate.

Definition at line 962 of file class.ilPlugin.php.

References $DIC, $ilDB, $result, afterDeactivation(), ilCachedComponentData\flush(), getComponentName(), getComponentType(), getPluginName(), and getSlotId().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         ilCachedComponentData::flush();
 
         $result = true;
 
         $q = "UPDATE il_plugin SET active = " . $ilDB->quote(0, "integer") .
             " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
             " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
             " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
             " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
         $ilDB->manipulate($q);
         $this->afterDeactivation();
 
         return $result;
     }

Here is the call graph for this function:

◆ exchangeUIFactoryAfterInitialization()

ilPlugin::exchangeUIFactoryAfterInitialization	(	string	$dic_key,
		\ILIAS\DI\Container	$dic
	)

This methods allows to replace some factory for UI Components (see src/UI) of ILIAS after initialization by returning a closure returning a custom factory.

E.g:

if($key == "ui.factory.nameOfFactory"){ return function( $c){ return new CustomFactory($c['ui.signal_generator'],$c['ui.factory.maincontrols.slate']); }; }

Note: Note that plugins might conflict by replacing the same factory, so only use if you are sure, that no other plugin will do this for a given context.

Parameters

string	$dic_key
\ILIAS\DI\Container	$dic

Returns: Closure

Definition at line 1426 of file class.ilPlugin.php.

                                                                                                     : Closure
     {
         //This returns the callable of $c[$key] without executing it.
         return $dic->raw($dic_key);
     }

◆ exchangeUIRendererAfterInitialization()

ilPlugin::exchangeUIRendererAfterInitialization ( \ILIAS\DI\Container $dic )

This methods allows to replace the UI Renderer (see src/UI) of ILIAS after initialization by returning a closure returning a custom renderer.

E.g:

return function( $c){ return new CustomRenderer(); };

Note: Note that plugins might conflict by replacing the renderer, so only use if you are sure, that no other plugin will do this for a given context.

Parameters

\ILIAS\DI\Container $dic

Returns: Closure

Definition at line 1401 of file class.ilPlugin.php.

                                                                                     : Closure
     {
         //This returns the callable of $c['ui.renderer'] without executing it.
         return $dic->raw('ui.renderer');
     }

◆ getActive()

ilPlugin::getActive ( )

Returns: bool

Definition at line 227 of file class.ilPlugin.php.

References $active.

                                 : bool
     {
         return $this->active;
     }

◆ getActivePluginIdsForSlot()

static ilPlugin::getActivePluginIdsForSlot	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id
	)

static

Get All active plugin ids for a slot.

Parameters

$a_ctype
$a_cname
$a_slot_id

Returns: array

Definition at line 1265 of file class.ilPlugin.php.

References $DIC, and ilCachedComponentData\getInstance().

Referenced by ilOrgUnitExtension\__construct().

                                                                                                           : array
     {
         global $DIC;
         $ilPluginAdmin = $DIC['ilPluginAdmin'];
 
         $plugins = array();
         $cached_component = ilCachedComponentData::getInstance();
         $lookupActivePluginsBySlotId = $cached_component->lookupActivePluginsBySlotId($a_slot_id);
         foreach ($lookupActivePluginsBySlotId as $rec) {
             if ($ilPluginAdmin->isActive($a_ctype, $a_cname, $a_slot_id, $rec["name"])) {
                 $plugins[] = $rec["plugin_id"];
             }
         }
 
         return $plugins;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActivePluginsForSlot()

static ilPlugin::getActivePluginsForSlot	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id
	)

static

Parameters

string	$a_ctype
string	$a_cname
string	$a_slot_id

Returns: array

Definition at line 1236 of file class.ilPlugin.php.

References $DIC, and ilCachedComponentData\getInstance().

Referenced by ilPluginAdmin\getActivePluginsForSlot().

                                                                                                         : array
     {
         global $DIC;
         $ilPluginAdmin = $DIC['ilPluginAdmin'];
 
         $plugins = array();
 
         $cached_component = ilCachedComponentData::getInstance();
 
         $lookupActivePluginsBySlotId = $cached_component->lookupActivePluginsBySlotId($a_slot_id);
         foreach ($lookupActivePluginsBySlotId as $rec) {
             if ($ilPluginAdmin->isActive($a_ctype, $a_cname, $a_slot_id, $rec["name"])) {
                 $plugins[] = $rec["name"];
             }
         }
 
         return $plugins;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAvailableLangFiles()

static ilPlugin::getAvailableLangFiles ( string $a_lang_directory )

static

Get array of all language files in the plugin.

Definition at line 339 of file class.ilPlugin.php.

Referenced by ilPluginsOverviewTableGUI\gatherPluginData(), ilObjComponentSettingsGUI\showPlugin(), and updateLanguages().

                                                                            : array
     {
         $langs = array();
 
         if (!@is_dir($a_lang_directory)) {
             return array();
         }
 
         $dir = opendir($a_lang_directory);
         while ($file = readdir($dir)) {
             if ($file != "." and
                 $file != ".."
             ) {
                 // directories
                 if (@is_file($a_lang_directory . "/" . $file)) {
                     if (substr($file, 0, 6) == "ilias_"
                         && substr($file, strlen($file) - 5) == ".lang"
                     ) {
                         $langs[] = array(
                             "key" => substr($file, 6, 2),
                             "file" => $file,
                             "path" => $a_lang_directory . "/" . $file,
                         );
                     }
                 }
             }
         }
 
         return $langs;
     }

Here is the caller graph for this function:

◆ getClassesDirectory()

ilPlugin::getClassesDirectory ( )

protected

Returns: string

Definition at line 312 of file class.ilPlugin.php.

References getDirectory().

Referenced by includeClass().

                                              : string
     {
         return $this->getDirectory() . "/classes";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponentName()

ilPlugin::getComponentName ( )

abstract

Get Component Name.

Must be overwritten in plugin class of plugin slot.

Returns: string Component Name

Referenced by __construct(), __init(), activate(), clearEventListening(), deactivate(), getImagePath(), getStyleSheetLocation(), install(), isActive(), needsUpdate(), readEventListening(), uninstall(), update(), updateDatabase(), and writeDBVersion().

Here is the caller graph for this function:

◆ getComponentType()

ilPlugin::getComponentType ( )

abstract

Get Component Type.

Must be overwritten in plugin class of plugin slot.

Returns: string Component Type

Referenced by __construct(), __init(), activate(), clearEventListening(), deactivate(), getImagePath(), getStyleSheetLocation(), install(), isActive(), needsUpdate(), readEventListening(), uninstall(), update(), updateDatabase(), and writeDBVersion().

Here is the caller graph for this function:

◆ getConfigureClassName()

static ilPlugin::getConfigureClassName ( array $plugin_data )

static

Get plugin configure class name.

Parameters

array $plugin_data

Returns: string

Definition at line 403 of file class.ilPlugin.php.

Referenced by ilPluginsOverviewTableGUI\gatherPluginData(), ilObjComponentSettingsGUI\showPlugin(), and update().

                                                                      : string
     {
         return "il" . $plugin_data["name"] . "ConfigGUI";
     }

Here is the caller graph for this function:

◆ getDBUpdateScriptName()

static ilPlugin::getDBUpdateScriptName	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_name,
		string	$a_pname
	)

static

Parameters

string	$a_ctype
string	$a_cname
string	$a_slot_name
string	$a_pname

Returns: string

Definition at line 426 of file class.ilPlugin.php.

Referenced by ilPluginDBUpdate\__construct(), and ilObjComponentSettingsGUI\showPlugin().

                                                                                                                          : string
     {
         return "Customizing/global/plugins/" . $a_ctype . "/" . $a_cname . "/" .
             $a_slot_name . "/" . $a_pname . "/sql/dbupdate.php";
     }

Here is the caller graph for this function:

◆ getDBVersion()

ilPlugin::getDBVersion ( )

Returns: int

Definition at line 263 of file class.ilPlugin.php.

References $dbversion.

Referenced by writeDBVersion().

                                    : int
     {
         return $this->dbversion;
     }

Here is the caller graph for this function:

◆ getDirectory()

ilPlugin::getDirectory ( )

Get Plugin Directory.

Returns: object Plugin Slot

Definition at line 294 of file class.ilPlugin.php.

References getPluginName(), and getSlotObject().

Referenced by addBlockFile(), clearEventListening(), getClassesDirectory(), getLanguageDirectory(), getStyleSheetLocation(), getTemplate(), readEventListening(), and update().

                                    : string
     {
         return $this->getSlotObject()->getPluginsDirectory() . "/" . $this->getPluginName();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGlobalScreenProviderCollection()

ilPlugin::getGlobalScreenProviderCollection ( )

final

Returns: PluginProviderCollection

Definition at line 1376 of file class.ilPlugin.php.

References $provider_collection, promoteGlobalScreenProvider(), and ILIAS\GlobalScreen\Provider\PluginProviderCollection\setMainBarProvider().

                                                               : PluginProviderCollection
     {
         if (!$this->promoteGlobalScreenProvider() instanceof ilPluginGlobalScreenNullProvider) {
             $this->provider_collection->setMainBarProvider($this->promoteGlobalScreenProvider());
         }
 
         return $this->provider_collection;
     }

Here is the call graph for this function:

◆ getId()

ilPlugin::getId ( )

Returns: string

Definition at line 131 of file class.ilPlugin.php.

References $id.

Referenced by ILIAS\GlobalScreen\Provider\__construct(), ilRepositoryObjectPlugin\beforeActivation(), ilRepositoryObjectPlugin\beforeUninstall(), ilCloudHookPlugin\getPluginTablePrefix(), ilDclFieldTypePlugin\getPluginTablePrefix(), getPrefix(), ilTestSignaturePlugin\handInFileForArchiving(), and install().

                             : string
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getIliasMaxVersion()

ilPlugin::getIliasMaxVersion ( )

Get Required ILIAS max.

release.

Returns: string Required ILIAS max. release

Definition at line 209 of file class.ilPlugin.php.

References $iliasmaxversion.

     {
         return $this->iliasmaxversion;
     }

◆ getIliasMinVersion()

ilPlugin::getIliasMinVersion ( )

Returns: string

Definition at line 189 of file class.ilPlugin.php.

References $iliasminversion.

                                          : string
     {
         return $this->iliasminversion;
     }

◆ getImagePath()

ilPlugin::getImagePath ( string $a_img )

Get image path.

Definition at line 649 of file class.ilPlugin.php.

References getComponentName(), getComponentType(), getPluginName(), and getSlotId().

                                                 : string
     {
         return self::_getImagePath(
             $this->getComponentType(),
             $this->getComponentName(),
             $this->getSlotId(),
             $this->getPluginName(),
             $a_img
         );
     }

Here is the call graph for this function:

◆ getLanguageDirectory()

ilPlugin::getLanguageDirectory ( )

protected

Returns: string

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

References getDirectory().

Referenced by updateLanguages().

                                               : string
     {
         return $this->getDirectory() . "/lang";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastUpdateVersion()

ilPlugin::getLastUpdateVersion ( )

Get Version of last update.

Returns: string Version of last update

Definition at line 153 of file class.ilPlugin.php.

References $lastupdateversion.

                                            : string
     {
         return $this->lastupdateversion;
     }

◆ getPluginName()

ilPlugin::getPluginName ( )

abstract

Get Plugin Name.

Must be same as in class name il<Name>Plugin and must correspond to plugins subdirectory name.

Must be overwritten in plugin class of plugin

Returns: string Plugin Name

Referenced by __construct(), __init(), activate(), ilRepositoryObjectPlugin\beforeActivation(), clearEventListening(), deactivate(), getDirectory(), getImagePath(), ilCloudHookPlugin\getPluginTablePrefix(), ilDclFieldTypePlugin\getPluginTablePrefix(), ilPreviewRendererPlugin\getRendererClassInstance(), getStyleSheetLocation(), ilPageComponentPlugin\getUIClassInstance(), install(), isActive(), needsUpdate(), readEventListening(), ilUserInterfaceHookPlugin\slotInit(), uninstall(), update(), updateDatabase(), and writeDBVersion().

Here is the caller graph for this function:

◆ getPluginObject()

static ilPlugin::getPluginObject	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id,
		string	$a_pname
	)

static

Parameters

string	$a_ctype
string	$a_cname
string	$a_slot_id
string	$a_pname

Returns: ilPlugin

Exceptions

ilPluginException

Definition at line 1172 of file class.ilPlugin.php.

References XapiProxy\$plugin, ilCachedComponentData\getInstance(), and ilPluginSlot\lookupSlotName().

Referenced by SurveyQuestion\_getQuestionTypeName(), assQuestion\_getQuestionTypeName(), ilObjSurveyQuestionPool\_getQuestiontypes(), ilObjQuestionPool\_getQuestionTypes(), ilObjSurveyQuestionPool\_getQuestionTypeTranslations(), SurveyQuestion\_includeClass(), ilObjComponentSettingsGUI\activatePlugin(), ilObjComponentSettingsGUI\confirmUninstallPlugin(), ilObjComponentSettingsGUI\deactivatePlugin(), ilObjTest\getAvailableQuestions(), ilDclFieldFactory\getClassPathByInstance(), ilDclFieldFactory\getFieldTypeByInstance(), ilOrgUnitExtensionListGUI\getPlugin(), ilOrgUnitExtensionGUI\getPlugin(), ilObjectPluginListGUI\getPlugin(), ilOrgUnitExtension\getPlugin(), ilObjectPlugin\getPlugin(), ilObjectPluginGUI\getPlugin(), ilPluginAdmin\getPluginObject(), ilObjQuestionPool\getQuestionTypeTranslations(), assQuestion\includePluginClass(), ilObjComponentSettingsGUI\installPlugin(), ilObjQuestionPool\isPluginActive(), ilObjectPlugin\loadOrgUnitPlugin(), ilObjectPlugin\loadRepoPlugin(), ilObjComponentSettingsGUI\refreshLanguages(), ilObjLanguage\refreshPlugins(), ilObjComponentSettingsGUI\uninstallPlugin(), ilObjComponentSettingsGUI\updatePlugin(), and ilObjQuestionPoolGUI\uploadQplObject().

                                                                                                                  : ilPlugin
     {
         $slot_name = ilPluginSlot::lookupSlotName($a_ctype, $a_cname, $a_slot_id);
 
         $cached_component = ilCachedComponentData::getInstance();
         $rec = $cached_component->lookCompId($a_ctype, $a_cname);
         if (!$rec) {
             return null;
         }
 
         $file = "./Customizing/global/plugins/" . $a_ctype . "/" .
             $a_cname . "/" . $slot_name . "/" .
             $a_pname . "/classes/class.il" . $a_pname . "Plugin.php";
 
         if (is_file($file)) {
             include_once($file);
             $class = "il" . $a_pname . "Plugin";
             $plugin = new $class();
 
             return $plugin;
         }
         throw new ilPluginException("File : ".$file. " . does not Exist for plugin: ".$a_pname. " Check if your 
             plugin is still marked as active in the DB Table 'il_plugin' but not installed anymore.");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginRecord()

static ilPlugin::getPluginRecord	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id,
		string	$a_pname
	)

static

Parameters

string	$a_ctype
string	$a_cname
string	$a_slot_id
string	$a_pname

Returns: array

Exceptions

ilPluginException

Definition at line 727 of file class.ilPlugin.php.

References ilCachedComponentData\getInstance().

Referenced by __init(), ilPluginsOverviewTableGUI\gatherPluginData(), ilPluginAdmin\getPluginData(), ilCloudHookPlugin\getPluginTablePrefix(), ilDclFieldTypePlugin\getPluginTablePrefix(), and ilObjComponentSettingsGUI\showPlugin().

                                                                                                                  : array
     {
         $cached_component = ilCachedComponentData::getInstance();
         $rec = $cached_component->lookupPluginByName($a_pname);
 
         if ($rec['component_type'] == $a_ctype and $rec['component_name'] == $a_cname and $rec['slot_id'] == $a_slot_id) {
             return $rec;
         } else {
             throw new ilPluginException("No plugin record found for '{$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:

◆ getPrefix()

ilPlugin::getPrefix ( )

Get plugin prefix, used for lang vars.

Definition at line 412 of file class.ilPlugin.php.

References getId(), and getSlotObject().

Referenced by getTablePrefix(), loadLanguageModule(), txt(), uninstall(), update(), and updateLanguages().

                                 : string
     {
         return $this->getSlotObject()->getPrefix() . "_" . $this->getId();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSlot()

ilPlugin::getSlot ( )

abstract

Get Slot Name.

Must be overwritten in plugin class of plugin slot.

Returns: string Slot Name

Referenced by __construct().

Here is the caller graph for this function:

◆ getSlotId()

ilPlugin::getSlotId ( )

abstract

Get Slot ID.

Must be overwritten in plugin class of plugin slot.

Returns: string Slot Id

Referenced by __construct(), __init(), activate(), clearEventListening(), deactivate(), getImagePath(), getStyleSheetLocation(), install(), isActive(), needsUpdate(), readEventListening(), uninstall(), update(), updateDatabase(), and writeDBVersion().

Here is the caller graph for this function:

◆ getSlotObject()

ilPlugin::getSlotObject ( )

protected

Returns: ilPluginSlot

Definition at line 245 of file class.ilPlugin.php.

References $slot.

Referenced by getDirectory(), ilCloudHookPlugin\getPluginTablePrefix(), ilDclFieldTypePlugin\getPluginTablePrefix(), and getPrefix().

                                        : ilPluginSlot
     {
         return $this->slot;
     }

Here is the caller graph for this function:

◆ getStyleSheetLocation()

ilPlugin::getStyleSheetLocation ( string $a_css_file )

Parameters

string $a_css_file

Returns: string

Definition at line 666 of file class.ilPlugin.php.

References getComponentName(), getComponentType(), getDirectory(), getPluginName(), getSlotId(), ilUtil\getStyleSheetLocation(), ilComponent\lookupId(), and lookupIdForName().

                                                               : string
     {
         $d2 = ilComponent::lookupId($this->getComponentType(), $this->getComponentName()) . "_" . $this->getSlotId() . "_" .
             ilPlugin::lookupIdForName($this->getComponentType(), $this->getComponentName(), $this->getSlotId(), $this->getPluginName());
 
         $css = ilUtil::getStyleSheetLocation("output", $a_css_file, $d2);
         if (is_int(strpos($css, "Customizing"))) {
             return $css;
         }
 
         return $this->getDirectory() . "/templates/" . $a_css_file;
     }

Here is the call graph for this function:

◆ getTablePrefix()

ilPlugin::getTablePrefix ( )

Get db table plugin prefix.

Definition at line 436 of file class.ilPlugin.php.

References getPrefix().

Referenced by updateDatabase().

     {
         return $this->getPrefix();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplate()

ilPlugin::getTemplate	(	string	$a_template,
		bool	$a_par1 = `true`,
		bool	$a_par2 = `true`
	)

gets a ilTemplate instance of a html-file in the plugin /templates

Parameters

string	$a_template
bool	$a_par1
bool	$a_par2

Returns: ilTemplate

Definition at line 615 of file class.ilPlugin.php.

References getDirectory().

                                                                                               : ilTemplate
     {
         return new ilTemplate($this->getDirectory() . "/templates/" . $a_template, $a_par1, $a_par2);
     }

Here is the call graph for this function:

◆ getVersion()

ilPlugin::getVersion ( )

Returns: string

Definition at line 171 of file class.ilPlugin.php.

References $version.

Referenced by update().

                                  : string
     {
         return $this->version;
     }

Here is the caller graph for this function:

◆ hasConfigureClass()

static ilPlugin::hasConfigureClass	(	string	$a_slot_dir,
		array	$plugin_data,
		array	$plugin_db_data
	)

static

Has the plugin a configure class?

Parameters

string	$a_slot_dir	slot directory
array	$plugin_data	plugin data
array	$plugin_db_data	plugin db data

Returns: boolean true/false

Definition at line 380 of file class.ilPlugin.php.

References ILIAS_VERSION_NUMERIC, and ilComponent\isVersionGreaterString().

Referenced by ilPluginsOverviewTableGUI\gatherPluginData(), and ilObjComponentSettingsGUI\showPlugin().

                                                                                                             : bool
     {
         // Mantis: 23282: Disable plugin config page for incompatible plugins
         if (!(ilComponent::isVersionGreaterString($plugin_data["ilias_min_version"], ILIAS_VERSION_NUMERIC)
             || ilComponent::isVersionGreaterString(ILIAS_VERSION_NUMERIC, $plugin_data["ilias_max_version"])
             || ilComponent::isVersionGreaterString($plugin_db_data["last_update_version"], $plugin_data["version"]))
         ) {
             if (is_file($a_slot_dir . "/" . $plugin_data["name"] . "/classes/class.il" . $plugin_data["name"] . "ConfigGUI.php")) {
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ includeClass()

ilPlugin::includeClass ( $a_class_file_name )

Include (once) a class file.

Definition at line 321 of file class.ilPlugin.php.

References getClassesDirectory().

Referenced by ilPreviewRendererPlugin\getRendererClassInstance(), ilPageComponentPlugin\getUIClassInstance(), and ilUserInterfaceHookPlugin\slotInit().

     {
         include_once($this->getClassesDirectory() . "/" . $a_class_file_name);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

ilPlugin::init ( )

protected

Object initialization.

Can be overwritten by plugin class (and should be made protected)

Definition at line 832 of file class.ilPlugin.php.

Referenced by __init().

833 {

834 }

Here is the caller graph for this function:

◆ install()

ilPlugin::install ( )

Definition at line 871 of file class.ilPlugin.php.

References $DIC, $ilDB, afterInstall(), ilCachedComponentData\flush(), getComponentName(), getComponentType(), getId(), getPluginName(), and getSlotId().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         ilCachedComponentData::flush();
         $q = "UPDATE il_plugin SET plugin_id = " . $ilDB->quote($this->getId(), "text") .
             " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
             " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
             " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
             " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
         $ilDB->manipulate($q);
         $this->afterInstall();
     }

Here is the call graph for this function:

◆ isActive()

ilPlugin::isActive ( )

Check whether plugin is active.

Definition at line 840 of file class.ilPlugin.php.

References $DIC, getComponentName(), getComponentType(), getPluginName(), and getSlotId().

Referenced by ExamplePlugin\exchangeUIRendererAfterInitialization().

     {
         global $DIC;
         $ilPluginAdmin = $DIC['ilPluginAdmin'];
 
         return $ilPluginAdmin->isActive(
             $this->getComponentType(),
             $this->getComponentName(),
             $this->getSlotId(),
             $this->getPluginName()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ langExitsById()

static ilPlugin::langExitsById	(	string	$pluginId,
		string	$langVar
	)

static

Is searched lang var available in plugin lang files.

Parameters

string	$pluginId
string	$langVar

Returns: bool

Definition at line 594 of file class.ilPlugin.php.

References $DIC, $lng, and ilObjectPlugin\getPluginObjectByType().

Referenced by ilObjectRolePermissionTableGUI\fillRow().

                                                                             : bool
     {
         global $DIC;
         $lng = $DIC->language();
 
         $pl = ilObjectPlugin::getPluginObjectByType($pluginId);
         $pl->loadLanguageModule();
 
         return $lng->exists($pl->getPrefix() . "_" . $langVar);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadLanguageModule()

ilPlugin::loadLanguageModule ( )

Load language module for plugin.

Definition at line 542 of file class.ilPlugin.php.

References $DIC, $lng, and getPrefix().

Referenced by __init(), and txt().

     {
         global $DIC;
         $lng = $DIC->language();
 
         if (!$this->lang_initialised && is_object($lng)) {
             $lng->loadLanguageModule($this->getPrefix());
             $this->lang_initialised = true;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupIdForName()

static ilPlugin::lookupIdForName	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id,
		string	$a_plugin_name
	)

static

Parameters

$a_ctype
$a_cname
$a_slot_id
$a_plugin_name

Returns: string

Definition at line 1317 of file class.ilPlugin.php.

References $DIC, and $ilDB.

Referenced by _getImagePath(), ilObjRepositorySettings\getAllObjTypes(), ilObjectDefinition\getGroupedPluginObjectTypes(), ilModulesTableGUI\getPluginComponents(), getStyleSheetLocation(), and ilObjectDefinition\parsePluginData().

                                                                                                                        : string
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $q = "SELECT plugin_id FROM il_plugin " .
             " WHERE component_type = " . $ilDB->quote($a_ctype, "text") .
             " AND component_name = " . $ilDB->quote($a_cname, "text") .
             " AND slot_id = " . $ilDB->quote($a_slot_id, "text") .
             " AND name = " . $ilDB->quote($a_plugin_name, "text");
 
         $set = $ilDB->query($q);
         if ($rec = $ilDB->fetchAssoc($set)) {
             return $rec["plugin_id"];
         }
     }

Here is the caller graph for this function:

◆ lookupNameForId()

static ilPlugin::lookupNameForId	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id,
		string	$a_plugin_id
	)

static

Parameters

$a_ctype
$a_cname
$a_slot_id
$a_plugin_id

Returns: string | null

Definition at line 1291 of file class.ilPlugin.php.

References $DIC, and $ilDB.

Referenced by ilOrgUnitExtensionPlugin\_getIcon(), ilRepositoryObjectPlugin\_getIcon(), ilOrgUnitExtensionPlugin\_getName(), ilRepositoryObjectPlugin\_getName(), ilNavigationHistory\getItems(), ilOrgUnitExtensionListGUI\getPlugin(), ilOrgUnitExtensionGUI\getPlugin(), ilObjectPluginListGUI\getPlugin(), ilOrgUnitExtension\getPlugin(), ilObjectPlugin\getPlugin(), ilObjectPluginGUI\getPlugin(), ilObjectDefinition\isActivePluginType(), ilRepositoryObjectPluginSlot\isTypePlugin(), ilRepositoryObjectPluginSlot\isTypePluginWithLP(), ilObjectPlugin\loadOrgUnitPlugin(), and ilObjectPlugin\loadRepoPlugin().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $q = "SELECT name FROM il_plugin " .
             " WHERE component_type = " . $ilDB->quote($a_ctype, "text") .
             " AND component_name = " . $ilDB->quote($a_cname, "text") .
             " AND slot_id = " . $ilDB->quote($a_slot_id, "text") .
             " AND plugin_id = " . $ilDB->quote($a_plugin_id, "text");
 
         $set = $ilDB->query($q);
         if ($rec = $ilDB->fetchAssoc($set)) {
             return $rec["name"];
         }
     }

Here is the caller graph for this function:

◆ lookupStoredData()

static ilPlugin::lookupStoredData	(	string	$a_ctype,
		string	$a_cname,
		string	$a_slot_id,
		string	$a_pname
	)

static

Lookup information data in il_plugin.

Parameters

string	$a_ctype
string	$a_cname
string	$a_slot_id
string	$a_pname

Returns: string[]

Definition at line 1208 of file class.ilPlugin.php.

References $DIC, and $ilDB.

Referenced by ilPluginSlot\getPluginsInformation().

                                                                                                                   : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $q = "SELECT * FROM il_plugin WHERE" .
             " component_type = " . $ilDB->quote($a_ctype, "text") . " AND" .
             " component_name = " . $ilDB->quote($a_cname, "text") . " AND" .
             " slot_id = " . $ilDB->quote($a_slot_id, "text") . " AND" .
             " name = " . $ilDB->quote($a_pname, "text");
 
         $set = $ilDB->query($q);
 
         if ($ilDB->numRows($set) == 0) {
             return array();
         }
 
         return $ilDB->fetchAssoc($set);
     }

Here is the caller graph for this function:

◆ lookupTxt()

static ilPlugin::lookupTxt	(	string	$a_mod_prefix,
		string	$a_pl_id,
		string	$a_lang_var
	)

static

Parameters

string	$a_mod_prefix
string	$a_pl_id
string	$a_lang_var

Returns: string

Definition at line 574 of file class.ilPlugin.php.

References $DIC, and $lng.

                                                                                                 : string
     {
         global $DIC;
         $lng = $DIC->language();
 
         // this enables default language fallback
         $prefix = $a_mod_prefix . "_" . $a_pl_id;
 
         return $lng->txt($prefix . "_" . $a_lang_var, $prefix);
     }

◆ lookupTypeInformationsForId()

static ilPlugin::lookupTypeInformationsForId ( string $id )

static

Parameters

string $id

Returns: string[] | null

Definition at line 1340 of file class.ilPlugin.php.

References $DIC, and $ilDB.

Referenced by ilObjectPlugin\getPluginObjectByType().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $q = "SELECT component_type, component_name, slot_id FROM il_plugin "
             . " WHERE plugin_id = " . $ilDB->quote($id, "text");
 
         $set = $ilDB->query($q);
         if ($rec = $ilDB->fetchAssoc($set)) {
             return [
                 $rec["component_type"],
                 $rec["component_name"],
                 $rec["slot_id"],
             ];
         }
     }

Here is the caller graph for this function:

◆ needsUpdate()

ilPlugin::needsUpdate ( )

Check whether update is needed.

Definition at line 857 of file class.ilPlugin.php.

References $DIC, getComponentName(), getComponentType(), getPluginName(), and getSlotId().

Referenced by activate().

     {
         global $DIC;
         $ilPluginAdmin = $DIC['ilPluginAdmin'];
 
         return $ilPluginAdmin->needsUpdate(
             $this->getComponentType(),
             $this->getComponentName(),
             $this->getSlotId(),
             $this->getPluginName()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ promoteGlobalScreenProvider()

ilPlugin::promoteGlobalScreenProvider ( )

Returns: AbstractStaticPluginMainMenuProvider

Deprecated:

See also: getGlobalScreenProviderCollection instead

Definition at line 1365 of file class.ilPlugin.php.

References $DIC.

Referenced by getGlobalScreenProviderCollection().

                                                   : AbstractStaticPluginMainMenuProvider
     {
         global $DIC;
 
         return new ilPluginGlobalScreenNullProvider($DIC, $this);
     }

Here is the caller graph for this function:

◆ readEventListening()

ilPlugin::readEventListening ( )

protected

Read the event listening definitions from the plugin.xml (if file exists)

Definition at line 1115 of file class.ilPlugin.php.

References $reader, getComponentName(), getComponentType(), getDirectory(), getPluginName(), and getSlotId().

Referenced by update().

     {
         $reader = new ilPluginReader(
             $this->getDirectory() . '/plugin.xml',
             $this->getComponentType(),
             $this->getComponentName(),
             $this->getSlotId(),
             $this->getPluginName()
         );
         $reader->clearEvents();
         $reader->startParsing();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActive()

ilPlugin::setActive ( bool $a_active )

private

Parameters

bool $a_active

Definition at line 218 of file class.ilPlugin.php.

Referenced by __init().

     {
         $this->active = $a_active;
     }

Here is the caller graph for this function:

◆ setDBVersion()

ilPlugin::setDBVersion ( int $a_dbversion )

Parameters

int $a_dbversion

Definition at line 254 of file class.ilPlugin.php.

Referenced by __init(), and writeDBVersion().

     {
         $this->dbversion = $a_dbversion;
     }

Here is the caller graph for this function:

◆ setId()

ilPlugin::setId ( $a_id )

private

Set Id.

Parameters

string $a_id Id

Definition at line 122 of file class.ilPlugin.php.

Referenced by __init().

     {
         $this->id = $a_id;
     }

Here is the caller graph for this function:

◆ setIliasMaxVersion()

ilPlugin::setIliasMaxVersion ( string $a_iliasmaxversion )

private

Parameters

$a_iliasmaxversion

Definition at line 198 of file class.ilPlugin.php.

Referenced by __init().

     {
         $this->iliasmaxversion = $a_iliasmaxversion;
     }

Here is the caller graph for this function:

◆ setIliasMinVersion()

ilPlugin::setIliasMinVersion ( string $a_iliasminversion )

private

Parameters

$a_iliasminversion

Definition at line 180 of file class.ilPlugin.php.

Referenced by __init().

     {
         $this->iliasminversion = $a_iliasminversion;
     }

Here is the caller graph for this function:

◆ setLastUpdateVersion()

ilPlugin::setLastUpdateVersion ( string $a_lastupdateversion )

private

Set Version of last update.

Parameters

string $a_lastupdateversion Version of last update

Definition at line 142 of file class.ilPlugin.php.

Referenced by __init().

     {
         $this->lastupdateversion = $a_lastupdateversion;
     }

Here is the caller graph for this function:

◆ setSlotObject()

ilPlugin::setSlotObject ( ilPluginSlot $a_slot )

protected

Parameters

ilPluginSlot $a_slot

Definition at line 236 of file class.ilPlugin.php.

Referenced by __init().

     {
         $this->slot = $a_slot;
     }

Here is the caller graph for this function:

◆ setVersion()

ilPlugin::setVersion ( string $a_version )

private

Parameters

string $a_version

Definition at line 162 of file class.ilPlugin.php.

Referenced by __init().

     {
         $this->version = $a_version;
     }

Here is the caller graph for this function:

◆ slotInit()

ilPlugin::slotInit ( )

abstractprotected

Object initialization done by slot.

Must be overwritten in plugin class of plugin slot.

(and should be made protected)

Referenced by __init().

Here is the caller graph for this function:

◆ txt()

ilPlugin::txt ( string $a_var )

Get Language Variable (prefix will be prepended automatically)

Definition at line 557 of file class.ilPlugin.php.

References $DIC, $lng, getPrefix(), and loadLanguageModule().

Referenced by ilTestExportPlugin\getFormat().

                                        : string
     {
         global $DIC;
         $lng = $DIC->language();
         $this->loadLanguageModule();
 
         return $lng->txt($this->getPrefix() . "_" . $a_var, $this->getPrefix());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uninstall()

ilPlugin::uninstall ( )

final

Definition at line 1000 of file class.ilPlugin.php.

References $DIC, $ilDB, afterUninstall(), beforeUninstall(), clearEventListening(), ilCachedComponentData\flush(), getComponentName(), getComponentType(), getPluginName(), getPrefix(), getSlotId(), and ilDBConstants\T_TEXT.

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         if ($this->beforeUninstall()) {
             // remove all language entries (see ilObjLanguage)
             // see updateLanguages
             $prefix = $this->getPrefix();
             if ($prefix) {
                 $ilDB->manipulate(
                     "DELETE FROM lng_data" .
                     " WHERE module = " . $ilDB->quote($prefix, "text")
                 );
                 $ilDB->manipulate(
                     "DELETE FROM lng_modules" .
                     " WHERE module = " . $ilDB->quote($prefix, "text")
                 );
             }
 
             $this->clearEventListening();
 
             // db version is kept in il_plugin - will be deleted, too
 
             $q = "DELETE FROM il_plugin" .
                 " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
                 " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
                 " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
                 " AND name = " . $ilDB->quote($this->getPluginName(), "text");
             $ilDB->manipulate($q);
 
             $ilDB->manipulateF('DELETE FROM ctrl_classfile WHERE comp_prefix=%s', [ilDBConstants::T_TEXT], [$this->getPrefix()]);
             $ilDB->manipulateF('DELETE FROM ctrl_calls WHERE comp_prefix=%s', [ilDBConstants::T_TEXT], [$this->getPrefix()]);
 
             $this->afterUninstall();
 
             ilCachedComponentData::flush();
 
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

◆ update()

ilPlugin::update ( )

Update plugin.

Definition at line 1056 of file class.ilPlugin.php.

References $DIC, $ilCtrl, $ilDB, $result, afterUpdate(), beforeUpdate(), getComponentName(), getComponentType(), getConfigureClassName(), getDirectory(), getPluginName(), getPrefix(), getSlotId(), getVersion(), readEventListening(), updateDatabase(), and updateLanguages().

Referenced by activate(), and ilObjComponentSettingsGUI\update().

     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilCtrl = $DIC->ctrl();
 
         ilGlobalCache::flushAll();
 
         $result = $this->beforeUpdate();
         if ($result === false) {
             return false;
         }
 
         // Load language files
         $this->updateLanguages();
 
         // DB update
         if ($result === true) {
             $result = $this->updateDatabase();
         }
 
         // load control structure
         $structure_reader = new ilCtrlStructureReader();
         $structure_reader->readStructure(
             true,
             "./" . $this->getDirectory(),
             $this->getPrefix(),
             $this->getDirectory()
         );
 
         // add config gui to the ctrl calls
         $ilCtrl->insertCtrlCalls(
             "ilobjcomponentsettingsgui",
             ilPlugin::getConfigureClassName(["name" => $this->getPluginName()]),
             $this->getPrefix()
         );
 
         $this->readEventListening();
 
         // set last update version to current version
         if ($result === true) {
             $q = "UPDATE il_plugin SET last_update_version = " . $ilDB->quote($this->getVersion(), "text") .
                 " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
                 " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
                 " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
                 " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
             $ilDB->manipulate($q);
             $this->afterUpdate();
         }
         ilGlobalCache::flushAll();
 
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateDatabase()

ilPlugin::updateDatabase ( )

Update database.

Definition at line 504 of file class.ilPlugin.php.

References $DIC, $ilDB, $lng, $message, $result, getComponentName(), getComponentType(), getPluginName(), getSlotId(), and getTablePrefix().

Referenced by update().

     {
         global $DIC;
         $ilDB = $DIC->database();
         $lng = $DIC->language();
 
         ilGlobalCache::flushAll();
 
         $dbupdate = new ilPluginDBUpdate(
             $this->getComponentType(),
             $this->getComponentName(),
             $this->getSlotId(),
             $this->getPluginName(),
             $ilDB,
             true,
             $this->getTablePrefix()
         );
 
         $result = $dbupdate->applyUpdate();
         $message = '';
         if ($dbupdate->updateMsg == "no_changes") {
             $message = $lng->txt("no_changes") . ". " . $lng->txt("database_is_uptodate");
         } else {
             foreach ($dbupdate->updateMsg as $row) {
                 $message .= $lng->txt($row["msg"]) . ": " . $row["nr"] . "<br/>";
             }
         }
 
         $this->message .= $message;
         ilGlobalCache::flushAll();
 
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateLanguages()

ilPlugin::updateLanguages ( $a_lang_keys = null )

Definition at line 447 of file class.ilPlugin.php.

References Vendor\Package\$a, $lang, $txt, ilObjLanguage\_getLocalChangesByModule(), getAvailableLangFiles(), ilObjLanguage\getInstalledLanguages(), getLanguageDirectory(), getPrefix(), and ilObjLanguage\replaceLangEntry().

Referenced by update().

     {
         ilGlobalCache::flushAll();
 
         // get the keys of all installed languages if keys are not provided
         if (!isset($a_lang_keys)) {
             $a_lang_keys = array();
             foreach (ilObjLanguage::getInstalledLanguages() as $langObj) {
                 if ($langObj->isInstalled()) {
                     $a_lang_keys[] = $langObj->getKey();
                 }
             }
         }
 
         $langs = $this->getAvailableLangFiles($this->getLanguageDirectory());
 
         $prefix = $this->getPrefix();
 
         foreach ($langs as $lang) {
             // check if the language should be updated, otherwise skip it
             if (!in_array($lang['key'], $a_lang_keys)) {
                 continue;
             }
 
             $txt = file($this->getLanguageDirectory() . "/" . $lang["file"]);
             $lang_array = array();
 
             // get locally changed variables of the module (these should be kept)
             $local_changes = ilObjLanguage::_getLocalChangesByModule($lang['key'], $prefix);
 
             // get language data
             if (is_array($txt)) {
                 foreach ($txt as $row) {
                     if ($row[0] != "#" && strpos($row, "#:#") > 0) {
                         $a = explode("#:#", trim($row));
                         $identifier = $prefix . "_" . trim($a[0]);
                         $value = trim($a[1]);
 
                         if (isset($local_changes[$identifier])) {
                             $lang_array[$identifier] = $local_changes[$identifier];
                         } else {
                             $lang_array[$identifier] = $value;
                             ilObjLanguage::replaceLangEntry($prefix, $identifier, $lang["key"], $value);
                         }
                         //echo "<br>-$prefix-".$prefix."_".trim($a[0])."-".$lang["key"]."-";
                     }
                 }
             }
 
             ilObjLanguage::replaceLangModule($lang["key"], $prefix, $lang_array);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDBVersion()

ilPlugin::writeDBVersion ( int $a_dbversion )

Parameters

string $a_dbversion

Definition at line 272 of file class.ilPlugin.php.

References $DIC, $ilDB, getComponentName(), getComponentType(), getDBVersion(), getPluginName(), getSlotId(), and setDBVersion().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $this->setDBVersion($a_dbversion);
 
         $q = "UPDATE il_plugin SET db_version = " . $ilDB->quote((int) $this->getDBVersion(), "integer") .
             " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
             " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
             " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
             " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
         $ilDB->manipulate($q);
     }

Here is the call graph for this function:

Field Documentation

◆ $active

ilPlugin::$active = false

protected

Definition at line 24 of file class.ilPlugin.php.

Referenced by getActive().

◆ $dbversion

ilPlugin::$dbversion = 0

protected

Definition at line 44 of file class.ilPlugin.php.

Referenced by getDBVersion().

◆ $id

ilPlugin::$id = ''

protected

Definition at line 52 of file class.ilPlugin.php.

Referenced by getId(), ilCloudHookPlugin\getPluginTablePrefix(), ilDclFieldTypePlugin\getPluginTablePrefix(), and ilAuthPlugin\slotInit().

◆ $iliasmaxversion

ilPlugin::$iliasmaxversion = ""

protected

Definition at line 28 of file class.ilPlugin.php.

Referenced by getIliasMaxVersion().

◆ $iliasminversion

ilPlugin::$iliasminversion = ""

protected

Definition at line 32 of file class.ilPlugin.php.

Referenced by getIliasMinVersion().

◆ $lang_initialised

ilPlugin::$lang_initialised = false

protected

Definition at line 48 of file class.ilPlugin.php.

◆ $lastupdateversion

ilPlugin::$lastupdateversion = ""

protected

Definition at line 40 of file class.ilPlugin.php.

Referenced by getLastUpdateVersion().

◆ $provider_collection

ilPlugin::$provider_collection

protected

Definition at line 56 of file class.ilPlugin.php.

Referenced by getGlobalScreenProviderCollection().

◆ $slot

ilPlugin::$slot

protected

Definition at line 20 of file class.ilPlugin.php.

Referenced by getSlotObject().

◆ $version

ilPlugin::$version = ""

protected

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

Referenced by getVersion().

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

Services/Component/classes/class.ilPlugin.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __init()

◆ _getDirectory()

◆ _getImagePath()

◆ activate()

◆ addBlockFile()

◆ afterActivation()

◆ afterDeactivation()

◆ afterInstall()

◆ afterUninstall()

◆ afterUpdate()

◆ beforeActivation()

◆ beforeUninstall()

◆ beforeUpdate()

◆ clearEventListening()

◆ createPluginRecord()

◆ deactivate()

◆ exchangeUIFactoryAfterInitialization()

◆ exchangeUIRendererAfterInitialization()

◆ getActive()

◆ getActivePluginIdsForSlot()

◆ getActivePluginsForSlot()

◆ getAvailableLangFiles()

◆ getClassesDirectory()

◆ getComponentName()

◆ getComponentType()

◆ getConfigureClassName()

◆ getDBUpdateScriptName()

◆ getDBVersion()

◆ getDirectory()

◆ getGlobalScreenProviderCollection()

◆ getId()

◆ getIliasMaxVersion()

◆ getIliasMinVersion()

◆ getImagePath()

◆ getLanguageDirectory()

◆ getLastUpdateVersion()

◆ getPluginName()

◆ getPluginObject()

◆ getPluginRecord()

◆ getPrefix()

◆ getSlot()

◆ getSlotId()

◆ getSlotObject()

◆ getStyleSheetLocation()

◆ getTablePrefix()

◆ getTemplate()

◆ getVersion()

◆ hasConfigureClass()

◆ includeClass()

◆ init()

◆ install()

◆ isActive()

◆ langExitsById()

◆ loadLanguageModule()

◆ lookupIdForName()

◆ lookupNameForId()

◆ lookupStoredData()

◆ lookupTxt()

◆ lookupTypeInformationsForId()

◆ needsUpdate()

◆ promoteGlobalScreenProvider()

◆ readEventListening()

◆ setActive()

◆ setDBVersion()

◆ setId()

◆ setIliasMaxVersion()

◆ setIliasMinVersion()

◆ setLastUpdateVersion()

◆ setSlotObject()

◆ setVersion()

◆ slotInit()