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

Public Member Functions

 display (&$args, $request)
 
 executeCLI ($scriptName, &$args)
 
 exportPubIdsForIssues (&$journal, &$issues, $outputFile=null)
 
 generatePubId (&$doc, &$node, &$pubObject, $journalId)
 
 getDescription ()
 
 getDisplayName ()
 
getDocument ($fileName)
 
 getName ()
 
 getRootNodeName (&$doc)
 
 getTemplatePath ()
 
 handleImport (&$context, &$doc, &$errors, &$pubIds, $isCommandLine)
 
 importPubId (&$journal, &$pubIdNode, &$pubId, &$errors, $isCommandLine)
 
 importPubIds (&$journal, &$pubIdNodes, &$pubIds, &$errors, $isCommandLine)
 
 isRelativePath ($url)
 
 register ($category, $path)
 
 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

Public identifier import/export plugin.

Definition at line 24 of file PubIdImportExportPlugin.inc.php.

Member Function Documentation

PubIdImportExportPlugin::executeCLI (   $scriptName,
$args 
)
PubIdImportExportPlugin::exportPubIdsForIssues ( $journal,
$issues,
  $outputFile = null 
)

Export public identifiers of one or more issues.

Parameters
$journalobject
$issuesarray
$outputFilexml file containing the exported public identifiers

Definition at line 142 of file PubIdImportExportPlugin.inc.php.

References XMLCustomWriter\createDocument(), generatePubId(), and DAORegistry\getDAO().

Referenced by display(), and executeCLI().

PubIdImportExportPlugin::generatePubId ( $doc,
$node,
$pubObject,
  $journalId 
)

Add ID-nodes to the given node.

Parameters
$docDOMDocument
$nodeDOMNode
$pubObjectobject
$journalIdint

Definition at line 312 of file PubIdImportExportPlugin.inc.php.

References PluginRegistry\loadCategory().

Referenced by exportPubIdsForIssues().

PubIdImportExportPlugin::getDescription ( )
PubIdImportExportPlugin::getDisplayName ( )
& PubIdImportExportPlugin::getDocument (   $fileName)

Get the tree structure of the xml document.

Parameters
$fileNamestring full path to the XML file
Returns
object tree structure representing the document

Definition at line 265 of file PubIdImportExportPlugin.inc.php.

Referenced by display(), and executeCLI().

PubIdImportExportPlugin::getName ( )
See Also
ImportExportPlugin::getName()

Definition at line 41 of file PubIdImportExportPlugin.inc.php.

Referenced by usage().

PubIdImportExportPlugin::getRootNodeName ( $doc)

Get the name of the root node of the xml document.

Returns
string

Definition at line 275 of file PubIdImportExportPlugin.inc.php.

Referenced by handleImport().

PubIdImportExportPlugin::getTemplatePath ( )
See Also
PKPPlugin::getTemplatePath()

Definition at line 62 of file PubIdImportExportPlugin.inc.php.

Referenced by display().

PubIdImportExportPlugin::handleImport ( $context,
$doc,
$errors,
$pubIds,
  $isCommandLine 
)

Handle import of public identifiers described in the xml document.

Parameters
$contextarray
$docDOMDocument
$errorsarray
$pubIdsarray successfully imported pubIds
$isCommandLineboolean

Definition at line 287 of file PubIdImportExportPlugin.inc.php.

References getRootNodeName(), and importPubIds().

Referenced by display(), and executeCLI().

PubIdImportExportPlugin::importPubId ( $journal,
$pubIdNode,
$pubId,
$errors,
  $isCommandLine 
)

Import public identifier.

Parameters
$journalobject
$pubIdNodeXMLNode
$pubIdarray describing the successfully imported public identifier
$errorsarray
$isCommandLineboolean

Definition at line 187 of file PubIdImportExportPlugin.inc.php.

References PluginRegistry\loadCategory().

Referenced by importPubIds().

PubIdImportExportPlugin::importPubIds ( $journal,
$pubIdNodes,
$pubIds,
$errors,
  $isCommandLine 
)

Import public identifiers.

Parameters
$journalobject
$pubIdNodesarray all pubId nodes of the xml document
$errorsarray
$pubIdsarray successfully imported pubIds
$isCommandLineboolean

Definition at line 250 of file PubIdImportExportPlugin.inc.php.

References importPubId().

Referenced by handleImport().

PubIdImportExportPlugin::isRelativePath (   $url)

Check if this is a relative path to the xml docuemnt that describes public identifiers to be imported.

Parameters
$urlstring path to the xml file

Definition at line 335 of file PubIdImportExportPlugin.inc.php.

Referenced by executeCLI().

PubIdImportExportPlugin::register (   $category,
  $path 
)
See Also
PKPPlugin::register()

Definition at line 32 of file PubIdImportExportPlugin.inc.php.

References PKPPlugin\addLocaleData().

PubIdImportExportPlugin::usage (   $scriptName)
See Also
ImportExportPlugin::usage()

Definition at line 463 of file PubIdImportExportPlugin.inc.php.

References getName().

Referenced by executeCLI().


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