PHP Class SubmissionNativeXmlFilter, pkp-lib

Inheritance: extends NativeExportFilter

Show file Open project: pkp/pkp-lib Class Usage Examples

Public Properties

Property	Type	Description
$_includeSubmissionsNode

Public Methods

Method	Description
__construct ( $filterGroup )	Constructor
_getControlledVocabulariesMappings ( ) : array	Get controlled vocabularies parent node name to DAO, get function and item node name mapping.
addAuthors ( $doc, $submissionNode, $submission )	Add the author metadata for a submission to its DOM element.
addControlledVocabulary ( $doc, $submissionNode, $controlledVocabulariesNodeName, $controlledVocabularyNodeName, $controlledVocabulary )	Add submission controlled vocabulary to its DOM element.
addFiles ( $doc, $submissionNode, $submission )	Add the submission files to its DOM element.
addIdentifiers ( $doc, $submissionNode, $submission )	Create and add identifier nodes to a submission node.
addMetadata ( $doc, $submissionNode, $submission )	Add the submission metadata for a submission to its DOM element.
addPubIdentifier ( $doc, $submissionNode, $submission, $pubIdPlugin ) : DOMElement \| null	Add a single pub ID element for a given plugin to the document.
addRepresentations ( $doc, $submissionNode, $submission )	Add the representations of a submission to its DOM element.
createSubmissionNode ( $doc, $submission ) : DOMElement	Create and return a submission node.
getClassName ( )
getIncludeSubmissionsNode ( ) : boolean	Returnes whether to always include the node, even if there may only be one submission.
getRepresentationExportFilterGroupName ( ) : string	Get the representation export filter group name
process ( &$submissions ) : DOMDocument
setIncludeSubmissionsNode ( boolean $includeSubmissionsNode )	Sets a flag to always include the node, even if there may only be one submission.

Method Details

__construct() public method

Constructor

public __construct ( $filterGroup )
$filterGroup		FilterGroup

_getControlledVocabulariesMappings() public method

Get controlled vocabularies parent node name to DAO, get function and item node name mapping.

public _getControlledVocabulariesMappings ( ) : array
return	array

addAuthors() public method

Add the author metadata for a submission to its DOM element.

public addAuthors ( $doc, $submissionNode, $submission )
$doc		DOMDocument
$submissionNode		DOMElement
$submission		Submission

addControlledVocabulary() public method

Add submission controlled vocabulary to its DOM element.

public addControlledVocabulary ( $doc, $submissionNode, $controlledVocabulariesNodeName, $controlledVocabularyNodeName, $controlledVocabulary )
$doc		DOMDocument
$submissionNode		DOMElement
$controlledVocabulariesNodeName		string Parent node name
$controlledVocabularyNodeName		string Item node name
$controlledVocabulary		array Associative array (locale => array of items)

addFiles() public method

Add the submission files to its DOM element.

public addFiles ( $doc, $submissionNode, $submission )
$doc		DOMDocument
$submissionNode		DOMElement
$submission		Submission

addIdentifiers() public method

Create and add identifier nodes to a submission node.

public addIdentifiers ( $doc, $submissionNode, $submission )
$doc		DOMDocument
$submissionNode		DOMElement
$submission		Submission

addMetadata() public method

Add the submission metadata for a submission to its DOM element.

public addMetadata ( $doc, $submissionNode, $submission )
$doc		DOMDocument
$submissionNode		DOMElement
$submission		Submission

addPubIdentifier() public method

Add a single pub ID element for a given plugin to the document.

public addPubIdentifier ( $doc, $submissionNode, $submission, $pubIdPlugin ) : DOMElement \| null
$doc		DOMDocument
$submissionNode		DOMElement
$submission		Submission
$pubIdPlugin		PubIdPlugin
return	DOMElement \| null

addRepresentations() public method

Add the representations of a submission to its DOM element.

public addRepresentations ( $doc, $submissionNode, $submission )
$doc		DOMDocument
$submissionNode		DOMElement
$submission		Submission

createSubmissionNode() public method

Create and return a submission node.

public createSubmissionNode ( $doc, $submission ) : DOMElement
$doc		DOMDocument
$submission		Submission
return	DOMElement

getClassName() public method

public getClassName ( )

getIncludeSubmissionsNode() public method

Returnes whether to always include the node, even if there may only be one submission.

public getIncludeSubmissionsNode ( ) : boolean
return	boolean	$includeSubmissionsNode

getRepresentationExportFilterGroupName() public method

Get the representation export filter group name

public getRepresentationExportFilterGroupName ( ) : string
return	string

process() public method

setIncludeSubmissionsNode() public method

Sets a flag to always include the node, even if there may only be one submission.

public setIncludeSubmissionsNode ( boolean $includeSubmissionsNode )
$includeSubmissionsNode	boolean

Property Details

$_includeSubmissionsNode public property

public $_includeSubmissionsNode

public process ( &$submissions ) : DOMDocument
$submissions		array Array of submissions
return	DOMDocument