IliasInterfaceModule Class Reference

Inheritance diagram for IliasInterfaceModule:

Collaboration diagram for IliasInterfaceModule:

Public Member Functions
	__construct ()
	isActivatableForContext (Range $context)
	getInfoTemplate ($course_id)
	getIconNavigation ($course_id, $last_visit, $user_id)
	getTabNavigation ($course_id)
	getMetadata ()
Public Member Functions inherited from StudIPPlugin
	__construct ()
	getPluginId ()
	getPluginName ()
	getPluginPath ()
	getPluginURL ()
	getMetadata ()
	getPluginVersion ()
	isCorePlugin ()
	isActivated ($context=null, $type='sem')
	isActivatableForContext (Range $context)
	perform ($unconsumed_path)

Additional Inherited Members
Static Public Member Functions inherited from StudIPPlugin
static	onEnable ($plugin_id)
static	onDisable ($plugin_id)
Protected Attributes inherited from StudIPPlugin
	$plugin_info
	$manifest = null

Detailed Description

Ilias Interface - navigation and meta data

Author

André Noack noack.nosp@m.@dat.nosp@m.a-que.nosp@m.st.d.nosp@m.e

Copyright

2019 Stud.IP Core-Group GPL version 2 or any later version

Since

4.3

Constructor & Destructor Documentation

__construct()

__construct

(

)

Here is the call graph for this function:

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

Implements StudipModule.

Here is the call graph for this function:

getInfoTemplate()

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

Implements StandardPlugin.

getMetadata()

getMetadata

(

)

See also

StudipModule::getMetadata()

Implements StudipModule.

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

Implements StudipModule.

Here is the call graph for this function:

isActivatableForContext()

isActivatableForContext

(

Range

$context

)

Here is the call graph for this function:

---

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

• lib/modules/IliasInterfaceModule.class.php