ilPlugin Class Reference

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 ()
	Only very little classes seem to care about this: More...
	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)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...
	getStyleSheetLocation (string $a_css_file)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...
	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	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 ()
	If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More...
	beforeUninstall ()
	If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...
	afterUninstall ()
	If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...
	beforeActivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
	afterActivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
	afterDeactivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
	updateDatabase ()
	beforeUpdate ()
	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
	)

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

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

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

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

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

                              : bool
    {
        if ($this->needsUpdate() && !$this->update()) {
            return false;
        }

        if (!$this->beforeActivation()) {
            return false;
        }

        $this->component_repository->setActivation($this->getId(), true);
        $this->afterActivation();

        return true;
    }

Here is the call graph for this function:

addBlockFile()

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

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

Hence, this method will be removed.

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

References getDirectory().

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

Here is the call graph for this function:

afterActivation()

ilPlugin::afterActivation ( )

protected

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

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

Referenced by activate().

                                        : void
    {
    }

Here is the caller graph for this function:

afterDeactivation()

ilPlugin::afterDeactivation ( )

protected

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

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

Referenced by deactivate().

                                          : void
    {
    }

Here is the caller graph for this function:

afterInstall()

ilPlugin::afterInstall ( )

protected

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

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

Referenced by install().

                                     : void
    {
    }

Here is the caller graph for this function:

afterUninstall()

ilPlugin::afterUninstall ( )

protected

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

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

Referenced by uninstall().

                                       : void
    {
    }

Here is the caller graph for this function:

afterUpdate()

ilPlugin::afterUpdate ( )

protected

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

Referenced by update().

                                    : void
    {
    }

Here is the caller graph for this function:

beforeActivation()

ilPlugin::beforeActivation ( )

protected

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

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

Referenced by activate().

                                         : bool
    {
        return true;
    }

Here is the caller graph for this function:

beforeUninstall()

ilPlugin::beforeUninstall ( )

protected

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

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

Referenced by uninstall().

                                        : bool
    {
        return true;
    }

Here is the caller graph for this function:

beforeUpdate()

ilPlugin::beforeUpdate ( )

protected

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

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

Referenced by update().

                                     : bool
    {
        return true;
    }

Here is the caller graph for this function:

buildLanguageHandler()

ilPlugin::buildLanguageHandler ( )

protected

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

References getPluginInfo().

Referenced by getLanguageHandler().

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

Here is the call graph for this function:

Here is the caller graph for this function:

deactivate()

ilPlugin::deactivate

(

)

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

References afterDeactivation(), and getId().

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

        return true;
    }

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.

Definition at line 451 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.

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

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

getComponentInfo()

ilPlugin::getComponentInfo ( )

protected

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

References getPluginInfo().

Referenced by getStyleSheetLocation().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getDirectory()

ilPlugin::getDirectory

(

)

Only very little classes seem to care about this:

• Services/COPage/classes/class.ilPCPlugged.php
• Modules/DataCollection/classes/Fields/class.ilDclFieldFactory.php

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

References getPluginInfo().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getGlobalScreenProviderCollection()

ilPlugin::getGlobalScreenProviderCollection ( )

final

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

References $provider_collection.

                                                             : PluginProviderCollection
    {
        return $this->provider_collection;
    }

getId()

ilPlugin::getId

(

)

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

References getPluginInfo().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLanguageHandler()

ilPlugin::getLanguageHandler ( )

protected

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

References $language_handler, buildLanguageHandler(), and null.

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

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

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.

References $message.

                                : string
    {
        return $this->message;
    }

getPluginInfo()

ilPlugin::getPluginInfo ( )

protected

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

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

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

Here is the caller graph for this function:

getPluginName()

ilPlugin::getPluginName

(

)

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

References getPluginInfo().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginSlotInfo()

ilPlugin::getPluginSlotInfo ( )

protected

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

References getPluginInfo().

Referenced by getStyleSheetLocation().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getStyleSheetLocation()

ilPlugin::getStyleSheetLocation

(

string

$a_css_file

)

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

Hence, this method will be removed.

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

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

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

Here is the call graph for this function:

getTemplate()

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

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

Hence, this method will be removed.

Definition at line 370 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

(

)

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.

References getPluginInfo().

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

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.

Referenced by __construct().

                             : void
    {
    }

Here is the caller graph for this function:

install()

ilPlugin::install

(

)

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

References afterInstall().

                             : void
    {
        $this->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 131 of file class.ilPlugin.php.

References getPluginInfo().

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

Here is the call graph for this function:

loadLanguageModule()

ilPlugin::loadLanguageModule

(

)

Load language module for plugin.

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

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

References getLanguageHandler().

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

needsUpdate()

ilPlugin::needsUpdate

(

)

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

References getPluginInfo().

Referenced by activate().

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

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

References getLanguageHandler().

Referenced by ilTestExportPlugin\createExportFile().

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

Here is the call graph for this function:

Here is the caller graph for this function:

uninstall()

ilPlugin::uninstall

(

)

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

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

                               : bool
    {
        if (!$this->beforeUninstall()) {
            return false;
        }

        $this->getLanguageHandler()->uninstall();
        $this->component_repository->removeStateInformationOf($this->getId());
        $this->afterUninstall();
        return true;
    }

Here is the call graph for this function:

update()

ilPlugin::update

(

)

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

updateDatabase()

ilPlugin::updateDatabase ( )

protected

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

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

Referenced by update().

                                       : int
    {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();

        $dbupdate = new ilPluginDBUpdate(
            $ilDB,
            $this->getPluginInfo()
        );

        $dbupdate->applyUpdate();

        return $dbupdate->getCurrentVersion();
    }

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(), 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(), and ilRepositoryObjectPlugin\beforeActivation().

$id

string ilPlugin::$id

protected

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

Referenced by __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