Open Journal Systems  3.3.0
SwordImportExportPlugin Class Reference
Inheritance diagram for SwordImportExportPlugin:
ImportExportPlugin Plugin

Public Member Functions

 __construct ($parentPlugin)
 
 display ($args, $request)
 
 executeCLI ($scriptName, &$args)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 getPluginPath ()
 
 getSwordPlugin ()
 
 register ($category, $path, $mainContextId=null)
 
 usage ($scriptName)
 
- Public Member Functions inherited from ImportExportPlugin
 displayXMLValidationErrors ($errors, $xml)
 
 getActions ($request, $actionArgs)
 
 getExportFileName ($basePath, $objectsFileNamePart, $context, $extension='.xml')
 
 getExportPath ()
 
 getPluginSettingsPrefix ()
 
 isAllowedMethod ($url)
 
 isRelativePath ($url)
 
 pluginUrl ($params, $smarty)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getCanDisable ()
 
 getCanEnable ()
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDirName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
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)
 

Protected Attributes

 $_parentPlugin = null
 

Additional Inherited Members

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

Detailed Description

Sword deposit plugin.

Definition at line 16 of file SwordImportExportPlugin.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SwordImportExportPlugin::__construct (   $parentPlugin)

Constructor

Parameters
$parentPluginSwordPlugin

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

Member Function Documentation

◆ display()

SwordImportExportPlugin::display (   $args,
  $request 
)

◆ executeCLI()

SwordImportExportPlugin::executeCLI (   $scriptName,
$args 
)

Reimplemented from ImportExportPlugin.

Definition at line 271 of file SwordImportExportPlugin.inc.php.

◆ getDescription()

SwordImportExportPlugin::getDescription ( )

Get the display description.

Returns
string

Reimplemented from Plugin.

Definition at line 78 of file SwordImportExportPlugin.inc.php.

◆ getDisplayName()

SwordImportExportPlugin::getDisplayName ( )

Get the display name.

Returns
string

Reimplemented from Plugin.

Definition at line 70 of file SwordImportExportPlugin.inc.php.

◆ getName()

SwordImportExportPlugin::getName ( )

Get the name of this plugin. The name must be unique within its category.

Returns
String name of plugin

Reimplemented from Plugin.

Definition at line 55 of file SwordImportExportPlugin.inc.php.

Referenced by display().

◆ getPluginPath()

SwordImportExportPlugin::getPluginPath ( )

Get the path this plugin's files are located in.

Returns
String pathname

Reimplemented from Plugin.

Definition at line 62 of file SwordImportExportPlugin.inc.php.

◆ getSwordPlugin()

SwordImportExportPlugin::getSwordPlugin ( )

Get reference to the sword plugin

Returns
SwordPlugin

Definition at line 46 of file SwordImportExportPlugin.inc.php.

References $_parentPlugin.

Referenced by display().

◆ register()

SwordImportExportPlugin::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 Plugin.

Definition at line 36 of file SwordImportExportPlugin.inc.php.

References Plugin\addLocaleData().

◆ usage()

SwordImportExportPlugin::usage (   $scriptName)

Reimplemented from ImportExportPlugin.

Definition at line 278 of file SwordImportExportPlugin.inc.php.

Field Documentation

◆ $_parentPlugin

SwordPlugin SwordImportExportPlugin::$_parentPlugin = null
protected

Parent plugin

Definition at line 21 of file SwordImportExportPlugin.inc.php.

Referenced by getSwordPlugin().


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