◆ __construct()
◆ actionShow()
| actionShow |
( |
|
$param = NULL | ) |
|
This is the standard action of this plugin.
◆ activatePlugin()
Aktiviert das Plugin - deprecated, do not use.
- Deprecated:
◆ deactivatePlugin()
Deaktiviert das Plugin - deprecated, do not use.
- Deprecated:
◆ display_action()
| display_action |
( |
|
$action | ) |
|
This method sets everything up to perform the given action and displays the results or anything you want to.
- Parameters
-
| string | the name of the action to accomplish |
- Returns
- void
Reimplemented in AbstractStudIPStandardPlugin.
◆ getAdminLink()
Returns the URI to the administration page of this plugin. Override this method, if you want another URI, or return NULL to signal, that there is no such page.
- Deprecated:
- Returns
- string if this plugin has an administration page return its URI, return NULL otherwise
◆ getBasepluginpath()
Returns the plugin's relative path - deprecated, do not use.
- Deprecated:
◆ getDescription()
| static getDescription |
( |
| ) |
|
|
static |
◆ getDisplaytitle()
Which text should be shown in certain titles?
- Deprecated:
- Returns
- string title
◆ getNavigation()
◆ getNavigationPosition()
| getNavigationPosition |
( |
| ) |
|
Returns the plugin's navigation position - deprecated, do not use.
- Deprecated:
◆ getPluginclassname()
Returns the class name of this plugin (in lower case).
- Deprecated:
◆ getPluginiconname()
◆ getPluginName()
Return the name of this plugin.
Reimplemented from StudIPPlugin.
◆ getUser()
◆ hasNavigation()
Check whether this plugin has a navigation.
- Deprecated:
◆ isDependentOnOtherPlugin()
| isDependentOnOtherPlugin |
( |
| ) |
|
Check if this plugin depends on another plugin - deprecated, do not use.
- Deprecated:
◆ perform()
| perform |
( |
|
$unconsumed_path | ) |
|
This method dispatches and displays all actions. It uses the template method design pattern, so you may want to implement the methods route and/or display to adapt to your needs.
- Parameters
-
| string | the part of the dispatch path, that were not consumed yet |
- Returns
- void
Reimplemented from StudIPPlugin.
◆ route()
| route |
( |
|
$unconsumed_path | ) |
|
Called by perform to detect the action to be accomplished.
- Parameters
-
| string | the part of the dispatch path, that were not consumed yet |
- Returns
- string the name of the instance method to be called
◆ setActivated()
◆ setBasepluginpath()
| setBasepluginpath |
( |
|
$path | ) |
|
◆ setDependentOnOtherPlugin()
| setDependentOnOtherPlugin |
( |
|
$dependentplugin = true | ) |
|
◆ setNavigation()
◆ setNavigationPosition()
| setNavigationPosition |
( |
|
$pos | ) |
|
◆ setPluginiconname()
| setPluginiconname |
( |
|
$icon | ) |
|
◆ setPluginId()
◆ setPluginName()
◆ setPluginPath()
◆ setUser()
◆ show()
Does nothing - deprecated, do not use.
- Parameters
-
| $param | - set if a subnavigation item was clicked. The value is plugin dependent and specified by the plugins subnavigation link params. |
- Deprecated:
◆ $basepluginpath
◆ $dependentonplugin
◆ $navigation
◆ $navposition
◆ $pluginiconname
◆ $pluginid
◆ $pluginname
◆ $pluginpath
◆ $user
The documentation for this class was generated from the following file: