Open Journal Systems
3.3.0
|
Additional Inherited Members | |
Data Fields inherited from Plugin | |
$pluginCategory | |
$pluginPath | |
$request | |
Protected Member Functions inherited from Plugin | |
_registerTemplateResource ($inCore=false) | |
SWORD deposit plugin class.
Definition at line 23 of file SwordPlugin.inc.php.
SwordPlugin::callbackAuthorDeposits | ( | $hookName, | |
$args | |||
) |
Performs automatic deposit on accept decision
$hookName | string |
$args | array |
Definition at line 66 of file SwordPlugin.inc.php.
References performAutomaticDeposits().
SwordPlugin::callbackLoadCategory | ( | $hookName, | |
$args | |||
) |
Load all plugins for a given category.
$category | string The name of the category to load |
$enabledOnly | boolean if true load only enabled plug-ins (db-installation required), otherwise look on disk and load all available plug-ins (no db required). |
$mainContextId | integer To identify enabled plug-ins we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID. |
Definition at line 178 of file SwordPlugin.inc.php.
SwordPlugin::callbackPublish | ( | $hookName, | |
$args | |||
) |
Performs automatic deposit on publication
$hookName | string |
$args | array |
Definition at line 52 of file SwordPlugin.inc.php.
References PKPServices\get(), and performAutomaticDeposits().
SwordPlugin::callbackSettingsTab | ( | $hookName, | |
$args | |||
) |
Extend the website settings tabs to include sword settings
$hookName | string The name of the invoked hook |
$args | array Hook parameters |
Definition at line 226 of file SwordPlugin.inc.php.
References Plugin\$request, Registry\get(), PKPTemplateManager\getManager(), and Plugin\getTemplateResource().
SwordPlugin::callbackSwordLoadHandler | ( | $hookName, | |
$args | |||
) |
Definition at line 194 of file SwordPlugin.inc.php.
References $op, and Plugin\getPluginPath().
SwordPlugin::getActions | ( | $request, | |
$verb | |||
) |
Reimplemented from Plugin.
Definition at line 276 of file SwordPlugin.inc.php.
References Plugin\$request, and Plugin\getEnabled().
SwordPlugin::getDescription | ( | ) |
Get the description of this plugin
Reimplemented from Plugin.
Definition at line 269 of file SwordPlugin.inc.php.
SwordPlugin::getDisplayName | ( | ) |
Get the display name of this plugin
Reimplemented from Plugin.
Definition at line 261 of file SwordPlugin.inc.php.
SwordPlugin::getInstallEmailTemplatesFile | ( | ) |
Reimplemented from Plugin.
Definition at line 327 of file SwordPlugin.inc.php.
References Plugin\getPluginPath().
SwordPlugin::getInstallSchemaFile | ( | ) |
Get the filename of the ADODB schema for this plugin.
Reimplemented from Plugin.
Definition at line 320 of file SwordPlugin.inc.php.
References Plugin\getPluginPath().
SwordPlugin::getJsUrl | ( | $request | ) |
Get plugin JS URL
Definition at line 304 of file SwordPlugin.inc.php.
References Plugin\$request, and Plugin\getPluginPath().
SwordPlugin::getTypeMap | ( | ) |
Definition at line 308 of file SwordPlugin.inc.php.
SwordPlugin::performAutomaticDeposits | ( | Submission | $submission | ) |
Performs automatic deposits and mails authors
$submission | Submission |
Definition at line 80 of file SwordPlugin.inc.php.
References Plugin\$request, Registry\get(), DAORegistry\getDAO(), DataObject\getId(), PKPSubmission\getLocalizedTitle(), and Plugin\getSetting().
Referenced by callbackAuthorDeposits(), and callbackPublish().
SwordPlugin::register | ( | $category, | |
$path, | |||
$mainContextId = null |
|||
) |
Load and initialize the plug-in and register plugin hooks.
For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.
$category | String Name of category plugin was registered to |
$path | String The path the plugin was found in |
$mainContextId | integer To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID. |
Reimplemented from LazyLoadPlugin.
Definition at line 27 of file SwordPlugin.inc.php.
References Plugin\getEnabled(), HookRegistry\register(), and DAORegistry\registerDAO().
SwordPlugin::setupGridHandler | ( | $hookName, | |
$params | |||
) |
Permit requests to SWORD deposit points grid handler
$hookName | string The name of the hook being invoked |
$args | array The parameters to the invoked hook |
Definition at line 242 of file SwordPlugin.inc.php.
References SwordDepositPointsGridHandler\setPlugin().