PHP Class PubIdImportExportPlugin, ojs

Inheritance: extends ImportExportPlugin

Public Methods

Method	Description
display ( &$args, $request )
executeCLI ( $scriptName, &$args )
exportPubIdsForIssues ( $journal, $issues, $outputFile = null )	Export public identifiers of one or more issues.
generatePubId ( &$doc, &$node, &$pubObject, $journalId )	Add ID-nodes to the given node.
getDescription ( )
getDisplayName ( )
getDocument ( $fileName ) : object	Get the tree structure of the xml document.
getName ( )
getRootNodeName ( &$doc ) : string	Get the name of the root node of the xml document.
getTemplatePath ( $inCore = false )
handleImport ( &$context, &$doc, &$errors, &$pubIds, $isCommandLine )	Handle import of public identifiers described in the xml document.
importPubId ( &$journal, &$pubIdNode, &$pubId, &$errors, $isCommandLine )	Import public identifier.
importPubIds ( &$journal, &$pubIdNodes, &$pubIds, &$errors, $isCommandLine )	Import public identifiers.
register ( $category, $path )
usage ( $scriptName )

Method Details

display() public method

executeCLI() public method

See also: ImportExportPlugin::executeCLI()

public executeCLI ( $scriptName, &$args )

exportPubIdsForIssues() public method

Export public identifiers of one or more issues.

public exportPubIdsForIssues ( $journal, $issues, $outputFile = null )
$journal		object
$issues		array
$outputFile		xml file containing the exported public identifiers

generatePubId() public method

Add ID-nodes to the given node.

public generatePubId ( &$doc, &$node, &$pubObject, $journalId )
$doc		DOMDocument
$node		DOMNode
$pubObject		object
$journalId		int

getDescription() public method

See also: ImportExportPlugin::getDescription()

public getDescription ( )

getDisplayName() public method

See also: ImportExportPlugin::getDisplayName()

public getDisplayName ( )

getDocument() public method

Get the tree structure of the xml document.

public getDocument ( $fileName ) : object
$fileName		string full path to the XML file
return	object	tree structure representing the document

getName() public method

getRootNodeName() public method

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

public getRootNodeName ( &$doc ) : string
return	string

getTemplatePath() public method

public getTemplatePath ( $inCore = false )

handleImport() public method

Handle import of public identifiers described in the xml document.

public handleImport ( &$context, &$doc, &$errors, &$pubIds, $isCommandLine )
$context		array
$doc		DOMDocument
$errors		array
$pubIds		array successfully imported pubIds
$isCommandLine		boolean

importPubId() public method

Import public identifier.

public importPubId ( &$journal, &$pubIdNode, &$pubId, &$errors, $isCommandLine )
$journal		object
$pubIdNode		XMLNode
$pubId		array describing the successfully imported public identifier
$errors		array
$isCommandLine		boolean

importPubIds() public method

Import public identifiers.

public importPubIds ( &$journal, &$pubIdNodes, &$pubIds, &$errors, $isCommandLine )
$journal		object
$pubIdNodes		array all pubId nodes of the xml document
$pubIds		array successfully imported pubIds
$errors		array
$isCommandLine		boolean