Class IdentificationFactory All elements in the GlobalScreen service must be identifiable for the supplying components mentioned in the readme. More...

Collaboration diagram for ILIAS\GlobalScreen\Identification\IdentificationFactory:

Public Member Functions
	__construct (ProviderFactory $provider_factory)
	IdentificationFactory constructor. More...

	core (Provider $provider)
	Returns a IdentificationProvider for core components, only a Provider is needed. More...

	tool (Provider $provider)
	Returns a IdentificationProvider for core tools, only a Provider is needed. More...

	plugin (string $plugin_id, Provider $provider)
	Returns a IdentificationProvider for ILIAS-Plugins which takes care of the plugin_id for further identification where a provided GlobalScreen-element comes from (e.g. More...

	fromSerializedIdentification ($serialized_string)

Protected Attributes
ProviderFactory	$provider_factory

SerializerFactory	$serializer_factory

IdentificationMap	$map

Detailed Description

Class IdentificationFactory All elements in the GlobalScreen service must be identifiable for the supplying components mentioned in the readme.

The GlobalScreen service uses this identification, for example, for parent/child relationships. The identification is also forwarded to the UI service or to the instance that then renders the GlobalScreen elements. This means that the identification can be used there again, for example, to generate unique IDs for the online help. There will be at least two IdentificationProvider, one for core components and one for plugins. This factory allows to acces both. The identification you get can be serialized and is used e.g. to store in database and cache. you don't need to take care of storing this. Since you are passing some identifiers as a string such as 'personal_desktop' the GlobalScreen-Services must take care after naming collisions. Therefore you always pass your Provider (or even the Plugin-Class in case of Plugins) and the GlobalScreen- Services will use this information to generate unique identifications. Currently Identifications are only used for the GlobalScreen-MainMenu-Elements. Other like Footer may follow.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 47 of file IdentificationFactory.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\GlobalScreen\Identification\IdentificationFactory::__construct ( ProviderFactory $provider_factory )

final

IdentificationFactory constructor.

Parameters

ProviderFactory $provider_factory

Definition at line 57 of file IdentificationFactory.php.

References ILIAS\GlobalScreen\Identification\IdentificationFactory\$provider_factory.

     {
         $this->serializer_factory = new SerializerFactory();
         $this->map = new IdentificationMap();
         $this->provider_factory = $provider_factory;
     }

Member Function Documentation

◆ core()

ILIAS\GlobalScreen\Identification\IdentificationFactory::core ( Provider $provider )

final

Returns a IdentificationProvider for core components, only a Provider is needed.

Definition at line 68 of file IdentificationFactory.php.

References ILIAS\GlobalScreen\Identification\IdentificationFactory\$map.

Referenced by ILIAS\GlobalScreen\MainMenu\IdentificationFactoryTest\testSerializingCore(), and ILIAS\GlobalScreen\MainMenu\IdentificationFactoryTest\testUnserializingCore().

                                                   : CoreIdentificationProvider
     {
         return new CoreIdentificationProvider($provider, $this->serializer_factory->core(), $this->map);
     }

Here is the caller graph for this function:

◆ fromSerializedIdentification()

ILIAS\GlobalScreen\Identification\IdentificationFactory::fromSerializedIdentification ( $serialized_string )

final

Parameters

$serialized_string

Returns: IdentificationInterface

Definition at line 97 of file IdentificationFactory.php.

Referenced by ILIAS\GlobalScreen\MainMenu\IdentificationFactoryTest\testFactoryMustReturnCorrectTypeCore(), ILIAS\GlobalScreen\MainMenu\IdentificationFactoryTest\testFactoryMustReturnCorrectTypePlugin(), ILIAS\GlobalScreen\MainMenu\IdentificationFactoryTest\testUnserializingCore(), and ILIAS\GlobalScreen\MainMenu\IdentificationFactoryTest\testUnserializingPlugin().

                                                                           : IdentificationInterface
     {
         if ($serialized_string === null || $serialized_string === "") {
             return new NullIdentification();
         }
         if ($this->map->isInMap($serialized_string)) {
             return $this->map->getFromMap($serialized_string);
         }
 
         return $this->serializer_factory->fromSerializedIdentification($serialized_string)->unserialize($serialized_string, $this->map, $this->provider_factory);
     }

Here is the caller graph for this function:

◆ plugin()

ILIAS\GlobalScreen\Identification\IdentificationFactory::plugin	(	string	$plugin_id,
		Provider	$provider
	)

final

Returns a IdentificationProvider for ILIAS-Plugins which takes care of the plugin_id for further identification where a provided GlobalScreen-element comes from (e.g.

to disable or delete all elements when a plugin is deleted or deactivated).

Definition at line 88 of file IdentificationFactory.php.

References ILIAS\GlobalScreen\Identification\IdentificationFactory\$map.

Referenced by ILIAS\GlobalScreen\MainMenu\IdentificationFactoryTest\testUnserializingPlugin().

                                                                        : PluginIdentificationProvider
     {
         return new PluginIdentificationProvider($provider, $plugin_id, $this->serializer_factory->plugin(), $this->map);
     }

Here is the caller graph for this function:

◆ tool()

ILIAS\GlobalScreen\Identification\IdentificationFactory::tool ( Provider $provider )

final

Returns a IdentificationProvider for core tools, only a Provider is needed.

Definition at line 77 of file IdentificationFactory.php.

References ILIAS\GlobalScreen\Identification\IdentificationFactory\$map.

                                                   : ToolIdentificationProvider
     {
         return new ToolIdentificationProvider($provider, $this->serializer_factory->core(), $this->map);
     }

Field Documentation

◆ $map

IdentificationMap ILIAS\GlobalScreen\Identification\IdentificationFactory::$map

protected

Definition at line 51 of file IdentificationFactory.php.

Referenced by ILIAS\GlobalScreen\Identification\IdentificationFactory\core(), ILIAS\GlobalScreen\Identification\IdentificationFactory\plugin(), and ILIAS\GlobalScreen\Identification\IdentificationFactory\tool().

◆ $provider_factory

ProviderFactory ILIAS\GlobalScreen\Identification\IdentificationFactory::$provider_factory

protected

Definition at line 49 of file IdentificationFactory.php.

Referenced by ILIAS\GlobalScreen\Identification\IdentificationFactory\__construct().

◆ $serializer_factory

SerializerFactory ILIAS\GlobalScreen\Identification\IdentificationFactory::$serializer_factory

protected

Definition at line 50 of file IdentificationFactory.php.

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

src/GlobalScreen/Identification/IdentificationFactory.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ core()

◆ fromSerializedIdentification()

◆ plugin()

◆ tool()

Field Documentation

◆ $map

◆ $provider_factory

◆ $serializer_factory