Inheritance diagram for AbstractStudIPStandardPlugin:

Collaboration diagram for AbstractStudIPStandardPlugin:

Public Member Functions
	AbstractStudIPStandardPlugin ()

	setNavigation (StudipPluginNavigation $navigation)

	getTabNavigation ($course_id)

	setId ($id)

	getId ()

	getIconNavigation ($course_id, $last_visit, $user_id)

	getInfoTemplate ($course_id)

	getNotificationObjects ($course_id, $since, $user_id)

	getPluginExistingItems ($course_id)

	deactivationWarning ($context)

	hasChanged ($lastlogin)

	getOverviewMessage ($has_changed=false)

	isShownInOverview ()

	getChangeindicatoriconname ()

	setChangeindicatoriconname ($icon)

	setShownInOverview ($value=true)

	getScore ()

	isActivated ($context=NULL)

	setActivated ($value)

	display_action ($action)

Public Member Functions inherited from AbstractStudIPLegacyPlugin
	__construct ()

	activatePlugin ()

	deactivatePlugin ()

	getAdminLink ()

	getBasepluginpath ()

	getDisplaytitle ()

	getNavigation ()

	getNavigationPosition ()

	getPluginclassname ()

	getPluginiconname ()

	getPluginName ()

	getUser ()

	hasNavigation ()

	isDependentOnOtherPlugin ()

	setActivated ($value)

	setBasepluginpath ($path)

	setDependentOnOtherPlugin ($dependentplugin=true)

	setNavigation (StudipPluginNavigation $navigation)

	setNavigationPosition ($pos)

	setPluginiconname ($icon)

	setPluginId ($id)

	setPluginName ($name)

	setPluginPath ($path)

	setUser (StudIPUser $user)

	actionShow ($param=NULL)

	show ($param=NULL)

	perform ($unconsumed_path)

	route ($unconsumed_path)

	display_action ($action)

Public Member Functions inherited from StudIPPlugin
	__construct ()

	getPluginId ()

	getPluginName ()

	getPluginPath ()

	getPluginURL ()

	getMetadata ()

	isCorePlugin ()

	isActivated ($context=null, $type='sem')

	deactivationWarning ($context)

	perform ($unconsumed_path)

	getInfoTemplate ($course_id)

Public Member Functions inherited from StudipModule
	getIconNavigation ($course_id, $last_visit, $user_id)

	getTabNavigation ($course_id)

	getNotificationObjects ($course_id, $since, $user_id)

	getMetadata ()

Data Fields
	$id

	$overview

	$changeindicatoriconname

Data Fields inherited from AbstractStudIPLegacyPlugin
	$pluginid

	$pluginname

	$pluginpath

	$basepluginpath

	$navposition

	$dependentonplugin

	$navigation

	$pluginiconname

	$user

Additional Inherited Members
Static Public Member Functions inherited from AbstractStudIPLegacyPlugin
static	getDescription ()

Static Public Member Functions inherited from StudIPPlugin
static	onEnable ($pluginId)

static	onDisable ($pluginId)

Protected Member Functions inherited from StudIPPlugin
	addStylesheet ($filename, $variables=[], $link_attr=[])

Protected Attributes inherited from StudIPPlugin
	$plugin_info

Detailed Description

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.

Deprecated:

Member Function Documentation

◆ AbstractStudIPStandardPlugin()

AbstractStudIPStandardPlugin ( )

◆ deactivationWarning()

deactivationWarning ( $context )

Return a warning message to be printed before deactivation of this plugin in the given context.

Parameters

$context context range id

Reimplemented from StudIPPlugin.

Here is the call graph for this function:

◆ display_action()

display_action ( $action )

This method sets everything up to perform the given action and displays the results or anything you want to.

Parameters

string the name of the action to accomplish

Returns: void

Reimplemented from AbstractStudIPLegacyPlugin.

◆ getChangeindicatoriconname()

getChangeindicatoriconname ( )

Getter- und Setter für die Attribute

Deprecated:

Here is the call graph for this function:

Here is the caller graph for this function:

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

Returns: object navigation item to render or NULL

Implements StudipModule.

Here is the call graph for this function:

◆ getId()

getId ( )

Return current course id - deprecated, do not use.

Deprecated:

◆ 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.

Implements StandardPlugin.

◆ getNotificationObjects()

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

Implements StudipModule.

◆ getOverviewMessage()

getOverviewMessage ( $has_changed = false )

Nachricht für tooltip in der Übersicht

Parameters

has_changed - hat sich etwas geändert?

Deprecated:

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginExistingItems()

getPluginExistingItems ( $course_id )

Gehen beim Deaktivieren des Plugins Daten verloren?

Deprecated:

Here is the caller graph for this function:

◆ getScore()

getScore ( )

returns the score which the current user get's for activities in this plugin

Deprecated:

◆ getTabNavigation()

getTabNavigation ( $course_id )

Return an array of navigation objects representing this plugin in the course (or institute) navigation or return NULL if you do not want any navigation for this plugin. The array key is used as the name in the navigation tree (subelement of "/course").

Parameters

string $course_id course or institute range id