blob: c281d29fb83ef7050fc7dff29da9c772bf1cb298 (
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
<?php
/*
* Copyright (c) 2012 Rasmus Fuhse <fuhse@data-quest.de>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
interface StudipModule
{
/**
* 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.
*
* @param string $course_id course or institute range id
* @param int $last_visit time of user's last visit
* @param string $user_id the user to get the navigation for
*
* @return object navigation item to render or NULL
*/
public function 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.
*
* @param string $course_id course or institute range id
*
* @return array navigation item to render or NULL
*/
public function getTabNavigation($course_id);
/**
* 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.
*
* @return array metadata containg description and/or url
*/
public function getMetadata();
/**
* Return a template (an instance of the Flexi\Template 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)
*
* @return Flexi\Template|null template object to render or NULL
*/
public function getInfoTemplate($course_id);
}
|
