ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
All Data Structures Namespaces Files Functions Variables Modules Pages
ILIAS\GlobalScreen\Identification\ToolIdentificationProvider Class Reference

Class CoreIdentificationProvider. More...

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

Public Member Functions

 contextAwareIdentifier (string $identifier_string, bool $ignore_context=false)
 
 identifier (string $identifier_string)
 
- Public Member Functions inherited from ILIAS\GlobalScreen\Identification\CoreIdentificationProvider
 identifier (string $identifier_string)
 
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.
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)
 

Additional Inherited Members

- Protected Attributes inherited from ILIAS\GlobalScreen\Identification\AbstractIdentificationProvider
 $map
 
 $provider
 
 $serializer
 
 $class_name = ''
 
- Static Protected Attributes inherited from ILIAS\GlobalScreen\Identification\AbstractIdentificationProvider
static $instances = []
 

Detailed Description

Member Function Documentation

◆ contextAwareIdentifier()

ILIAS\GlobalScreen\Identification\ToolIdentificationProvider::contextAwareIdentifier ( string  $identifier_string,
bool  $ignore_context = false 
)

Implements ILIAS\GlobalScreen\Identification\ToolIdentificationProviderInterface.

Definition at line 15 of file ToolIdentificationProvider.php.

References $DIC.

15  : IdentificationInterface
16  {
17  if ($ignore_context) {
18  return parent::identifier($identifier_string);
19  }
20  global $DIC;
21 
22  $get = $DIC->http()->request()->getQueryParams();
23  if (isset($get['ref_id'])) {
24  $identifier_string .= '_' . $get['ref_id'];
25  }
26 
27  return parent::identifier($identifier_string);
28  }
$DIC
Definition: xapitoken.php:46

◆ identifier()

ILIAS\GlobalScreen\Identification\ToolIdentificationProvider::identifier ( string  $identifier_string)

Implements ILIAS\GlobalScreen\Identification\IdentificationProviderInterface.

Definition at line 34 of file ToolIdentificationProvider.php.

34  : IdentificationInterface
35  {
36  throw new \LogicException('Tools must use contextAwareIdentifier');
37  }

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