Open Journal Systems
3.3.0
|
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) | |
Native XML import/export plugin.
Definition at line 18 of file NativeImportExportPlugin.inc.php.
NativeImportExportPlugin::display | ( | $args, | |
$request | |||
) |
Display the plugin.
$args | array |
$request | PKPRequest |
Reimplemented from ImportExportPlugin.
Definition at line 67 of file NativeImportExportPlugin.inc.php.
References Plugin\$request, exportIssues(), exportSubmissions(), DAORegistry\getDAO(), ImportExportPlugin\getExportFileName(), ImportExportPlugin\getExportPath(), PKPTemplateManager\getManager(), getName(), Plugin\getTemplateResource(), importSubmissions(), and AppLocale\requireComponents().
NativeImportExportPlugin::executeCLI | ( | $scriptName, | |
& | $args | ||
) |
Reimplemented from ImportExportPlugin.
Definition at line 327 of file NativeImportExportPlugin.inc.php.
References exportIssues(), exportSubmissions(), DAORegistry\getDAO(), importSubmissions(), ImportExportPlugin\isRelativePath(), parseOpts(), AppLocale\requireComponents(), and usage().
NativeImportExportPlugin::exportIssues | ( | $issueIds, | |
$context, | |||
$user, | |||
$opts = array() |
|||
) |
Get the XML for a set of issues.
Definition at line 273 of file NativeImportExportPlugin.inc.php.
References ImportExportPlugin\displayXMLValidationErrors(), and DAORegistry\getDAO().
Referenced by display(), and executeCLI().
NativeImportExportPlugin::exportSubmissions | ( | $submissionIds, | |
$context, | |||
$user, | |||
$opts = array() |
|||
) |
Get the XML for a set of submissions.
$submissionIds | array Array of submission IDs |
$context | Context |
$user | User|null |
$opts | array |
Definition at line 233 of file NativeImportExportPlugin.inc.php.
References ImportExportPlugin\displayXMLValidationErrors(), PKPServices\get(), and DAORegistry\getDAO().
Referenced by display(), and executeCLI().
NativeImportExportPlugin::getDescription | ( | ) |
Get the display description.
Reimplemented from Plugin.
Definition at line 51 of file NativeImportExportPlugin.inc.php.
NativeImportExportPlugin::getDisplayName | ( | ) |
Get the display name.
Reimplemented from Plugin.
Definition at line 43 of file NativeImportExportPlugin.inc.php.
NativeImportExportPlugin::getName | ( | ) |
Get the name of this plugin. The name must be unique within its category.
Reimplemented from Plugin.
Definition at line 35 of file NativeImportExportPlugin.inc.php.
NativeImportExportPlugin::getPluginSettingsPrefix | ( | ) |
Get the plugin ID used as plugin settings prefix.
Reimplemented from ImportExportPlugin.
Definition at line 58 of file NativeImportExportPlugin.inc.php.
NativeImportExportPlugin::importSubmissions | ( | $importXml, | |
$filter, | |||
$deployment | |||
) |
Get the XML for a set of submissions wrapped in a(n) issue(s).
$importXml | string XML contents to import |
$filter | string Filter to be used |
$deployment | PKPImportExportDeployment |
Definition at line 305 of file NativeImportExportPlugin.inc.php.
References DAORegistry\getDAO().
Referenced by display(), and executeCLI().
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!
&$args | array #param $optCodes array |
Definition at line 478 of file NativeImportExportPlugin.inc.php.
Referenced by executeCLI().
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.
$category | String Name of category plugin was registered to |
$path | String The path the plugin was found in |
$mainContextId | integer 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. |
Reimplemented from Plugin.
Definition at line 23 of file NativeImportExportPlugin.inc.php.
References Plugin\addLocaleData().
NativeImportExportPlugin::usage | ( | $scriptName | ) |
Reimplemented from ImportExportPlugin.
Definition at line 317 of file NativeImportExportPlugin.inc.php.
References getName().
Referenced by executeCLI().