AbstractStudIPPortalPlugin Class Reference

Inheritance diagram for AbstractStudIPPortalPlugin:

Collaboration diagram for AbstractStudIPPortalPlugin:

Public Member Functions
	AbstractStudIPPortalPlugin ()
	showOverview ($unauthorizedview=true)
	hasAdministration ()
	hasUnauthorizedView ()
	hasAuthorizedView ()
	getPortalTemplate ()
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)
	getPortalTemplate ()

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)
Protected Attributes inherited from StudIPPlugin
	$plugin_info

Member Function Documentation

AbstractStudIPPortalPlugin()

AbstractStudIPPortalPlugin

(

)

getPortalTemplate()

getPortalTemplate

(

)

Return a template (an instance of the Flexi_Template class) to be rendered on the start or portal 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)

Returns

object template object to render or NULL

Implements PortalPlugin.

Here is the call graph for this function:

hasAdministration()

hasAdministration

(

)

Does this plugin have an administration page, which should be shown? This default implementation only shows it for admin or root user.

Deprecated:

Here is the caller graph for this function:

hasAuthorizedView()

hasAuthorizedView

(

)

Does the plugin have a view for a currently logged in user?

Deprecated:

Here is the caller graph for this function:

hasUnauthorizedView()

hasUnauthorizedView

(

)

Does the plugin have a view for a user not currently logged in?

Deprecated:

Here is the caller graph for this function:

showOverview()

showOverview

(

$unauthorizedview = true

)

Used to show an overview on the start page or portal page

Deprecated:

Parameters

is	the user already logged in?

Here is the caller graph for this function:

---

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

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