Inheritance diagram for ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface:
Collaboration diagram for ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface:
Public Member Functions | |
| isDefault () | |
| isOutdated () | |
| identifier () | |
| title () | |
| description () | |
| presentAsUIComponents () | |
| The copyright as UI Components, as it should be presented in the UI almost everywhere. More... | |
| presentAsImageOnly () | |
| The copyright just as its image, for use e.g. More... | |
| presentAsLinkOnly () | |
| The copyright just as a link, for use e.g. More... | |
| presentAsString () | |
| The copyright without image in a reduced presentation, for displaying copyright where no UI components can be used (e.g. More... | |
Detailed Description
Definition at line 27 of file CopyrightInterface.php.
Member Function Documentation
◆ description()
| ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface::description | ( | ) |
◆ identifier()
| ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface::identifier | ( | ) |
◆ isDefault()
| ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface::isDefault | ( | ) |
◆ isOutdated()
| ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface::isOutdated | ( | ) |
◆ presentAsImageOnly()
| ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface::presentAsImageOnly | ( | ) |
The copyright just as its image, for use e.g.
when the copyright needs to be inserted into other KS components, and the specific component it's presented as is important. If the copyright does not have an image, null is returned.
Implemented in ILIAS\MetaData\Services\CopyrightHelper\Copyright, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyright.
◆ presentAsLinkOnly()
| ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface::presentAsLinkOnly | ( | ) |
The copyright just as a link, for use e.g.
when the copyright needs to be inserted into other KS components, and the specific component it's presented as is important. If the copyright has no link, its full name is returned as a disabled link. If it also does not have a full name, null is returned.
Implemented in ILIAS\MetaData\Services\CopyrightHelper\Copyright, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyright.
◆ presentAsString()
| ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface::presentAsString | ( | ) |
The copyright without image in a reduced presentation, for displaying copyright where no UI components can be used (e.g.
exports of tables).
Implemented in ILIAS\MetaData\Services\CopyrightHelper\Copyright, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyright.
◆ presentAsUIComponents()
| ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface::presentAsUIComponents | ( | ) |
The copyright as UI Components, as it should be presented in the UI almost everywhere.
If only a string can be returned, it is returned in a legacy UI component.
- Returns
- Icon[]|Link[]|Content[]
Implemented in ILIAS\MetaData\Services\CopyrightHelper\Copyright, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyright.
◆ title()
| ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface::title | ( | ) |
The documentation for this interface was generated from the following file:
- components/ILIAS/MetaData/classes/Services/CopyrightHelper/CopyrightInterface.php
