StudipModule Interface Reference

Inheritance diagram for StudipModule:

Public Member Functions
	getIconNavigation ($course_id, $last_visit, $user_id)
	getTabNavigation ($course_id)
	getMetadata ()
	getInfoTemplate ($course_id)

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, ConsultationModule, CoursewareModule, CoreForum, GradebookModule, IliasInterfaceModule, Blubber, LtiToolModule, FeedbackModule, CoreStudygroupAdmin, CoreCalendar, CoreOverview, CoreParticipants, CoreSchedule, CoreScm, CoreStudygroupParticipants, CoreWiki, CoreAdmin, and CorePersonal.

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

Implemented in CoreParticipants, CoreDocuments, CoreWiki, CoreScm, CoreAdmin, CoreOverview, CoreSchedule, ConsultationModule, Blubber, CoreForum, LtiToolModule, CoreStudygroupAdmin, CoreCalendar, CorePersonal, CoreStudygroupParticipants, CoursewareModule, GradebookModule, IliasInterfaceModule, and FeedbackModule.

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 CoreForum, CoreParticipants, CoreDocuments, GradebookModule, IliasInterfaceModule, CoreAdmin, ConsultationModule, CoursewareModule, CoreWiki, CoreOverview, Blubber, CoreScm, LtiToolModule, CoreSchedule, CoreStudygroupAdmin, FeedbackModule, CoreCalendar, CorePersonal, 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 CoreDocuments, CoreParticipants, IliasInterfaceModule, CoreWiki, ConsultationModule, CoreScm, GradebookModule, CoreOverview, CoreSchedule, LtiToolModule, CoursewareModule, FeedbackModule, CoreCalendar, CoreStudygroupParticipants, CoreForum, CoreStudygroupAdmin, CoreAdmin, Blubber, and CorePersonal.

---

The documentation for this interface was generated from the following file:

• lib/modules/StudipModule.php