ExamplePlugin Class Reference

Extend some more concrete implementation of. More...

Inheritance diagram for ExamplePlugin:

Collaboration diagram for ExamplePlugin:

Public Member Functions
	exchangeUIRendererAfterInitialization (Container $dic)
	This method can ALWAYS replace the UI renderer, because the method is only ever invoked if a plugin is considered active. More...
	getPluginName ()
	exchangeUIRendererAfterInitialization (Container $dic)
	This method can ALWAYS replace the UI renderer, because the method is only ever invoked if a plugin is considered active. More...
	getPluginName ()
Public Member Functions inherited from ilPlugin
	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)
	@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...

Additional Inherited Members
Protected Member Functions inherited from ilPlugin
	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 ()
	readEventListening ()
	clearEventListening ()
Protected Attributes inherited from ilPlugin
ilDBInterface	$db
ilComponentRepositoryWrite	$component_repository
string	$id
ilPluginLanguage	$language_handler = null
bool	$lang_initialised = false
ProviderCollection	$provider_collection
string	$message = ''

Detailed Description

Extend some more concrete implementation of.

See also

ilPlugin depending on your plugin-slot.

Definition at line 26 of file ExamplePlugin.php.

Member Function Documentation

exchangeUIRendererAfterInitialization() [1/2]

ExamplePlugin::exchangeUIRendererAfterInitialization

(

Container

$dic

)

This method can ALWAYS replace the UI renderer, because the method is only ever invoked if a plugin is considered active.

Definition at line 32 of file ExamplePlugin.php.

                                                                         : Closure
    {
        // we need the previous renderer, which has possibly been exchanged, so we can
        // wrap it by our renderer and keep the rendering chain alive.
        $renderer = $dic->raw('ui.renderer');
 
        return static function () use ($dic, $renderer) {
            // you may also pass additional dependencies like the ResourceRegistry to
            // properly register you assets.
            return new HelloWorldRenderer(
                $dic['ui.resource_registry'],
                $renderer($dic)
            );
        };
    }

References $dic.

exchangeUIRendererAfterInitialization() [2/2]

ExamplePlugin::exchangeUIRendererAfterInitialization

(

Container

$dic

)

This method can ALWAYS replace the UI renderer, because the method is only ever invoked if a plugin is considered active.

Definition at line 32 of file ExamplePlugin.php.

                                                                         : Closure
    {
        // we need the previous renderer, which has possibly been exchanged, so we can
        // wrap it by our renderer and keep the rendering chain alive.
        $renderer = $dic->raw('ui.renderer');
 
        return static function () use ($dic, $renderer) {
            // create an instance of the renderer using the Closure from the container.
            return new ExampleRenderer($renderer($dic));
        };
    }

References $dic.

getPluginName() [1/2]

ExamplePlugin::getPluginName

(

)

Reimplemented from ilPlugin.

Definition at line 48 of file ExamplePlugin.php.

                                   : string
    {
        return "NoRealPlugin";
    }

getPluginName() [2/2]

ExamplePlugin::getPluginName

(

)

Reimplemented from ilPlugin.

Definition at line 44 of file ExamplePlugin.php.

                                   : string
    {
        return "NoRealPlugin";
    }

---

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

• docs/development/code-examples/ui-exchange/custom-components/ExamplePlugin.php
• docs/development/code-examples/ui-exchange/rendering-manipulations/ExamplePlugin.php