Open Journal Systems
3.3.0
|
Data Fields | |
$_request | |
Data Fields inherited from Plugin | |
$pluginCategory | |
$pluginPath | |
$request | |
Additional Inherited Members | |
Protected Member Functions inherited from Plugin | |
_registerTemplateResource ($inCore=false) | |
Abstract class for import/export plugins.
Definition at line 18 of file ImportExportPlugin.inc.php.
ImportExportPlugin::display | ( | $args, | |
$request | |||
) |
Display the import/export plugin.
$args | array |
$request | PKPRequest |
Reimplemented in PubObjectsExportPlugin, SwordImportExportPlugin, PKPUserImportExportPlugin, NativeImportExportPlugin, QuickSubmitPlugin, PubMedExportPlugin, DOAJExportPlugin, and DOIPubIdExportPlugin.
Definition at line 66 of file ImportExportPlugin.inc.php.
References Plugin\$request, and PKPTemplateManager\getManager().
ImportExportPlugin::displayXMLValidationErrors | ( | $errors, | |
$xml | |||
) |
Display XML validation errors.
$errors | array |
$xml | string |
Definition at line 161 of file ImportExportPlugin.inc.php.
References fatalError(), Config\getVar(), and AppLocale\requireComponents().
Referenced by PubMedExportPlugin\exportIssues(), NativeImportExportPlugin\exportIssues(), PubMedExportPlugin\exportSubmissions(), NativeImportExportPlugin\exportSubmissions(), and PubObjectsExportPlugin\exportXML().
|
abstract |
Execute import/export tasks using the command-line interface.
$scriptName | The name of the command-line script (displayed as usage info) |
$args | Parameters to the plugin |
Reimplemented in PubObjectsExportPlugin, NativeImportExportPlugin, SwordImportExportPlugin, QuickSubmitPlugin, PubMedExportPlugin, and UserImportExportPlugin.
ImportExportPlugin::getActions | ( | $request, | |
$actionArgs | |||
) |
Get a list of link actions for plugin management.
request | PKPRequest |
$actionArgs | array The list of action args to be included in request URLs. |
Reimplemented from Plugin.
Definition at line 42 of file ImportExportPlugin.inc.php.
References Plugin\$request, and Plugin\getName().
ImportExportPlugin::getExportFileName | ( | $basePath, | |
$objectsFileNamePart, | |||
$context, | |||
$extension = '.xml' |
|||
) |
Return the whole export file name.
$basePath | string Base path for temporary file storage |
$objectsFileNamePart | string Part different for each object type. |
$context | Context |
$extension | string |
Definition at line 152 of file ImportExportPlugin.inc.php.
References getPluginSettingsPrefix().
Referenced by PubMedExportPlugin\display(), NativeImportExportPlugin\display(), PKPUserImportExportPlugin\display(), DataciteExportPlugin\executeCLICommand(), CrossRefExportPlugin\executeCLICommand(), DataciteExportPlugin\executeExportAction(), PubObjectsExportPlugin\executeExportAction(), and CrossRefExportPlugin\executeExportAction().
ImportExportPlugin::getExportPath | ( | ) |
Return the plugin export directory.
Definition at line 140 of file ImportExportPlugin.inc.php.
References Config\getVar().
Referenced by PubMedExportPlugin\display(), NativeImportExportPlugin\display(), PKPUserImportExportPlugin\display(), DataciteExportPlugin\executeCLICommand(), CrossRefExportPlugin\executeCLICommand(), DataciteExportPlugin\executeExportAction(), PubObjectsExportPlugin\executeExportAction(), and CrossRefExportPlugin\executeExportAction().
ImportExportPlugin::getPluginSettingsPrefix | ( | ) |
Get the plugin ID used as plugin settings prefix.
Reimplemented in CrossRefExportPlugin, PubMedExportPlugin, DataciteExportPlugin, MedraExportPlugin, DOAJExportPlugin, PKPUserImportExportPlugin, and NativeImportExportPlugin.
Definition at line 132 of file ImportExportPlugin.inc.php.
Referenced by DOIPubIdExportPlugin\_getObjectAdditionalSettings(), getExportFileName(), and DOIPubIdExportPlugin\saveRegisteredDoi().
ImportExportPlugin::isAllowedMethod | ( | $url | ) |
Determine whether the specified URL describes an allowed protocol.
$url | string |
Definition at line 115 of file ImportExportPlugin.inc.php.
Referenced by isRelativePath().
ImportExportPlugin::isRelativePath | ( | $url | ) |
Check if this is a relative path to the xml document that describes public identifiers to be imported.
$url | string path to the xml file |
Definition at line 103 of file ImportExportPlugin.inc.php.
References isAllowedMethod().
Referenced by UserImportExportPlugin\executeCLI(), and NativeImportExportPlugin\executeCLI().
ImportExportPlugin::pluginUrl | ( | $params, | |
$smarty | |||
) |
Generate a URL into the plugin.
$params | array |
$smarty | Smarty |
Definition at line 93 of file ImportExportPlugin.inc.php.
References Plugin\getName().
|
abstract |
Display the command-line usage information
$scriptName | string |
Reimplemented in PubObjectsExportPlugin, NativeImportExportPlugin, SwordImportExportPlugin, QuickSubmitPlugin, PubMedExportPlugin, and UserImportExportPlugin.
Request ImportExportPlugin::$_request |
Request made available for plugin URL generation
Definition at line 23 of file ImportExportPlugin.inc.php.