ILIAS\GlobalScreen\Identification\IdentificationFactory Class Reference

Class IdentificationFactory. 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
	$provider_factory
	$serializer_factory
	$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 34 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 56 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.

Parameters

Provider

$provider

Returns

IdentificationProviderInterface

Definition at line 72 of file IdentificationFactory.php.

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

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

fromSerializedIdentification()

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

final

Parameters

$serialized_string

Returns

IdentificationInterface

Definition at line 114 of file IdentificationFactory.php.

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

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

Parameters

string	$plugin_id
Provider	$provider

Returns

IdentificationProviderInterface

Definition at line 103 of file IdentificationFactory.php.

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

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

tool()

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

final

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

Parameters

Provider

$provider

Returns

IdentificationProviderInterface

Definition at line 86 of file IdentificationFactory.php.

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

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

Field Documentation

$map

ILIAS\GlobalScreen\Identification\IdentificationFactory::$map

protected

Definition at line 48 of file IdentificationFactory.php.

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

$provider_factory

ILIAS\GlobalScreen\Identification\IdentificationFactory::$provider_factory

protected

Definition at line 40 of file IdentificationFactory.php.

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

$serializer_factory

ILIAS\GlobalScreen\Identification\IdentificationFactory::$serializer_factory

protected

Definition at line 44 of file IdentificationFactory.php.

---

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

• src/GlobalScreen/Identification/IdentificationFactory.php