Stud.IP  2.0 Revision 48548
 All Data Structures Namespaces Files Functions Variables Pages
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)
 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
 getPluginId ()
 getPluginPath ()
 getPluginURL ()
 isActivated ($context=NULL)
 deactivationWarning ($context)

Data Fields

 $requesteduser
 $status_showOverview
- Data Fields inherited from AbstractStudIPLegacyPlugin
 $pluginid
 $pluginname
 $pluginpath
 $basepluginpath
 $navposition
 $dependentonplugin
 $navigation
 $pluginiconname
 $user

Additional Inherited Members

- Protected Attributes inherited from StudIPPlugin
 $plugin_info

Detailed Description

Member Function Documentation

Here is the call graph for this function:

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 ( )

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 ( )

true: overviewpage is enabled false: overviewpage is disabled

Deprecated:

Here is the caller graph for this function:

setNavigation ( StudipPluginNavigation  $navigation)

Sets the navigation of this plugin.

Deprecated:

Reimplemented from AbstractStudIPLegacyPlugin.

Here is the call graph for this function:

setRequestedUser (   $user)

Does nothing - deprecated, do not use.

Deprecated:

Here is the caller graph for this function:

setStatusShowOverviewPage (   $status)
showOverview ( )

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

Deprecated:

Here is the caller graph for this function:

Field Documentation

$requesteduser
$status_showOverview

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