Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
DuraCloudImportExportPlugin Class Reference
Inheritance diagram for DuraCloudImportExportPlugin:
ImportExportPlugin Plugin PKPPlugin

Public Member Functions

 executeCLI ($scriptName, &$args)
 
 exportIssue (&$journal, &$issue)
 
 exportIssues (&$journal, &$issues)
 
 forgetDuraCloudConfiguration ()
 
 getDuraCloudConnection ()
 
 getDuraCloudSpace ()
 
 getDuraCloudUrl ()
 
 getDuraCloudUsername ()
 
 getImportableIssues ()
 
 getName ()
 
getNativeImportExportPlugin ()
 
 importIssue (&$user, &$journal, $contentId)
 
 importIssues (&$user, &$journal, $contentIds)
 
 isDuraCloudConfigured ()
 
 register ($category, $path)
 
 setDuraCloudSpace ($space)
 
 storeDuraCloudConfiguration ($url, $username, $password)
 
 usage ($scriptName)
 
- Public Member Functions inherited from ImportExportPlugin
 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

DuraCloud import/export plugin.

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

Member Function Documentation

DuraCloudImportExportPlugin::executeCLI (   $scriptName,
$args 
)

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

Parameters
$argsParameters to the plugin

Definition at line 270 of file DuraCloudImportExportPlugin.inc.php.

References exportIssues(), DAORegistry\getDAO(), getDuraCloudConnection(), importIssues(), AppLocale\requireComponents(), setDuraCloudSpace(), storeDuraCloudConfiguration(), and usage().

DuraCloudImportExportPlugin::exportIssue ( $journal,
$issue 
)

Store an issue in DuraCloud.

Parameters
$journalJournal
$issueIssue
Returns
string location iff success; false otherwise

Definition at line 158 of file DuraCloudImportExportPlugin.inc.php.

References getDuraCloudConnection(), getDuraCloudSpace(), getName(), and getNativeImportExportPlugin().

Referenced by exportIssues().

DuraCloudImportExportPlugin::exportIssues ( $journal,
$issues 
)

Store several issues in DuraCloud.

Parameters
$journalJournal
$issueIssue
Returns
array of results for each issue (see exportIssue)

Definition at line 185 of file DuraCloudImportExportPlugin.inc.php.

References exportIssue().

Referenced by executeCLI().

DuraCloudImportExportPlugin::forgetDuraCloudConfiguration ( )

Forget the stored DuraCloud configuration.

Definition at line 388 of file DuraCloudImportExportPlugin.inc.php.

References storeDuraCloudConfiguration().

DuraCloudImportExportPlugin::getDuraCloudConnection ( )

Get a DuraCloudConnection object corresponding to the current configuration.

Returns
DuraCloudConnection

Definition at line 397 of file DuraCloudImportExportPlugin.inc.php.

References SessionManager\getManager().

Referenced by executeCLI(), exportIssue(), getImportableIssues(), importIssue(), and importIssues().

DuraCloudImportExportPlugin::getDuraCloudSpace ( )

Get the currently configured DuraCloud username.

Returns
string

Definition at line 431 of file DuraCloudImportExportPlugin.inc.php.

References SessionManager\getManager().

Referenced by exportIssue(), getImportableIssues(), importIssue(), and importIssues().

DuraCloudImportExportPlugin::getDuraCloudUrl ( )

Get the currently configured DuraCloud URL.

Returns
string

Definition at line 411 of file DuraCloudImportExportPlugin.inc.php.

References SessionManager\getManager().

DuraCloudImportExportPlugin::getDuraCloudUsername ( )

Get the currently configured DuraCloud username.

Returns
string

Definition at line 421 of file DuraCloudImportExportPlugin.inc.php.

References SessionManager\getManager().

DuraCloudImportExportPlugin::getImportableIssues ( )

Get a list of importable issues from the DuraSpace instance.

Returns
array(contentId => issueIdentification)

Definition at line 451 of file DuraCloudImportExportPlugin.inc.php.

References getDuraCloudConnection(), getDuraCloudSpace(), and getName().

DuraCloudImportExportPlugin::getName ( )

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

Returns
String name of plugin

Definition at line 36 of file DuraCloudImportExportPlugin.inc.php.

Referenced by exportIssue(), getImportableIssues(), and usage().

& DuraCloudImportExportPlugin::getNativeImportExportPlugin ( )

Get the native import/export plugin.

Definition at line 146 of file DuraCloudImportExportPlugin.inc.php.

References PluginRegistry\getPlugin().

Referenced by exportIssue(), importIssue(), and importIssues().

DuraCloudImportExportPlugin::importIssue ( $user,
$journal,
  $contentId 
)

Import an issue from DuraCloud.

Parameters
$userUser
$journalJournal
$contentIdstring
Returns
Issue iff success; false otherwise

Definition at line 200 of file DuraCloudImportExportPlugin.inc.php.

References getDuraCloudConnection(), getDuraCloudSpace(), and getNativeImportExportPlugin().

DuraCloudImportExportPlugin::importIssues ( $user,
$journal,
  $contentIds 
)

Import issues from DuraCloud.

Parameters
$userUser
$journalJournal
$contentIdstring
Returns
array with result for each contentId (see importIssue)

Definition at line 231 of file DuraCloudImportExportPlugin.inc.php.

References getDuraCloudConnection(), getDuraCloudSpace(), and getNativeImportExportPlugin().

Referenced by executeCLI().

DuraCloudImportExportPlugin::isDuraCloudConfigured ( )

Check whether or not the DuraCloud connection is configured.

Returns
boolean

Definition at line 441 of file DuraCloudImportExportPlugin.inc.php.

References SessionManager\getManager().

DuraCloudImportExportPlugin::register (   $category,
  $path 
)

Called as a plugin is registered to the registry

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

Definition at line 25 of file DuraCloudImportExportPlugin.inc.php.

References PKPPlugin\addLocaleData().

DuraCloudImportExportPlugin::setDuraCloudSpace (   $space)

Store the DuraCloud space to be used for this session.

Parameters
$spacestring

Definition at line 379 of file DuraCloudImportExportPlugin.inc.php.

References SessionManager\getManager().

Referenced by executeCLI().

DuraCloudImportExportPlugin::storeDuraCloudConfiguration (   $url,
  $username,
  $password 
)

Store the DuraCloud configuration details for this session.

Parameters
$urlstring
$usernamestring
$passwordstring

Definition at line 367 of file DuraCloudImportExportPlugin.inc.php.

References SessionManager\getManager().

Referenced by executeCLI(), and forgetDuraCloudConfiguration().

DuraCloudImportExportPlugin::usage (   $scriptName)

Display the command-line usage information

Definition at line 354 of file DuraCloudImportExportPlugin.inc.php.

References getName().

Referenced by executeCLI().


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