ILIAS\GlobalScreen\Identification\PluginIdentificationProvider Class Reference

Class PluginIdentificationProvider. More...

Inheritance diagram for ILIAS\GlobalScreen\Identification\PluginIdentificationProvider:

Collaboration diagram for ILIAS\GlobalScreen\Identification\PluginIdentificationProvider:

Public Member Functions
	__construct (Provider $provider, string $plugin_id, SerializerInterface $serializer, IdentificationMap $map)
	PluginIdentificationProvider constructor. More...
	identifier (string $identifier_string)
	Parameters string $identifier_string this is a identifier which is only known to your component. The GlobalScreen services uses this string together with e.g. the classname of your provider to stack items or to ask your provider for further infos. 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. Returns IdentificationInterface use this CoreIdentification to put into your GlobalScreen-elements. More...
Public Member Functions inherited from ILIAS\GlobalScreen\Identification\AbstractIdentificationProvider
	__construct (Provider $provider, SerializerInterface $serializer, IdentificationMap $map)
	CoreIdentificationProvider constructor. More...
	fromSerializedString (string $serialized_string)
	identifier (string $identifier_string)
	fromSerializedString (string $serialized_string)

Protected Attributes
	$plugin_id = ""
Protected Attributes inherited from ILIAS\GlobalScreen\Identification\AbstractIdentificationProvider
	$map
	$provider
	$serializer
	$class_name = ''

Additional Inherited Members
Static Protected Attributes inherited from ILIAS\GlobalScreen\Identification\AbstractIdentificationProvider
static	$instances = []

Detailed Description

Class PluginIdentificationProvider.

See also

IdentificationProviderInterface

Author

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

Definition at line 31 of file PluginIdentificationProvider.php.

Constructor & Destructor Documentation

__construct()

ILIAS\GlobalScreen\Identification\PluginIdentificationProvider::__construct	(	Provider	$provider,
		string	$plugin_id,
		SerializerInterface	$serializer,
		IdentificationMap	$map
	)

PluginIdentificationProvider constructor.

Parameters

Provider	$provider
string	$plugin_id
SerializerInterface	$serializer
IdentificationMap	$map

Definition at line 45 of file PluginIdentificationProvider.php.

      {
        parent::__construct($provider, $serializer, $map);
        $this->plugin_id = $plugin_id;
    }

References ILIAS\GlobalScreen\Identification\AbstractIdentificationProvider\$map, ILIAS\GlobalScreen\Identification\PluginIdentificationProvider\$plugin_id, ILIAS\GlobalScreen\Identification\AbstractIdentificationProvider\$provider, ILIAS\GlobalScreen\Identification\AbstractIdentificationProvider\$serializer, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

identifier()

ILIAS\GlobalScreen\Identification\PluginIdentificationProvider::identifier

(

string

$identifier_string

)

Parameters

string

$identifier_string

this is a identifier which is only known to your component. The GlobalScreen services uses this string together with e.g. the classname of your provider to stack items or to ask your provider for further infos. 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.

Returns

IdentificationInterface use this CoreIdentification to put into your GlobalScreen-elements.

Implements ILIAS\GlobalScreen\Identification\IdentificationProviderInterface.

Definition at line 58 of file PluginIdentificationProvider.php.

                                                          : IdentificationInterface
    {
        if (isset(self::$instances[$identifier_string])) {
            return self::$instances[$identifier_string];
        }
 
        $identification = new PluginIdentification(
            $this->plugin_id,
            $identifier_string,
            $this->class_name,
            $this->serializer,
            $this->provider->getProviderNameForPresentation()
        );
        $this->map->addToMap($identification);
 
        return self::$instances[$identifier_string] = $identification;
    }

Field Documentation

$plugin_id

ILIAS\GlobalScreen\Identification\PluginIdentificationProvider::$plugin_id = ""

protected

Definition at line 36 of file PluginIdentificationProvider.php.

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

---

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

• src/GlobalScreen/Identification/PluginIdentificationProvider.php