Public Member Functions | |
| getIconNavigation ($course_id, $last_visit, $user_id) | |
| getTabNavigation ($course_id) | |
| getMetadata () | |
Member Function Documentation
◆ getIconNavigation()
| getIconNavigation | ( | $course_id, | |
| $last_visit, | |||
| $user_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 int $last_visit time of user's last visit string $user_id the user to get the navigation for
- Returns
- object navigation item to render or NULL
Implemented in CoreDocuments, CoreAdmin, CoreCalendar, CoreElearningInterface, CoreLiterature, CoreOverview, CoreParticipants, CoreResources, CoreSchedule, CoreScm, CoreStudygroupAdmin, CoreStudygroupParticipants, and CoreWiki.
◆ getMetadata()
| getMetadata | ( | ) |
Provides metadata like a descriptional text for this module that is shown on the course "+" page to inform users about what the module acutally does. Additionally, a URL can be specified.
- Returns
- array metadata containg description and/or url
Implemented in CoreAdmin, CoreElearningInterface, CoreOverview, CoreScm, CoreStudygroupAdmin, CoreParticipants, CoreLiterature, CoreWiki, CoreResources, CoreSchedule, CoreCalendar, CoreDocuments, and CoreStudygroupParticipants.
◆ 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
Implemented in CoreElearningInterface, CoreLiterature, CoreScm, CoreWiki, CoreDocuments, CoreCalendar, CoreParticipants, CoreResources, CoreAdmin, CoreSchedule, CoreStudygroupAdmin, CoreStudygroupParticipants, and CoreOverview.
The documentation for this interface was generated from the following file:
- lib/modules/StudipModule.class.php
