Stud.IP  2.0 Revision 48548
 All Data Structures Namespaces Files Functions Variables Pages
HomepagePlugin Interface Reference
Inheritance diagram for HomepagePlugin:
Inheritance graph
Collaboration diagram for HomepagePlugin:
Collaboration graph

Public Member Functions

 getHomepageTemplate ($user_id)

Member Function Documentation

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) admin_title title for admin link (default: Administration)

Returns
object template object to render or NULL

Implemented in AbstractStudIPHomepagePlugin.


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