PHP Класс SubmissionNativeXmlFilter, pkp-lib

Наследование: extends NativeExportFilter
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$_includeSubmissionsNode

Открытые методы

Метод Описание
__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.

Описание методов

__construct() публичный Метод

Constructor
public __construct ( $filterGroup )
$filterGroup FilterGroup

_getControlledVocabulariesMappings() публичный Метод

Get controlled vocabularies parent node name to DAO, get function and item node name mapping.
public _getControlledVocabulariesMappings ( ) : array
Результат array

addAuthors() публичный Метод

Add the author metadata for a submission to its DOM element.
public addAuthors ( $doc, $submissionNode, $submission )
$doc DOMDocument
$submissionNode DOMElement
$submission Submission

addControlledVocabulary() публичный Метод

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() публичный Метод

Add the submission files to its DOM element.
public addFiles ( $doc, $submissionNode, $submission )
$doc DOMDocument
$submissionNode DOMElement
$submission Submission

addIdentifiers() публичный Метод

Create and add identifier nodes to a submission node.
public addIdentifiers ( $doc, $submissionNode, $submission )
$doc DOMDocument
$submissionNode DOMElement
$submission Submission

addMetadata() публичный Метод

Add the submission metadata for a submission to its DOM element.
public addMetadata ( $doc, $submissionNode, $submission )
$doc DOMDocument
$submissionNode DOMElement
$submission Submission

addPubIdentifier() публичный Метод

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
Результат DOMElement | null

addRepresentations() публичный Метод

Add the representations of a submission to its DOM element.
public addRepresentations ( $doc, $submissionNode, $submission )
$doc DOMDocument
$submissionNode DOMElement
$submission Submission

createSubmissionNode() публичный Метод

Create and return a submission node.
public createSubmissionNode ( $doc, $submission ) : DOMElement
$doc DOMDocument
$submission Submission
Результат DOMElement

getClassName() публичный Метод

public getClassName ( )

getIncludeSubmissionsNode() публичный Метод

Returnes whether to always include the node, even if there may only be one submission.
public getIncludeSubmissionsNode ( ) : boolean
Результат boolean $includeSubmissionsNode

getRepresentationExportFilterGroupName() публичный Метод

Get the representation export filter group name
public getRepresentationExportFilterGroupName ( ) : string
Результат string

process() публичный Метод

См. также: Filter::process()
public process ( &$submissions ) : DOMDocument
$submissions array Array of submissions
Результат DOMDocument

setIncludeSubmissionsNode() публичный Метод

Sets a flag to always include the node, even if there may only be one submission.
public setIncludeSubmissionsNode ( boolean $includeSubmissionsNode )
$includeSubmissionsNode boolean

Описание свойств

$_includeSubmissionsNode публичное свойство

public $_includeSubmissionsNode