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)
	@inheritDoc More...
	identifier (string $identifier_string)
	@inheritDoc 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 (protected Provider $provider, protected SerializerInterface $serializer, protected IdentificationMap $map)
	CoreIdentificationProvider constructor. More...
	fromSerializedString (string $serialized_string)
	identifier (string $identifier_string)
	fromSerializedString (string $serialized_string)
	contextAwareIdentifier (string $identifier_string, bool $ignore_context=false)

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

Detailed Description

Class CoreIdentificationProvider.

See also

IdentificationProviderInterface

Author

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

Definition at line 29 of file ToolIdentificationProvider.php.

Member Function Documentation

contextAwareIdentifier()

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

@inheritDoc

Implements ILIAS\GlobalScreen\Identification\ToolIdentificationProviderInterface.

Definition at line 34 of file ToolIdentificationProvider.php.

                                                                                                   : IdentificationInterface
    {
        if ($ignore_context) {
            return parent::identifier($identifier_string);
        }
        global $DIC;
 
        $get = $DIC->http()->request()->getQueryParams();
        if (isset($get['ref_id'])) {
            $identifier_string .= '_' . $get['ref_id'];
        }
 
        return parent::identifier($identifier_string);
    }

References $DIC.

identifier()

ILIAS\GlobalScreen\Identification\ToolIdentificationProvider::identifier

(

string

$identifier_string

)

@inheritDoc

Reimplemented from ILIAS\GlobalScreen\Identification\CoreIdentificationProvider.

Definition at line 53 of file ToolIdentificationProvider.php.

                                                         : IdentificationInterface
    {
        throw new LogicException('Tools must use contextAwareIdentifier');
    }

---

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

• components/ILIAS/GlobalScreen/src/Identification/ToolIdentificationProvider.php