StandardPlugin Interface Reference

Inheritance diagram for StandardPlugin:

Collaboration diagram for StandardPlugin:

Public Member Functions
	getIconNavigation ($course_id, $last_visit)
	getInfoTemplate ($course_id)

Member Function Documentation

getIconNavigation	(		$course_id,
			$last_visit
	)

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 or institute range id
int	time of user's last visit

Returns

object navigation item to render or NULL

Implemented in AbstractStudIPStandardPlugin.

getInfoTemplate

(

$course_id

)

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)

Returns

object template object to render or NULL

Implemented in AbstractStudIPStandardPlugin.

---

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

• lib/plugins/core/StandardPlugin.class.php