Interface DynamicProvider. More...
Inheritance diagram for ILIAS\GlobalScreen\Provider\DynamicProvider:
Collaboration diagram for ILIAS\GlobalScreen\Provider\DynamicProvider:
Public Member Functions | |
| isGloballyAvailable () | |
| Return a simple bool whether your component provides dynamic elements for the GlobalScreen Service. More... | |
| isAvailableForCurrentUser () | |
| Return a simple bool whether the GlobalScreen element could be relevant for the current logged in user. More... | |
| isCurrentlyAvailable () | |
| ATTENTION: Implement your isCurrentlyActive()-Method as efficient as possible. More... | |
| Public Member Functions inherited from ILIAS\GlobalScreen\Provider\Provider | |
| getFullyQualifiedClassName () | |
| getProviderNameForPresentation () | |
Detailed Description
Interface DynamicProvider.
Needs JF decision whenever a new DynamicProvider is implemented.
All dynamic providers will be asked whether there are GlobalScreen elements to append for the current context. Therefore you have to implement the following methods as efficient as possible. The methods will be called in the following order:
Definition at line 18 of file DynamicProvider.php.
Member Function Documentation
◆ isAvailableForCurrentUser()
| ILIAS\GlobalScreen\Provider\DynamicProvider::isAvailableForCurrentUser | ( | ) |
Return a simple bool whether the GlobalScreen element could be relevant for the current logged in user.
E.g. if a user is not allowed to use the mail-system, return false;
- Returns
- bool
◆ isCurrentlyAvailable()
| ILIAS\GlobalScreen\Provider\DynamicProvider::isCurrentlyAvailable | ( | ) |
ATTENTION: Implement your isCurrentlyActive()-Method as efficient as possible.
- Returns
- bool
◆ isGloballyAvailable()
| ILIAS\GlobalScreen\Provider\DynamicProvider::isGloballyAvailable | ( | ) |
Return a simple bool whether your component provides dynamic elements for the GlobalScreen Service.
Return false e.g. if your component is not active. This should not be dependant from the current user.
- Returns
- bool
The documentation for this interface was generated from the following file:
- src/GlobalScreen/Provider/DynamicProvider.php
