Public Member Functions | |
| getManyIconNavigation (array $course_ids, ?string $user_id=null) | |
 Public Member Functions inherited from StudipModule | |
| getIconNavigation ($course_id, $last_visit, $user_id) | |
| getTabNavigation ($course_id) | |
| getMetadata () | |
| getInfoTemplate ($course_id) | |
Member Function Documentation
◆ 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, ...].
Implemented in CoreDocuments, ConsultationModule, CoursewareModule, CoreOverview, IliasInterfaceModule, CoreForum, GradebookModule, Blubber, FeedbackModule, CoreCalendar, CoreParticipants, CoreSchedule, CoreScm, CoreStudygroupAdmin, CoreStudygroupParticipants, CoreWiki, CorePersonal, and CoreAdmin.
The documentation for this interface was generated from the following file:
- lib/modules/StudipModuleExtended.php
