Stud.IP
6.0
|
Public Member Functions | |
getIconNavigation ($course_id, $last_visit, $user_id) | |
getTabNavigation ($course_id) | |
getMetadata () | |
isActivatableForContext (Range $context) | |
getInfoTemplate ($course_id) | |
Public Member Functions inherited from CorePlugin | |
getMetadata () | |
__construct () | |
getPluginId () | |
isEnabled () | |
getPluginName () | |
getPluginURL () | |
getPluginVersion () | |
getPluginDescription () | |
getDescriptionMode () | |
isHighlighted () | |
getHighlightText () | |
isCorePlugin () | |
isActivated ($context=null) | |
isActivatableForContext (Range $context) | |
Additional Inherited Members | |
Static Public Member Functions inherited from CorePlugin | |
static | onEnable ($plugin_id) |
static | onDisable ($plugin_id) |
static | onActivation ($plugin_id, $range_id) |
static | onDeactivation ($plugin_id, $range_id) |
static | checkActivation ($range_id) |
Protected Attributes inherited from CorePlugin | |
$plugin_info | |
getIconNavigation | ( | $course_id, | |
$last_visit, | |||
$user_id | |||
) |
{Return a navigation object representing this plugin in the course overview table or return NULL if you want to display no icon for this plugin (or course). The navigation object's title will not be shown, only the image (and its associated attributes like 'title') and the URL are actually used.By convention, new or changed plugin content is indicated by a different icon and a corresponding tooltip.
string | $course_id | course or institute range id |
int | $last_visit | time of user's last visit |
string | $user_id | the user to get the navigation for |
Implements StudipModule.
getInfoTemplate | ( | $course_id | ) |
Return a template (an instance of the Flexi class) to be rendered on the course summary 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)
Implements StudipModule.
getMetadata | ( | ) |
{Provides metadata like a descriptional text for this module that is shown on the course "+" page to inform users about what the module acutally does. Additionally, a URL can be specified.
Implements StudipModule.
getTabNavigation | ( | $course_id | ) |
{Return a navigation object representing this plugin in the course overview table or return NULL if you want to display no icon for this plugin (or course). The navigation object's title will not be shown, only the image (and its associated attributes like 'title') and the URL are actually used.By convention, new or changed plugin content is indicated by a different icon and a corresponding tooltip.
string | $course_id | course or institute range id |
Implements StudipModule.
isActivatableForContext | ( | Range | $context | ) |