PHP Class DataciteXmlFilter, ojs

Inheritance: extends NativeExportFilter

Public Methods

Method	Description
__construct ( $filterGroup )	Constructor
createAlternateIdentifiersNode ( $doc, $issue, $article, $galley ) : DOMElement	Generate alternate identifiers node list.
createCreatorsNode ( $doc, $issue, $article, $galley, $galleyFile, $publisher, $objectLocalePrecedence ) : DOMElement	Create creators node.
createDatesNode ( $doc, $issue, $article, $galley, $galleyFile, $publicationDate ) : DOMElement	Create a date node list.
createDescriptionsNode ( $doc, $issue, $article, $galley, $galleyFile, $objectLocalePrecedence ) : DOMElement \| null	Create descriptions node list.
createRelatedIdentifiersNode ( $doc, $issue, $article, $galley ) : DOMElement \| null	Generate related identifiers node list.
createResourceTypeNode ( $doc, $issue, $article, $galley, $galleyFile ) : DOMElement \| null	Create a resource type node.
createRootNode ( $doc ) : DOMElement	Create and return the root node.
createSizesNode ( $doc, $issue, $article, $galley, $galleyFile ) : DOMElement \| null	Create a sizes node list.
createTitlesNode ( $doc, $issue, $article, $galley, $galleyFile, $objectLocalePrecedence ) : DOMElement	Create titles node.
getClassName ( )
getIssueInformation ( $issue, $objectLocalePrecedence = null ) : array \| string	Construct an issue title from the journal title and the issue identification.
getIssueToc ( $issue, $objectLocalePrecedence ) : string	Construct a table of content for an issue.
getObjectLocalePrecedence ( $context, $article, $galley ) : array	Identify the locale precedence for this export.
getPrimaryTranslation ( $localizedData, $localePrecedence ) : mixed \| null	Identify the primary translation from an array of localized data.
getTranslationsByPrecedence ( $localizedData, $localePrecedence ) : array	Re-order localized data by locale precedence.
process ( &$pubObject ) : DOMDocument
translateLanguageToLocale ( $language ) : string \| null	Try to translate an ISO language code to an OJS locale.

Method Details

__construct() public method

Constructor

public __construct ( $filterGroup )
$filterGroup		FilterGroup

createAlternateIdentifiersNode() public method

Generate alternate identifiers node list.

public createAlternateIdentifiersNode ( $doc, $issue, $article, $galley ) : DOMElement
$doc		DOMDocument
$issue		Issue
$article		PublishedArticle
$galley		ArticleGalley
return	DOMElement

createCreatorsNode() public method

Create creators node.

public createCreatorsNode ( $doc, $issue, $article, $galley, $galleyFile, $publisher, $objectLocalePrecedence ) : DOMElement
$doc		DOMDocument
$issue		Issue
$article		PublishedArticle
$galley		ArticleGalley
$galleyFile		SubmissionFile
$publisher		string
$objectLocalePrecedence		array
return	DOMElement

createDatesNode() public method

Create a date node list.

public createDatesNode ( $doc, $issue, $article, $galley, $galleyFile, $publicationDate ) : DOMElement
$doc		DOMDocument
$issue		Issue
$article		PublishedArticle
$galley		ArticleGalley
$galleyFile		SubmissionFile
$publicationDate		string
return	DOMElement

createDescriptionsNode() public method

Create descriptions node list.

public createDescriptionsNode ( $doc, $issue, $article, $galley, $galleyFile, $objectLocalePrecedence ) : DOMElement \| null
$doc		DOMDocument
$issue		Issue
$article		PublishedArticle
$galley		Alley
$galleyFile		SubmissionFile
$objectLocalePrecedence		array
return	DOMElement \| null	Can be null if a size cannot be identified for the given object.

createRelatedIdentifiersNode() public method

Generate related identifiers node list.

public createRelatedIdentifiersNode ( $doc, $issue, $article, $galley ) : DOMElement \| null
$doc		DOMDocument
$issue		Issue
$article		PublishedArticle
$galley		ArticleGalley
return	DOMElement \| null

createResourceTypeNode() public method

Create a resource type node.

public createResourceTypeNode ( $doc, $issue, $article, $galley, $galleyFile ) : DOMElement \| null
$doc		DOMDocument
$issue		Issue
$article		PublishedArticle
$galley		ArticleGalley
$galleyFile		SubmissionFile
return	DOMElement \| null	Can be null if a size cannot be identified for the given object.

createRootNode() public method

Create and return the root node.

public createRootNode ( $doc ) : DOMElement
$doc		DOMDocument
return	DOMElement

createSizesNode() public method

Create a sizes node list.

public createSizesNode ( $doc, $issue, $article, $galley, $galleyFile ) : DOMElement \| null
$doc		DOMDocument
$issue		Issue
$article		PublishedArticle
$galley		ArticleGalley
$galleyFile		SubmissionFile
return	DOMElement \| null	Can be null if a size cannot be identified for the given object.

createTitlesNode() public method

Create titles node.

public createTitlesNode ( $doc, $issue, $article, $galley, $galleyFile, $objectLocalePrecedence ) : DOMElement
$doc		DOMDocument
$issue		Issue
$article		PublishedArticle
$galley		ArticleGalley
$galleyFile		SubmissionFile
$objectLocalePrecedence		array
return	DOMElement

getClassName() public method

public getClassName ( )

getIssueInformation() public method

Construct an issue title from the journal title and the issue identification.

public getIssueInformation ( $issue, $objectLocalePrecedence = null ) : array \| string
$issue		Issue
$objectLocalePrecedence		array
return	array \| string	An array of localized issue titles or a string if a locale has been given.

getIssueToc() public method

Construct a table of content for an issue.

public getIssueToc ( $issue, $objectLocalePrecedence ) : string
$issue		Issue
$objectLocalePrecedence		array
return	string

getObjectLocalePrecedence() public method

Identify the locale precedence for this export.

public getObjectLocalePrecedence ( $context, $article, $galley ) : array
$context		Context
$article		PublishedArticle
$galley		ArticleGalley
return	array	A list of valid PKP locales in descending order of priority.

getPrimaryTranslation() public method

Identify the primary translation from an array of localized data.

public getPrimaryTranslation ( $localizedData, $localePrecedence ) : mixed \| null
$localizedData		array An array of localized data (key: locale, value: localized data).
$localePrecedence		array An array of locales by descending priority.
return	mixed \| null	The value of the primary locale or null if no primary translation could be found.

getTranslationsByPrecedence() public method

Re-order localized data by locale precedence.

public getTranslationsByPrecedence ( $localizedData, $localePrecedence ) : array
$localizedData		array An array of localized data (key: locale, value: localized data).
$localePrecedence		array An array of locales by descending priority.
return	array	Re-ordered localized data.

process() public method

translateLanguageToLocale() public method

Try to translate an ISO language code to an OJS locale.

public translateLanguageToLocale ( $language ) : string \| null
$language		string 2- or 3-letter ISO language code
return	string \| null	An OJS locale or null if no matching locale could be found.

public process ( &$pubObject ) : DOMDocument
$pubObject		Issue\|PublishedArticle\|ArticleGalley
return	DOMDocument