Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
SwordPlugin Class Reference
Inheritance diagram for SwordPlugin:
GenericPlugin

Public Member Functions

 callbackAuthorDeposits ($hookName, $args)
 
 callbackLoadCategory ($hookName, $args)
 
 callbackLoadHandler ($hookName, $args)
 
 callbackNotificationContents ($hookName, $args)
 
 getDescription ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getManagementVerbs ()
 
 getSupported ()
 
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 
 getManagementVerbs ($verbs=array())
 
 manage ($verb, $args, &$message, &$messageParams)
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

Sword deposit plugin.

SWORD deposit plugin class.

Definition at line 28 of file SwordPlugin.inc.php.

Member Function Documentation

SwordPlugin::callbackAuthorDeposits (   $hookName,
  $args 
)

Hook registry function that is called when it's time to perform all automatic deposits and notify the author of optional deposits.

Parameters
$hookNamestring
$argsarray

Definition at line 120 of file SwordPlugin.inc.php.

References Request\getJournal(), Plugin\getSetting(), and Request\url().

SwordPlugin::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
$hookNamestring
$argsarray

Definition at line 84 of file SwordPlugin.inc.php.

References PKPPlugin\getName().

SwordPlugin::callbackLoadHandler (   $hookName,
  $args 
)

Hook registry function that is called to display the sword deposit page for authors.

Parameters
$hookNamestring
$argsarray

Definition at line 104 of file SwordPlugin.inc.php.

References PKPPlugin\getName(), and PKPPlugin\getPluginPath().

SwordPlugin::callbackNotificationContents (   $hookName,
  $args 
)

Hook registry function to provide notification messages for SWORD notifications

Parameters
$hookNamestring
$argsarray

Definition at line 194 of file SwordPlugin.inc.php.

References DAORegistry\getDAO().

SwordPlugin::getDescription ( )

Get the description of this plugin

Returns
string

Definition at line 49 of file SwordPlugin.inc.php.

References getSupported().

SwordPlugin::getDisplayName ( )

Get the display name of this plugin

Returns
string

Definition at line 33 of file SwordPlugin.inc.php.

SwordPlugin::getEnabled ( )

Check whether or not this plugin is enabled

Returns
boolean

Definition at line 71 of file SwordPlugin.inc.php.

References Request\getJournal(), and Plugin\getSetting().

Referenced by getManagementVerbs().

SwordPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 224 of file SwordPlugin.inc.php.

References getEnabled(), and getSupported().

SwordPlugin::getSupported ( )

Determine whether or not this plugin is supported.

Returns
boolean

Definition at line 41 of file SwordPlugin.inc.php.

Referenced by getDescription(), and getManagementVerbs().


The documentation for this class was generated from the following file: