Open Journal Systems  2.4.8
 All Classes Namespaces Functions Variables Groups Pages
ImportExportPlugin Class Reference
Inheritance diagram for ImportExportPlugin:
Plugin PKPPlugin DOAJPlugin DOIExportPlugin DuraCloudImportExportPlugin EruditExportPlugin NativeImportExportPlugin PubIdImportExportPlugin PubMedExportPlugin QuickSubmitPlugin SampleImportExportPlugin UserImportExportPlugin

Public Member Functions

 display (&$args, $request)
 executeCLI ($scriptName, &$args)
 getDescription ()
 getDisplayName ()
 getManagementVerbs ()
 getName ()
 ImportExportPlugin ()
 manage ($verb, $args, $message, $messageParams=null, $request=null)
 setBreadcrumbs ($crumbs=array(), $isSubclass=false)
 smartyPluginUrl ($params, &$smarty)
 usage ($scriptName)
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 getNewJournalPluginSettingsFile ()
 getSetting ($journalId, $name)
 Plugin ()
 updateSetting ($journalId, $name, $value, $type=null)
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 addHelpData ($locale=null)
 addLocaleData ($locale=null)
 getCategory ()
 getContextSpecificPluginSettingsFile ()
 getContextSpecificSetting ($context, $name)
 getCurrentVersion ()
 getDescription ()
 getDisplayName ()
 getHelpMappingFilename ()
 getHideManagement ()
 getInstallDataFile ()
 getInstallEmailTemplateDataFile ()
 getInstallEmailTemplatesFile ()
 getInstallFilterConfigFiles ()
 getInstallSchemaFile ()
 getInstallSitePluginSettingsFile ()
 getLocaleFilename ($locale)
 getManagementVerbs ()
 getName ()
 getPluginPath ()
 getSeq ()
 getSettingMainContext ()
 getTemplatePath ()
 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, $request=null)
 PKPPlugin ()
 register ($category, $path)
 smartyPluginUrl ($params, &$smarty)
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 updateSchema ($hookName, $args)

Detailed Description

Abstract class for import/export plugins.

Definition at line 18 of file

Member Function Documentation

ImportExportPlugin::display ( $args,

Display the import/export plugin UI.

$argsarray The array of arguments the user supplied.

Definition at line 89 of file

ImportExportPlugin::executeCLI (   $scriptName,

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

$scriptNameThe name of the command-line script (displayed as usage info)
$argsParameters to the plugin

Definition at line 99 of file

References usage().

ImportExportPlugin::getDescription ( )

Get a description of the plugin.

Definition at line 49 of file

ImportExportPlugin::getDisplayName ( )

Get the display name of this plugin. This name is displayed on the Journal Manager's import/export page, for example.


Definition at line 40 of file

Referenced by setBreadcrumbs().

ImportExportPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 114 of file

Referenced by smartyPluginUrl().

ImportExportPlugin::getName ( )

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

String name of plugin

Definition at line 31 of file

Referenced by DOIExportPlugin\_process(), DOIExportPlugin\_usage(), manage(), DOIExportPlugin\manage(), setBreadcrumbs(), and smartyPluginUrl().

ImportExportPlugin::ImportExportPlugin ( )


Definition at line 22 of file

ImportExportPlugin::manage (   $verb,
  $messageParams = null,
  $request = null 

Perform management functions

Definition at line 126 of file

References getName(), and PKPRequest\redirect().

ImportExportPlugin::smartyPluginUrl (   $params,

Extend the {url ...} smarty to support import/export plugins.

Definition at line 138 of file

References getManagementVerbs(), and getName().

ImportExportPlugin::usage (   $scriptName)

Display the command-line usage information

Definition at line 107 of file

Referenced by executeCLI().

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