Public Member Functions | |
| __construct () | |
| isActivatableForContext (Range $context) | |
| getInfoTemplate ($course_id) | |
| getManyIconNavigation (array $course_ids, ?string $user_id=null) | |
| getTabNavigation ($course_id) | |
| getMetadata () | |
 Public Member Functions inherited from CorePlugin | |
| getMetadata () | |
| __construct () | |
| getPluginId () | |
| isEnabled () | |
| getPluginName () | |
| getPluginURL () | |
| getPluginVersion () | |
| getPluginDescription () | |
| getDescriptionMode () | |
| isHighlighted () | |
| getHighlightText () | |
| isCorePlugin () | |
| isActivated ($context=null) | |
| isActivatableForContext (Range $context) | |
| Public Member Functions inherited from StudipModule | |
| getIconNavigation ($course_id, $last_visit, $user_id) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from CorePlugin | |
| static | onEnable ($plugin_id) |
| static | onDisable ($plugin_id) |
| static | onActivation ($plugin_id, $range_id) |
| static | onDeactivation ($plugin_id, $range_id) |
| static | checkActivation ($range_id) |
| Protected Attributes inherited from CorePlugin | |
| $plugin_info | |
Detailed Description
Ilias Interface - navigation and meta data
- Copyright
- 2019 Stud.IP Core-Group GPL version 2 or any later version
- Since
- 4.3
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | ) |
Member Function Documentation
◆ getInfoTemplate()
| getInfoTemplate | ( | $course_id | ) |
Return a template (an instance of the Flexi class) to be rendered on the course summary page. Return NULL to render nothing for this plugin.
The template will automatically get a standard layout, which can be configured via attributes set on the template:
title title to display, defaults to plugin name icon_url icon for this plugin (if any) admin_url admin link for this plugin (if any) admin_title title for admin link (default: Administration)
- Returns
- Flexi|null template object to render or NULL
Implements StudipModule.
◆ getManyIconNavigation()
| getManyIconNavigation | ( | array | $course_ids, |
| ?string | $user_id = null |
||
| ) |
Returns navigation objects representing this plugin in the course overview table for every given course or institute. The navigation object's title will not be shown, only the image (and its associated attributes like 'title') and the URL are actually used.
By convention, new or changed plugin content is indicated by a different icon and a corresponding tooltip.
Returning null for a course will result in a blank space, while returning no entry will render nothing.
- Parameters
-
array $course_ids array of course or institute range ids. Only ranges where the module is active should be given string | null $user_id the user to get the navigation for
- Returns
- Navigation[] associative array per given course, containing a navigation or null, where the course_id is the key: ['course_id_1' => $nav1, 'course_id_2' => $nav2, 'course_id_3' => null, ...].
Implements StudipModuleExtended.
◆ getMetadata()
| getMetadata | ( | ) |
- See also
- StudipModule::getMetadata()
Implements StudipModule.
◆ getTabNavigation()
| getTabNavigation | ( | $course_id | ) |
Return a navigation object representing this plugin in the course overview table or return NULL if you want to display no icon for this plugin (or course). The navigation object's title will not be shown, only the image (and its associated attributes like 'title') and the URL are actually used.
By convention, new or changed plugin content is indicated by a different icon and a corresponding tooltip.
- Parameters
-
string $course_id course or institute range id
- Returns
- array navigation item to render or NULL
Implements StudipModule.
◆ isActivatableForContext()
| isActivatableForContext | ( | Range | $context | ) |
The documentation for this class was generated from the following file:
- lib/modules/IliasInterfaceModule.php
