aboutsummaryrefslogtreecommitdiff
path: root/lib/modules/StudipModuleExtended.php
blob: a2b885270c793cd91228a5863bb8337f1ad73fb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<?php

interface StudipModuleExtended extends StudipModule
{

    public const ICON_NAV_CACHE_PATH = 'modules_icon/';

    /**
     * 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.
     *
     * @param array $course_ids array of course or institute range ids
     * @param string|null $user_id the user to get the navigation for
     *
     * @return array associative array per given course, containing a navigation or null
     */
    public function getManyIconNavigation(array $course_ids, ?string $user_id = null): array;

}