Stud.IP  jlu_3.3 Revision
AbstractStudIPHomepagePlugin Class Reference
Inheritance diagram for AbstractStudIPHomepagePlugin:
Inheritance graph
Collaboration diagram for AbstractStudIPHomepagePlugin:
Collaboration graph

Public Member Functions

 AbstractStudIPHomepagePlugin ()
 
 setNavigation (StudipPluginNavigation $navigation)
 
 showOverview ()
 
 getStatusShowOverviewPage ()
 
 setStatusShowOverviewPage ($status)
 
 setRequestedUser ($user)
 
 getRequestedUser ()
 
 getHomepageTemplate ($user_id)
 
- 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)
 
 getHomepageTemplate ($user_id)
 

Data Fields

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

Detailed Description

Member Function Documentation

◆ AbstractStudIPHomepagePlugin()

Here is the call graph for this function:

◆ getHomepageTemplate()

getHomepageTemplate (   $user_id)

Return a template (an instance of the Flexi_Template class) to be rendered on the given user's home 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 HomepagePlugin.

Here is the call graph for this function:

◆ getRequestedUser()

getRequestedUser ( )

Return current user - deprecated, do not use.

Deprecated:
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getStatusShowOverviewPage()

getStatusShowOverviewPage ( )

true: overviewpage is enabled false: overviewpage is disabled

Deprecated:
Here is the caller 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:

◆ setRequestedUser()

setRequestedUser (   $user)

Does nothing - deprecated, do not use.

Deprecated:
Here is the caller graph for this function:

◆ setStatusShowOverviewPage()

setStatusShowOverviewPage (   $status)

◆ showOverview()

showOverview ( )

Used to show an overview on the homepage of a user.

Deprecated:
Here is the caller graph for this function:

Field Documentation

◆ $requesteduser

$requesteduser

◆ $status_showOverview

$status_showOverview

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