CmsPlugin Class Reference
[Plugins_generic_cms]
CMS plugin class.
More...
Public Member Functions | |
| callbackLoadCategory ($hookName, $args) | |
| getDescription () | |
| getDisplayName () | |
| getEnabled () | |
| getManagementVerbs () | |
| getName () | |
| manage ($verb, $args) | |
| register ($category, $path) | |
| setEnabled ($enabled) | |
Detailed Description
CMS plugin class.Definition at line 20 of file CmsPlugin.inc.php.
Member Function Documentation
| CmsPlugin.callbackLoadCategory | ( | $ | hookName, | |
| $ | args | |||
| ) |
Register as a block plugin, even though this is a generic plugin. This will allow the plugin to behave as a block plugin, i.e. to have layout tasks performed on it.
- Parameters:
-
$hookName string $args array
Definition at line 71 of file CmsPlugin.inc.php.
| CmsPlugin.getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 30 of file CmsPlugin.inc.php.
References Locale.translate().
| CmsPlugin.getDisplayName | ( | ) |
Get the display name for this plugin.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 26 of file CmsPlugin.inc.php.
References Locale.translate().
| CmsPlugin.getEnabled | ( | ) |
Determine whether or not this plugin is enabled.
Definition at line 104 of file CmsPlugin.inc.php.
References Request.getJournal().
Referenced by getManagementVerbs(), and register().
| CmsPlugin.getManagementVerbs | ( | ) |
Display verbs for the management interface.
Reimplemented from Plugin.
Definition at line 142 of file CmsPlugin.inc.php.
References getEnabled(), and Locale.translate().
| CmsPlugin.getName | ( | ) |
Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).
- Returns:
- String name of plugin
Reimplemented from Plugin.
Definition at line 22 of file CmsPlugin.inc.php.
| CmsPlugin.manage | ( | $ | verb, | |
| $ | args | |||
| ) |
Perform management functions
Reimplemented from Plugin.
Definition at line 167 of file CmsPlugin.inc.php.
References Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), and setEnabled().
| CmsPlugin.register | ( | $ | category, | |
| $ | path | |||
| ) |
Register the plugin, attaching to hooks as necessary.
- Parameters:
-
$category string $path string
- Returns:
- boolean
Reimplemented from Plugin.
Definition at line 52 of file CmsPlugin.inc.php.
References Plugin.addLocaleData(), getEnabled(), and HookRegistry.register().
| CmsPlugin.setEnabled | ( | $ | enabled | ) |
Set the enabled/disabled state of this plugin
Definition at line 113 of file CmsPlugin.inc.php.
References Request.getJournal(), PluginRegistry.getPlugin(), and Plugin.updateSetting().
Referenced by manage().
The documentation for this class was generated from the following file:
- plugins/generic/cms/CmsPlugin.inc.php
