CoinsPlugin Class Reference
[Plugins_generic_coins]
COinS plugin class.
More...
Public Member Functions | |
| getDescription () | |
| getDisplayName () | |
| getEnabled () | |
| getInstallSitePluginSettingsFile () | |
| getManagementVerbs () | |
| getName () | |
| insertFooter ($hookName, $params) | |
| manage ($verb, $args) | |
| register ($category, $path) | |
| setEnabled ($enabled) | |
Detailed Description
COinS plugin class.Definition at line 20 of file CoinsPlugin.inc.php.
Member Function Documentation
| CoinsPlugin.getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 52 of file CoinsPlugin.inc.php.
References Locale.translate().
| CoinsPlugin.getDisplayName | ( | ) |
Get the display name for this plugin.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 48 of file CoinsPlugin.inc.php.
References Locale.translate().
| CoinsPlugin.getEnabled | ( | ) |
Determine whether or not this plugin is enabled.
Definition at line 87 of file CoinsPlugin.inc.php.
References Request.getJournal().
Referenced by getManagementVerbs(), and insertFooter().
| CoinsPlugin.getInstallSitePluginSettingsFile | ( | ) |
Get the name of the settings file to be installed site-wide when OJS is installed.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 61 of file CoinsPlugin.inc.php.
References Plugin.getPluginPath().
| CoinsPlugin.getManagementVerbs | ( | ) |
Display verbs for the management interface.
Reimplemented from Plugin.
Definition at line 68 of file CoinsPlugin.inc.php.
References getEnabled(), and Locale.translate().
| CoinsPlugin.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 44 of file CoinsPlugin.inc.php.
| CoinsPlugin.insertFooter | ( | $ | hookName, | |
| $ | params | |||
| ) |
Insert COinS tag.
Definition at line 108 of file CoinsPlugin.inc.php.
References getEnabled(), TemplateManager.getManager(), and Request.url().
| CoinsPlugin.manage | ( | $ | verb, | |
| $ | args | |||
| ) |
Perform management functions
Reimplemented from Plugin.
Definition at line 162 of file CoinsPlugin.inc.php.
References Request.redirect(), and setEnabled().
| CoinsPlugin.register | ( | $ | category, | |
| $ | path | |||
| ) |
Called as a plugin is registered to the registry
- Parameters:
-
$category String Name of category plugin was registered to
- Returns:
- boolean True iff plugin initialized successfully; if false, the plugin will not be registered.
Reimplemented from Plugin.
Definition at line 28 of file CoinsPlugin.inc.php.
References Plugin.addLocaleData(), Config.getVar(), and HookRegistry.register().
| CoinsPlugin.setEnabled | ( | $ | enabled | ) |
Set the enabled/disabled state of this plugin
Definition at line 96 of file CoinsPlugin.inc.php.
References Request.getJournal(), and Plugin.updateSetting().
Referenced by manage().
The documentation for this class was generated from the following file:
- plugins/generic/coins/CoinsPlugin.inc.php
