Open Journal Systems  3.3.0
SwordPlugin Class Reference
Inheritance diagram for SwordPlugin:
GenericPlugin LazyLoadPlugin Plugin

Public Member Functions

 callbackAuthorDeposits ($hookName, $args)
 
 callbackLoadCategory ($hookName, $args)
 
 callbackPublish ($hookName, $args)
 
 callbackSettingsTab ($hookName, $args)
 
 callbackSwordLoadHandler ($hookName, $args)
 
 getActions ($request, $verb)
 
 getDescription ()
 
 getDisplayName ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallSchemaFile ()
 
 getJsUrl ($request)
 
 getTypeMap ()
 
 performAutomaticDeposits (Submission $submission)
 
 register ($category, $path, $mainContextId=null)
 
 setupGridHandler ($hookName, $params)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getEnabled ($contextId=null)
 
 getName ()
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDirName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getTemplatePath ($inCore=false)
 
 getTemplateResource ($template=null, $inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installControlledVocabs ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($args, $request)
 
 smartyPluginUrl ($params, $smarty)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

SWORD deposit plugin class.

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

Member Function Documentation

◆ callbackAuthorDeposits()

SwordPlugin::callbackAuthorDeposits (   $hookName,
  $args 
)

Performs automatic deposit on accept decision

Parameters
$hookNamestring
$argsarray

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

References performAutomaticDeposits().

◆ callbackLoadCategory()

SwordPlugin::callbackLoadCategory (   $hookName,
  $args 
)

Load all plugins for a given category.

Parameters
$categorystring The name of the category to load
$enabledOnlyboolean if true load only enabled plug-ins (db-installation required), otherwise look on disk and load all available plug-ins (no db required).
$mainContextIdinteger 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.
Returns
array Set of plugins, sorted in sequence.

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

◆ callbackPublish()

SwordPlugin::callbackPublish (   $hookName,
  $args 
)

Performs automatic deposit on publication

Parameters
$hookNamestring
$argsarray

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

References PKPServices\get(), and performAutomaticDeposits().

◆ callbackSettingsTab()

SwordPlugin::callbackSettingsTab (   $hookName,
  $args 
)

Extend the website settings tabs to include sword settings

Parameters
$hookNamestring The name of the invoked hook
$argsarray Hook parameters
Returns
boolean Hook handling status

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

References Plugin\$request, Registry\get(), PKPTemplateManager\getManager(), and Plugin\getTemplateResource().

◆ callbackSwordLoadHandler()

SwordPlugin::callbackSwordLoadHandler (   $hookName,
  $args 
)
See also
PKPPageRouter::route()

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

References $op, and Plugin\getPluginPath().

◆ getActions()

SwordPlugin::getActions (   $request,
  $verb 
)
See also
Plugin::getActions()

Reimplemented from Plugin.

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

References Plugin\$request, and Plugin\getEnabled().

◆ getDescription()

SwordPlugin::getDescription ( )

Get the description of this plugin

Returns
string

Reimplemented from Plugin.

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

◆ getDisplayName()

SwordPlugin::getDisplayName ( )

Get the display name of this plugin

Returns
string

Reimplemented from Plugin.

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

◆ getInstallEmailTemplatesFile()

SwordPlugin::getInstallEmailTemplatesFile ( )

Reimplemented from Plugin.

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

References Plugin\getPluginPath().

◆ getInstallSchemaFile()

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().

◆ getJsUrl()

SwordPlugin::getJsUrl (   $request)

Get plugin JS URL

Returns
string Public plugin JS URL

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

References Plugin\$request, and Plugin\getPluginPath().

◆ getTypeMap()

SwordPlugin::getTypeMap ( )

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

◆ performAutomaticDeposits()

SwordPlugin::performAutomaticDeposits ( Submission  $submission)

Performs automatic deposits and mails authors

Parameters
$submissionSubmission

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().

◆ register()

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.

Parameters
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
$mainContextIdinteger 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.
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from LazyLoadPlugin.

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

References Plugin\getEnabled(), HookRegistry\register(), and DAORegistry\registerDAO().

◆ setupGridHandler()

SwordPlugin::setupGridHandler (   $hookName,
  $params 
)

Permit requests to SWORD deposit points grid handler

Parameters
$hookNamestring The name of the hook being invoked
$argsarray The parameters to the invoked hook

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

References SwordDepositPointsGridHandler\setPlugin().


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