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

Public Member Functions

 AbstractStudIPStandardPlugin ()
 setNavigation (StudipPluginNavigation $navigation)
 setId ($id)
 getId ()
 getIconNavigation ($course_id, $last_visit)
 getInfoTemplate ($course_id)
 getPluginExistingItems ($course_id)
 deactivationWarning ($context)
 hasChanged ($lastlogin)
 getOverviewMessage ($has_changed=false)
 isShownInOverview ()
 getChangeindicatoriconname ()
 setChangeindicatoriconname ($icon)
 setShownInOverview ($value=true)
 getScore ()
 isActivated ($context=NULL)
 setActivated ($value)
 display_action ($action)
- Public Member Functions inherited from AbstractStudIPLegacyPlugin
 __construct ()
 activatePlugin ()
 deactivatePlugin ()
 getAdminLink ()
 getBasepluginpath ()
 getDisplaytitle ()
 getNavigation ()
 getNavigationPosition ()
 getPluginclassname ()
 getPluginiconname ()
 getPluginName ()
 getUser ()
 hasNavigation ()
 isDependentOnOtherPlugin ()
 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)
- Public Member Functions inherited from StudIPPlugin
 getPluginId ()
 getPluginPath ()
 getPluginURL ()

Data Fields

 $id
 $overview
 $changeindicatoriconname
- Data Fields inherited from AbstractStudIPLegacyPlugin
 $pluginid
 $pluginname
 $pluginpath
 $basepluginpath
 $navposition
 $dependentonplugin
 $navigation
 $pluginiconname
 $user

Additional Inherited Members

- Protected Attributes inherited from StudIPPlugin
 $plugin_info

Member Function Documentation

Here is the call graph for this function:

deactivationWarning (   $context)

Return a warning message to be printed before deactivation of this plugin in the given context.

Parameters
$contextcontext range id

Reimplemented from StudIPPlugin.

Here is the call graph for this function:

display_action (   $action)

This method sets everything up to perform the given action and displays the results or anything you want to.

Parameters
stringthe name of the action to accomplish
Returns
void

Reimplemented from AbstractStudIPLegacyPlugin.

Here is the call graph for this function:

getChangeindicatoriconname ( )

Getter- und Setter für die Attribute

Deprecated:

Here is the call graph for this function:

Here is the caller graph for this function:

getIconNavigation (   $course_id,
  $last_visit 
)

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.

Parameters
stringcourse or institute range id
inttime of user's last visit
Returns
object navigation item to render or NULL

Implements StandardPlugin.

Here is the call graph for this function:

getId ( )

Return current course id - deprecated, do not use.

Deprecated:
getInfoTemplate (   $course_id)

Return a template (an instance of the Flexi_Template class) to be rendered on the course summary page. Return NULL to render nothing for this plugin.

Implements StandardPlugin.

getOverviewMessage (   $has_changed = false)

Nachricht für tooltip in der Übersicht

Parameters
has_changed- hat sich etwas geändert?
Deprecated:

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginExistingItems (   $course_id)

Gehen beim Deaktivieren des Plugins Daten verloren?

Deprecated:

Here is the caller graph for this function:

getScore ( )

returns the score which the current user get's for activities in this plugin

Deprecated:
hasChanged (   $lastlogin)

Hat sich seit dem letzten Login etwas geändert?

Parameters
lastlogin- letzter Loginzeitpunkt des Benutzers
Deprecated:

Here is the caller graph for this function:

isActivated (   $context = NULL)

Get the activation status of this plugin in the given context. This also checks the plugin default activations.

Deprecated:
Parameters
$contextcontext range id

Reimplemented from StudIPPlugin.

Here is the caller graph for this function:

isShownInOverview ( )

Wird dieses Plugin in der Übersicht angezeigt?

Deprecated:

Here is the caller graph for this function:

setActivated (   $value)

Sets the activation status of this plugin.

Deprecated:
Parameters
booleanplugin status (true or false)

Reimplemented from AbstractStudIPLegacyPlugin.

Here is the call graph for this function:

setChangeindicatoriconname (   $icon)
setId (   $id)

Set the current course id - deprecated, do not use.

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:

setShownInOverview (   $value = true)

Field Documentation

$changeindicatoriconname
$id
$overview

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