Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
NativeImportExportPlugin Class Reference
Inheritance diagram for NativeImportExportPlugin:
ImportExportPlugin Plugin

Public Member Functions

 display ($args, $request)
 
 exportSubmissions ($submissionIds, $context, $user)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 getTemplatePath ($inCore=false)
 
 importSubmissions ($importXml, $context, $user)
 
 NativeImportExportPlugin ()
 
 register ($category, $path)
 
- Public Member Functions inherited from ImportExportPlugin
 display ($args, $request)
 
 executeCLI ($scriptName, $args)
 
 getDescription ()
 
 getDisplayName ()
 
 getManagementVerbLinkAction ($request, $verb)
 
 getManagementVerbs ()
 
 getName ()
 
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
 
 smartyPluginUrl ($params, &$smarty)
 
 usage ($scriptName)
 
- Public Member Functions inherited from Plugin
 _getContextSpecificInstallationHook ()
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbLinkAction ($request, $verb)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getSettingMainContext ()
 
 getTemplatePath ($inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
 
 Plugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Public Attributes inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 

Detailed Description

Native XML import/export plugin.

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

Member Function Documentation

NativeImportExportPlugin::display (   $args,
  $request 
)

Display the plugin.

Parameters
$argsarray
$requestPKPRequest

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

References Plugin\$request, exportSubmissions(), DAORegistry\getDAO(), getName(), getTemplatePath(), and importSubmissions().

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

Get the XML for a set of submissions.

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

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

References DAORegistry\getDAO(), and Application\getSubmissionDAO().

Referenced by display().

NativeImportExportPlugin::getDescription ( )

Get the display description.

Returns
string

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

NativeImportExportPlugin::getDisplayName ( )

Get the display name.

Returns
string

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

NativeImportExportPlugin::getName ( )

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

Returns
String name of plugin

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

Referenced by display().

NativeImportExportPlugin::getTemplatePath (   $inCore = false)
See Also
Plugin::getTemplatePath($inCore)

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

Referenced by display().

NativeImportExportPlugin::importSubmissions (   $importXml,
  $context,
  $user 
)

Get the XML for a set of submissions.

Parameters
$importXmlstring XML contents to import
$contextContext
$userUser
Returns
array Set of imported submissions

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

References DAORegistry\getDAO().

Referenced by display().

NativeImportExportPlugin::NativeImportExportPlugin ( )

Constructor

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

NativeImportExportPlugin::register (   $category,
  $path 
)

Called as a plugin is registered to the registry

Parameters
$categoryString Name of category plugin was registered to
$pathstring
Returns
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

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

References Plugin\addLocaleData().


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