ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ILIAS\GlobalScreen\Identification\ToolIdentificationProviderInterface Interface Reference

Class IdentificationProviderInterface. More...

+ Inheritance diagram for ILIAS\GlobalScreen\Identification\ToolIdentificationProviderInterface:
+ Collaboration diagram for ILIAS\GlobalScreen\Identification\ToolIdentificationProviderInterface:

Public Member Functions

 contextAwareIdentifier (string $identifier_string, bool $ignore_context=false)
 
- Public Member Functions inherited from ILIAS\GlobalScreen\Identification\IdentificationProviderInterface
 identifier (string $identifier_string)
 
 fromSerializedString (string $serialized_string)
 

Detailed Description

Member Function Documentation

◆ contextAwareIdentifier()

ILIAS\GlobalScreen\Identification\ToolIdentificationProviderInterface::contextAwareIdentifier ( string  $identifier_string,
bool  $ignore_context = false 
)
Parameters
string$identifier_stringthis 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.
bool$ignore_context
Returns
IdentificationInterface use this CoreIdentification to put into your GlobalScreen-elements.

Implemented in ILIAS\GlobalScreen\Identification\ToolIdentificationProvider.


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