StudipModule Interface Reference

Inheritance diagram for StudipModule:

Collaboration diagram for StudipModule:

Public Member Functions
	getIconNavigation ($course_id, $last_visit, $user_id)
	getTabNavigation ($course_id)
	getNotificationObjects ($course_id, $since, $user_id)

Member Function Documentation

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 AbstractStudIPStandardPlugin, CoreResources, CoreAdmin, CoreCalendar, CoreDocuments, CoreElearningInterface, CoreLiterature, CoreOverview, CoreParticipants, CoreSchedule, CoreScm, CoreStudygroupAdmin, CoreStudygroupParticipants, and CoreWiki.

getNotificationObjects	(		$course_id,
			$since,
			$user_id
	)

return a list of ContentElement-objects, conatinging everything new in this module

Parameters

string	$course_id	the course-id to get the new stuff for
int	$last_visit	when was the last time the user visited this module
string	$user_id	the user to get the notifcation-objects for

Returns

array an array of ContentElement-objects

Implemented in CoreAdmin, AbstractStudIPStandardPlugin, CoreOverview, CoreElearningInterface, CoreStudygroupAdmin, CoreScm, CoreLiterature, CoreSchedule, CoreParticipants, CoreCalendar, CoreResources, CoreWiki, CoreDocuments, and CoreStudygroupParticipants.

getTabNavigation

(

$course_id

)

Implemented in AbstractStudIPStandardPlugin, CoreElearningInterface, CoreLiterature, CoreScm, CoreWiki, CoreCalendar, CoreResources, CoreDocuments, CoreAdmin, CoreParticipants, CoreSchedule, CoreStudygroupAdmin, CoreStudygroupParticipants, and CoreOverview.

---

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

• lib/modules/StudipModule.class.php