Inheritance diagram for ilPlugin:

Collaboration diagram for ilPlugin:

Public Member Functions
	getMessage ()

	__construct (\ilDBInterface $db, \ilComponentRepositoryWrite $component_repository, string $id)

	getPluginName ()

	getId ()

	getVersion ()
	Only very little classes seem to care about this: More...

	getDirectory ()
	@description Return the directory provided by ilPluginInfo, please note that this is a absolute path. More...

	getRelativeDirectory ()

	isActive ()
	Only very little classes seem to care about this: More...

	needsUpdate ()

	install ()

	uninstall ()

	activate ()
	This will update (if required) and activate the plugin. More...

	deactivate ()

	update ()

	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)
	@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More...

	getStyleSheetLocation (string $a_css_file)
	@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More...

	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More...

	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...

Protected Member Functions
	init ()
	Object initialization. More...

	getPluginInfo ()

	getComponentInfo ()

	getPluginSlotInfo ()

	afterInstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More...

	beforeUninstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...

	afterUninstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...

	beforeActivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	afterActivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	afterDeactivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	updateDatabase ()

	beforeUpdate ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More...

	afterUpdate ()

	getLanguageHandler ()

	buildLanguageHandler ()

Protected Attributes
ilDBInterface	$db

ilComponentRepositoryWrite	$component_repository

string	$id

ilPluginLanguage	$language_handler = null

bool	$lang_initialised = false

ProviderCollection	$provider_collection

string	$message = ''

Detailed Description

Author: Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de; 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 31 of file class.ilPlugin.php.

Constructor & Destructor Documentation

◆ __construct()

ilPlugin::__construct	(	\ilDBInterface	$db,
		\ilComponentRepositoryWrite	$component_repository,
		string	$id
	)

Reimplemented in ilTestExportPlugin.

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

      {
        if (!$component_repository->hasPluginId($id)) {
            throw new \LogicException(
                "You tried to instantiate a plugin with an inexisting id '$id'." .
                "This is odd... Please use ilComponentFactory to instantiate plugins."
            );
        }
 
        $this->db = $db;
        $this->component_repository = $component_repository;
        $this->id = $id;
 
        $this->provider_collection = new PluginProviderCollection();
 
        // Fix for authentication plugins
        $this->loadLanguageModule();
 
        // Custom initialisation for plugin.
        $this->init();
    }

References $component_repository, $db, $id, ilComponentRepository\hasPluginId(), init(), and loadLanguageModule().

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilPlugin::activate ( )

This will update (if required) and activate the plugin.

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

                              : bool
    {
        if ($this->needsUpdate() && !$this->update()) {
            return false;
        }
 
        if (!$this->beforeActivation()) {
            return false;
        }
 
        $this->component_repository->setActivation($this->getId(), true);
        $this->afterActivation();
 
        return true;
    }

References afterActivation(), beforeActivation(), getId(), needsUpdate(), and update().

Here is the call graph for this function:

◆ addBlockFile()

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

@deprecate ILIAS is moving towards UI components and plugins are expected to use these components.

Hence, this method will be removed.

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

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

References getDirectory().

Here is the call graph for this function:

◆ afterActivation()

ilPlugin::afterActivation ( )

protected

@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead.

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

                                        : void
    {
    }

Referenced by activate().

Here is the caller graph for this function:

◆ afterDeactivation()

ilPlugin::afterDeactivation ( )

protected

@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead.

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

                                          : void
    {
    }

Referenced by deactivate().

Here is the caller graph for this function:

◆ afterInstall()

ilPlugin::afterInstall ( )

protected

@deprecate If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead.

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

                                     : void
    {
    }

Referenced by install().

Here is the caller graph for this function:

◆ afterUninstall()

ilPlugin::afterUninstall ( )

protected

@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead.

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

                                       : void
    {
    }

Referenced by uninstall().

Here is the caller graph for this function:

◆ afterUpdate()

ilPlugin::afterUpdate ( )

protected

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

                                    : void
    {
    }

Referenced by update().

Here is the caller graph for this function:

◆ beforeActivation()

ilPlugin::beforeActivation ( )

protected

@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead.

Reimplemented in ilRepositoryObjectPlugin.

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

                                         : bool
    {
        return true;
    }

Referenced by activate().

Here is the caller graph for this function:

◆ beforeUninstall()

ilPlugin::beforeUninstall ( )

protected

@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead.

Reimplemented in ilRepositoryObjectPlugin.

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

                                        : bool
    {
        return true;
    }

Referenced by uninstall().

Here is the caller graph for this function:

◆ beforeUpdate()

ilPlugin::beforeUpdate ( )

protected

@deprecate If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead.

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

                                     : bool
    {
        return true;
    }

Referenced by update().

Here is the caller graph for this function:

◆ buildLanguageHandler()

ilPlugin::buildLanguageHandler ( )

protected

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

                                             : ilPluginLanguage
    {
        return new ilPluginLanguage($this->getPluginInfo());
    }

References getPluginInfo().

Referenced by getLanguageHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deactivate()

ilPlugin::deactivate ( )

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

                                : bool
    {
        $this->component_repository->setActivation($this->getId(), false);
        $this->afterDeactivation();
 
        return true;
    }

References afterDeactivation(), and getId().

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(\ILIAS\DI\Container $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.

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

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

References $dic.

◆ 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(\ILIAS\DI\Container $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.

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

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

References $dic.

◆ getComponentInfo()

ilPlugin::getComponentInfo ( )

protected

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

                                         : ilComponentInfo
    {
        return $this->getPluginInfo()->getComponent();
    }

References getPluginInfo().

Referenced by getStyleSheetLocation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDirectory()

ilPlugin::getDirectory ( )

@description Return the directory provided by ilPluginInfo, please note that this is a absolute path.

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

                                  : string
    {
        return $this->getPluginInfo()->getPath();
    }

References getPluginInfo().

Referenced by addBlockFile(), getStyleSheetLocation(), and getTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGlobalScreenProviderCollection()

ilPlugin::getGlobalScreenProviderCollection ( )

final

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

                                                             : PluginProviderCollection
    {
        return $this->provider_collection;
    }

References $provider_collection.

◆ getId()

ilPlugin::getId ( )

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

                           : string
    {
        return $this->getPluginInfo()->getId();
    }

References getPluginInfo().

Referenced by ILIAS\GlobalScreen\Provider\__construct(), activate(), ilRepositoryObjectPlugin\beforeActivation(), ilRepositoryObjectPlugin\beforeUninstall(), ilTestExportPlugin\createExportFile(), deactivate(), ilDclFieldTypePlugin\install(), uninstall(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLanguageHandler()

ilPlugin::getLanguageHandler ( )

protected

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

                                           : ilPluginLanguage
    {
        if ($this->language_handler === null) {
            $this->language_handler = $this->buildLanguageHandler();
        }
        return $this->language_handler;
    }

References $language_handler, and buildLanguageHandler().

Referenced by ilRepositoryObjectPlugin\getPrefix(), loadLanguageModule(), txt(), uninstall(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMessage()

ilPlugin::getMessage ( )

Returns: string

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

                                : string
    {
        return $this->message;
    }

References $message.

◆ getPluginInfo()

ilPlugin::getPluginInfo ( )

protected

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

                                      : ilPluginInfo
    {
        return $this->component_repository
            ->getPluginById(
                $this->id
            );
    }

Referenced by buildLanguageHandler(), getComponentInfo(), getDirectory(), getId(), getPluginName(), getPluginSlotInfo(), getRelativeDirectory(), getStyleSheetLocation(), getVersion(), isActive(), needsUpdate(), update(), and updateDatabase().

Here is the caller graph for this function:

◆ getPluginName()

ilPlugin::getPluginName ( )

Reimplemented in ExamplePlugin, and ExamplePlugin.

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

                                   : string
    {
        return $this->getPluginInfo()->getName();
    }

References getPluginInfo().

Referenced by ilPageComponentPlugin\getUIClassInstance(), and ilDclFieldTypePlugin\install().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginSlotInfo()

ilPlugin::getPluginSlotInfo ( )

protected

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

                                          : ilPluginSlotInfo
    {
        return $this->getPluginInfo()->getPluginSlot();
    }

References getPluginInfo().

Referenced by getStyleSheetLocation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRelativeDirectory()

ilPlugin::getRelativeDirectory ( )

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

                                          : string
    {
        return str_replace(
            ILIAS_ABSOLUTE_PATH . "/public/",
            "",
            realpath($this->getPluginInfo()->getPath())
        );
    }

References getPluginInfo().

Here is the call graph for this function:

◆ getStyleSheetLocation()

ilPlugin::getStyleSheetLocation ( string $a_css_file )

@deprecate ILIAS is moving towards UI components and plugins are expected to use these components.

Hence, this method will be removed.

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

                                                             : string
    {
        $d2 = $this->getComponentInfo()->getId() . "_" . $this->getPluginSlotInfo()->getId() . "_" . $this->getPluginInfo()->getId();
 
        $css = ilUtil::getStyleSheetLocation("output", $a_css_file, $d2);
        if (is_int(strpos($css, "Customizing"))) {
            return $css;
        }
 
        return $this->getDirectory() . "/templates/" . $a_css_file;
    }

References getComponentInfo(), getDirectory(), getPluginInfo(), getPluginSlotInfo(), and ilUtil\getStyleSheetLocation().

Here is the call graph for this function:

◆ getTemplate()

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

@deprecate ILIAS is moving towards UI components and plugins are expected to use these components.

Hence, this method will be removed.

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

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

References getDirectory().

Here is the call graph for this function:

◆ getVersion()

ilPlugin::getVersion ( )

Only very little classes seem to care about this:

Services/COPage/classes/class.ilPCPluggedGUI.php

Returns: string

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

                                : string
    {
        return (string) $this->getPluginInfo()->getAvailableVersion();
    }

References getPluginInfo().

Here is the call graph for this function:

◆ init()

ilPlugin::init ( )

protected

Object initialization.

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

TODO: Maybe this should be removed or be documented better. This is called during __construct. If this contains expensive stuff this will be bad for overall system performance, because Plugins tend to be constructed a lot.

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

                             : void
    {
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ install()

ilPlugin::install ( )

Reimplemented in ilDclFieldTypePlugin.

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

                             : void
    {
        $this->afterInstall();
    }

References afterInstall().

Here is the call graph for this function:

◆ isActive()

ilPlugin::isActive ( )

Only very little classes seem to care about this:

Services/Component/classes/class.ilObjComponentSettingsGUI.php
Services/Repository/classes/class.ilRepositoryObjectPluginSlot.php

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

                              : bool
    {
        return $this->getPluginInfo()->isActive();
    }

References getPluginInfo().

Here is the call graph for this function:

◆ loadLanguageModule()

ilPlugin::loadLanguageModule ( )

Load language module for plugin.

@deprecate Just use txt, this will automatically load the language module.

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

                                        : void
    {
        $this->getLanguageHandler()->loadLanguageModule();
    }

References getLanguageHandler().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ needsUpdate()

ilPlugin::needsUpdate ( )

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

                                 : bool
    {
        return $this->getPluginInfo()->isUpdateRequired();
    }

References getPluginInfo().

Referenced by activate().

Here is the call graph for this function:

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

                                      : string
    {
        return $this->getLanguageHandler()->txt($a_var);
    }

References getLanguageHandler().

Referenced by ilTestExportPlugin\createExportFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uninstall()

ilPlugin::uninstall ( )

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

                               : bool
    {
        if (!$this->beforeUninstall()) {
            return false;
        }
 
        $this->getLanguageHandler()->uninstall();
        $this->component_repository->removeStateInformationOf($this->getId());
        $this->afterUninstall();
        return true;
    }

References afterUninstall(), beforeUninstall(), getId(), and getLanguageHandler().

Here is the call graph for this function:

◆ update()

ilPlugin::update ( )

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

                            : bool
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $result = $this->beforeUpdate();
        if ($result === false) {
            return false;
        }
 
        // Load language files
        $this->getLanguageHandler()->updateLanguages();
 
        // DB update
        $db_version = $this->updateDatabase();
 
        // set last update version to current version
        $this->component_repository->setCurrentPluginVersion(
            $this->getPluginInfo()->getId(),
            $this->getPluginInfo()->getAvailableVersion(),
            $db_version
        );
        $this->afterUpdate();
 
        return true;
    }

References $DIC, $ilDB, afterUpdate(), beforeUpdate(), getId(), getLanguageHandler(), getPluginInfo(), and updateDatabase().

Referenced by activate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateDatabase()

ilPlugin::updateDatabase ( )

protected

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

                                       : int
    {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();
 
        $dbupdate = new ilPluginDBUpdate(
            $ilDB,
            $this->getPluginInfo()
        );
 
        $dbupdate->applyUpdate();
 
        return $dbupdate->getCurrentVersion();
    }

References $DIC, $ilDB, $lng, and getPluginInfo().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $component_repository

ilComponentRepositoryWrite ilPlugin::$component_repository

protected

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

Referenced by __construct(), ilTestExportPlugin\__construct(), ilRepositoryObjectPlugin\_getIcon(), ilRepositoryObjectPlugin\_getImagePath(), ilOrgUnitExtensionPlugin\_getName(), and ilRepositoryObjectPlugin\_getName().

◆ $db

ilDBInterface ilPlugin::$db

protected

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

Referenced by __construct(), ilTestExportPlugin\__construct(), and ilRepositoryObjectPlugin\beforeActivation().

◆ $id

string ilPlugin::$id

protected

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

Referenced by __construct(), and ilTestExportPlugin\__construct().

◆ $lang_initialised

bool ilPlugin::$lang_initialised = false

protected

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

◆ $language_handler

ilPluginLanguage ilPlugin::$language_handler = null

protected

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

Referenced by getLanguageHandler().

◆ $message

string ilPlugin::$message = ''

protected

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

Referenced by getMessage().

◆ $provider_collection

ProviderCollection ilPlugin::$provider_collection

protected

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

Referenced by getGlobalScreenProviderCollection().

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

components/ILIAS/Component/classes/class.ilPlugin.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activate()

◆ addBlockFile()

◆ afterActivation()

◆ afterDeactivation()

◆ afterInstall()

◆ afterUninstall()

◆ afterUpdate()

◆ beforeActivation()

◆ beforeUninstall()

◆ beforeUpdate()

◆ buildLanguageHandler()

◆ deactivate()

◆ exchangeUIFactoryAfterInitialization()

◆ exchangeUIRendererAfterInitialization()

◆ getComponentInfo()

◆ getDirectory()

◆ getGlobalScreenProviderCollection()

◆ getId()

◆ getLanguageHandler()

◆ getMessage()

◆ getPluginInfo()

◆ getPluginName()

◆ getPluginSlotInfo()

◆ getRelativeDirectory()

◆ getStyleSheetLocation()

◆ getTemplate()

◆ getVersion()

◆ init()

◆ install()

◆ isActive()

◆ loadLanguageModule()

◆ needsUpdate()

◆ txt()

◆ uninstall()

◆ update()

◆ updateDatabase()

Field Documentation

◆ $component_repository

◆ $db

◆ $id

◆ $lang_initialised

◆ $language_handler

◆ $message

◆ $provider_collection