AbstractStudIPSystemPlugin Class Reference

Inheritance diagram for AbstractStudIPSystemPlugin:

Collaboration diagram for AbstractStudIPSystemPlugin:

Public Member Functions
	AbstractStudIPSystemPlugin ()
	setNavigation (StudipPluginNavigation $navigation)
	hasBackgroundTasks ()
	doBackgroundTasks ()
	getScore ()
	setDisplayType ($display_type)
	getDisplayType ($filter=-1)
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)

Protected Attributes
	$display_type
Protected Attributes inherited from StudIPPlugin
	$plugin_info

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)
Data Fields inherited from AbstractStudIPLegacyPlugin
	$pluginid
	$pluginname
	$pluginpath
	$basepluginpath
	$navposition
	$dependentonplugin
	$navigation
	$pluginiconname
	$user
Protected Member Functions inherited from StudIPPlugin
	addStylesheet ($filename)

Member Function Documentation

AbstractStudIPSystemPlugin()

AbstractStudIPSystemPlugin

(

)

doBackgroundTasks()

doBackgroundTasks

(

)

abstract function for doing all background tasks

Deprecated:

getDisplayType()

getDisplayType

(

$filter = -1

)

returns where the plugin will be visible (toolbar and/or start page)

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:

hasBackgroundTasks()

hasBackgroundTasks

(

)

A system plugin can do system tasks like logging in the background. This function

Deprecated:

Returns

true - plugin should be called for background task false - plugin has no background task

setDisplayType()

setDisplayType

(

$display_type

)

define where the plugin will be visible (toolbar and/or start page)

Deprecated:

Here is the call graph for this function:

setNavigation()

setNavigation

(

StudipPluginNavigation

$navigation

)

Sets the navigation of this plugin.

Deprecated:

Reimplemented from AbstractStudIPLegacyPlugin.

Here is the call graph for this function:

Field Documentation

$display_type

$display_type

protected

---

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

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