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

Public Member Functions

 display (&$args, $request)
 
 executeCLI ($scriptName, &$args)
 
 getDescription ()
 
 getDisplayName ()
 
 getManagementVerbs ()
 
 getName ()
 
 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 ImportExportPlugin.inc.php.

Member Function Documentation

ImportExportPlugin::display ( $args,
  $request 
)

Display the import/export plugin UI.

Parameters
$argsarray The array of arguments the user supplied.
$requestRequest

Definition at line 86 of file ImportExportPlugin.inc.php.

ImportExportPlugin::executeCLI (   $scriptName,
$args 
)

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

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

Definition at line 96 of file ImportExportPlugin.inc.php.

References usage().

ImportExportPlugin::getDescription ( )

Get a description of the plugin.

Definition at line 46 of file ImportExportPlugin.inc.php.

ImportExportPlugin::getDisplayName ( )

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

Returns
String

Definition at line 37 of file ImportExportPlugin.inc.php.

Referenced by setBreadcrumbs().

ImportExportPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 111 of file ImportExportPlugin.inc.php.

Referenced by smartyPluginUrl().

ImportExportPlugin::getName ( )

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

Returns
String name of plugin

Definition at line 28 of file ImportExportPlugin.inc.php.

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

ImportExportPlugin::manage (   $verb,
  $args,
  $message,
  $messageParams = null,
  $request = null 
)

Perform management functions

Definition at line 123 of file ImportExportPlugin.inc.php.

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

ImportExportPlugin::setBreadcrumbs (   $crumbs = array(),
  $isSubclass = false 
)
ImportExportPlugin::smartyPluginUrl (   $params,
$smarty 
)

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

Definition at line 135 of file ImportExportPlugin.inc.php.

References getManagementVerbs(), and getName().

ImportExportPlugin::usage (   $scriptName)

Display the command-line usage information

Definition at line 104 of file ImportExportPlugin.inc.php.

Referenced by executeCLI().


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