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

Public Member Functions

 display ($args, $request)
 
 executeCLI ($scriptName, &$args)
 
 exportIssues ($issueIds, $context, $user)
 
 exportSubmissions ($submissionIds, $context, $user)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 getPluginSettingsPrefix ()
 
 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 ()
 
 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)
 
 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 ImportExportPlugin
 $_request
 
- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

PubMed/MEDLINE XML metadata export plugin.

Definition at line 18 of file PubMedExportPlugin.inc.php.

Member Function Documentation

◆ display()

PubMedExportPlugin::display (   $args,
  $request 
)

◆ executeCLI()

PubMedExportPlugin::executeCLI (   $scriptName,
$args 
)

Execute import/export tasks using the command-line interface.

Parameters
$argsParameters to the plugin

Reimplemented from ImportExportPlugin.

Definition at line 183 of file PubMedExportPlugin.inc.php.

References exportIssues(), DAORegistry\getDAO(), and usage().

◆ exportIssues()

PubMedExportPlugin::exportIssues (   $issueIds,
  $context,
  $user 
)

Get the XML for a set of issues.

Parameters
$issueIdsarray Array of issue IDs
$contextContext
$userUser
Returns
string XML contents representing the supplied issue IDs.

Definition at line 158 of file PubMedExportPlugin.inc.php.

References ImportExportPlugin\displayXMLValidationErrors(), PKPServices\get(), and DAORegistry\getDAO().

Referenced by display(), and executeCLI().

◆ exportSubmissions()

PubMedExportPlugin::exportSubmissions (   $submissionIds,
  $context,
  $user 
)

◆ getDescription()

PubMedExportPlugin::getDescription ( )

Get the display description.

Returns
string

Reimplemented from Plugin.

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

◆ getDisplayName()

PubMedExportPlugin::getDisplayName ( )

Get the display name.

Returns
string

Reimplemented from Plugin.

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

◆ getName()

PubMedExportPlugin::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 33 of file PubMedExportPlugin.inc.php.

Referenced by usage().

◆ getPluginSettingsPrefix()

PubMedExportPlugin::getPluginSettingsPrefix ( )

Get the plugin ID used as plugin settings prefix.

Returns
string

Reimplemented from ImportExportPlugin.

Definition at line 124 of file PubMedExportPlugin.inc.php.

◆ register()

PubMedExportPlugin::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 22 of file PubMedExportPlugin.inc.php.

References Plugin\addLocaleData().

◆ usage()

PubMedExportPlugin::usage (   $scriptName)

Display the command-line usage information

Reimplemented from ImportExportPlugin.

Definition at line 233 of file PubMedExportPlugin.inc.php.

References getName().

Referenced by executeCLI().


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