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

Public Member Functions

 display ($args, $request)
 
 executeCLI ($scriptName, &$args)
 
 exportIssues ($issueIds, $context, $user, $opts=array())
 
 exportSubmissions ($submissionIds, $context, $user, $opts=array())
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 getPluginSettingsPrefix ()
 
 importSubmissions ($importXml, $filter, $deployment)
 
 parseOpts (&$args, $optCodes)
 
 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

Native XML import/export plugin.

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

Member Function Documentation

◆ display()

◆ executeCLI()

NativeImportExportPlugin::executeCLI (   $scriptName,
$args 
)

◆ exportIssues()

NativeImportExportPlugin::exportIssues (   $issueIds,
  $context,
  $user,
  $opts = array() 
)

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 273 of file NativeImportExportPlugin.inc.php.

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

Referenced by display(), and executeCLI().

◆ exportSubmissions()

NativeImportExportPlugin::exportSubmissions (   $submissionIds,
  $context,
  $user,
  $opts = array() 
)

Get the XML for a set of submissions.

Parameters
$submissionIdsarray Array of submission IDs
$contextContext
$userUser|null
$optsarray
Returns
string XML contents representing the supplied submission IDs.

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

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

Referenced by display(), and executeCLI().

◆ getDescription()

NativeImportExportPlugin::getDescription ( )

Get the display description.

Returns
string

Reimplemented from Plugin.

Definition at line 51 of file NativeImportExportPlugin.inc.php.

◆ getDisplayName()

NativeImportExportPlugin::getDisplayName ( )

Get the display name.

Returns
string

Reimplemented from Plugin.

Definition at line 43 of file NativeImportExportPlugin.inc.php.

◆ getName()

NativeImportExportPlugin::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 35 of file NativeImportExportPlugin.inc.php.

Referenced by display(), and usage().

◆ getPluginSettingsPrefix()

NativeImportExportPlugin::getPluginSettingsPrefix ( )

Get the plugin ID used as plugin settings prefix.

Returns
string

Reimplemented from ImportExportPlugin.

Definition at line 58 of file NativeImportExportPlugin.inc.php.

◆ importSubmissions()

NativeImportExportPlugin::importSubmissions (   $importXml,
  $filter,
  $deployment 
)

Get the XML for a set of submissions wrapped in a(n) issue(s).

Parameters
$importXmlstring XML contents to import
$filterstring Filter to be used
$deploymentPKPImportExportDeployment
Returns
array Set of imported submissions

Definition at line 305 of file NativeImportExportPlugin.inc.php.

References DAORegistry\getDAO().

Referenced by display(), and executeCLI().

◆ parseOpts()

NativeImportExportPlugin::parseOpts ( $args,
  $optCodes 
)

Pull out getopt style long options. WARNING: This method is checked for by name in DepositPackage in the PLN plugin to determine if options are supported!

Parameters
&$argsarray #param $optCodes array

Definition at line 478 of file NativeImportExportPlugin.inc.php.

Referenced by executeCLI().

◆ register()

NativeImportExportPlugin::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 23 of file NativeImportExportPlugin.inc.php.

References Plugin\addLocaleData().

◆ usage()

NativeImportExportPlugin::usage (   $scriptName)

Reimplemented from ImportExportPlugin.

Definition at line 317 of file NativeImportExportPlugin.inc.php.

References getName().

Referenced by executeCLI().


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