Abstract class for plugins. More...
Public Member Functions | |
| getContextSpecificPluginSettingsFile () | |
| getManagementVerbLinkAction (&$request, $verb, $defaultUrl) | |
| getNewPressPluginSettingsFile () | |
| getSetting ($pressId, $name) | |
| Plugin () | |
| updateSetting ($pressId, $name, $value, $type=null) | |
Detailed Description
Abstract class for plugins.
Definition at line 18 of file Plugin.inc.php.
Member Function Documentation
| Plugin.getContextSpecificPluginSettingsFile | ( | ) |
Get the filename of the settings data for this plugin to install when a press is created (i.e. press-level plugin settings). Subclasses using default settings should override this.
- Returns:
- string
Definition at line 68 of file Plugin.inc.php.
References getNewPressPluginSettingsFile().
| Plugin.getManagementVerbLinkAction | ( | &$ | request, | |
| $ | verb, | |||
| $ | defaultUrl | |||
| ) |
Get a link action to be used in plugin's grid row action for the passed verb.
- Parameters:
-
$request Request $verb array The verb name and locale key. $defaultUrl string The grid that will use this method to get a management verb link action will pass a default url to be used in the link action request, with the correct plugins parameters (category, name, verb) and directing to the grid plugin management method.
- Returns:
- LinkAction or null
Reimplemented in ImportExportPlugin.
Definition at line 99 of file Plugin.inc.php.
| Plugin.getNewPressPluginSettingsFile | ( | ) |
For backwards compatibility only.
New plug-ins should override getContextSpecificPluginSettingsFile()
- See also:
- PKPPlugin.getContextSpecificPluginSettingsFile()
- Returns:
- string
Definition at line 83 of file Plugin.inc.php.
Referenced by getContextSpecificPluginSettingsFile().
| Plugin.getSetting | ( | $ | pressId, | |
| $ | name | |||
| ) |
Backwards compatible convenience version of the generic getContextSpecificSetting() method.
- See also:
- PKPPlugin.getContextSpecificSetting()
- Parameters:
-
$pressId $name
Definition at line 35 of file Plugin.inc.php.
Referenced by PayPalPlugin.displayPaymentForm(), ManualPaymentPlugin.displayPaymentForm(), PayPalPlugin.handle(), PayPalPlugin.isConfigured(), and ManualPaymentPlugin.isConfigured().
| Plugin.Plugin | ( | ) |
Constructor
Definition at line 22 of file Plugin.inc.php.
Referenced by AuthPlugin.AuthPlugin(), and PaymethodPlugin.PaymethodPlugin().
| Plugin.updateSetting | ( | $ | pressId, | |
| $ | name, | |||
| $ | value, | |||
| $ | type = null | |||
| ) |
Backwards compatible convenience version of the generic updateContextSpecificSetting() method.
- See also:
- PKPPlugin.updateContextSpecificSetting()
- Parameters:
-
$pressId int $name string The name of the setting $value mixed $type string optional
Definition at line 57 of file Plugin.inc.php.
The documentation for this class was generated from the following file:
- classes/plugins/Plugin.inc.php
Generated on Mon Sep 17 2012 13:58:58 for Open Monograph Press by
1.7.1