Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
DataciteExportDom Class Reference
Inheritance diagram for DataciteExportDom:
DOIExportDom

Public Member Functions

_alternateIdentifiersElement (&$object, &$issue, &$article, &$articleFile)
 
 _appendNonMandatoryChild (&$parentNode, &$child)
 
_creatorElement ($creator)
 
_creatorsElement (&$object, $objectLocalePrecedence, $publisher)
 
_dateElement ($dateType, $date)
 
_datesElement (&$issue, &$article, &$articleFile, &$suppFile, $publicationDate)
 
_descriptionsElement (&$issue, &$article, &$suppFile, $objectLocalePrecedence, &$articlesByIssue)
 
_formatsElement (&$articleFile)
 
 _getIssueInformation (&$issue, $objectLocalePrecedence=null)
 
 _getIssueToc (&$articlesByIssue, $objectLocalePrecedence)
 
_identifierElement (&$object)
 
_relatedIdentifierElement (&$object, $relationType)
 
_relatedIdentifiersElement (&$object, &$articlesByIssue, &$galleysByArticle, &$suppFilesByArticle, &$issue, &$article)
 
_resourceTypeElement ($object)
 
_retrieveSuppFilesByArticle (&$article)
 
_sizesElement (&$object, &$article)
 
_subjectElement ($subject, $subjectScheme=null)
 
_subjectsElement (&$object, $objectLocalePrecedence)
 
_titleElement ($title, $titleType=null)
 
_titlesElement (&$object, $objectLocalePrecedence)
 
 DataciteExportDom (&$request, &$plugin, &$journal, &$objectCache)
 
generate (&$object)
 
 getNamespace ()
 
 getObjectLocalePrecedence (&$article, &$galley, &$suppFile)
 
 getRootElementName ()
 
 getXmlSchemaLocation ()
 
retrievePublicationObjects (&$object)
 
- Public Member Functions inherited from DOIExportDom
 _addError ($errorTranslationKey, $param=null)
 
createElementWithText ($name, $value, $attributes=array())
 
 DOIExportDom (&$request, &$plugin, &$journal, &$objectCache)
 
generate (&$objects)
 
getCache ()
 
getDoc ()
 
 getErrors ()
 
 getFileType ($articleFile)
 
getJournal ()
 
 getNamespace ()
 
 getObjectLocalePrecedence (&$article, &$galley)
 
 getPluginSetting ($settingName)
 
 getPrimaryTranslation ($localizedData, $localePrecedence)
 
 getProprietaryId (&$journal, $issue=null, $articleOrArticleFile=null, $articleFile=null)
 
 getPublisher ($localePrecedence)
 
getRequest ()
 
 getRootElementName ()
 
 getSubjectClass (&$article, $objectLocalePrecedence)
 
 getTestMode ()
 
 getTranslationsByPrecedence ($localizedData, $localePrecedence)
 
 getXmlSchemaLocation ()
 
retrieveArticlesByIssue (&$issue)
 
retrieveGalleysByArticle (&$article)
 
retrievePublicationObjects (&$object)
 
rootElement ()
 
 translateLanguageToLocale ($language)
 

Detailed Description

DataCite XML export format implementation.

Definition at line 56 of file DataciteExportDom.inc.php.

Member Function Documentation

& DataciteExportDom::_alternateIdentifiersElement ( $object,
$issue,
$article,
$articleFile 
)

Generate alternate identifiers element list.

Parameters
$objectIssue|PublishedArticle|ArticleGalley|SuppFile
$issueIssue
$articlePublishedArticle
$articleFileArticleFile
Returns
XMLNode|DOMImplementation

Definition at line 600 of file DataciteExportDom.inc.php.

References DOIExportDom\createElementWithText(), DOIExportDom\getDoc(), DOIExportDom\getJournal(), and DOIExportDom\getProprietaryId().

Referenced by generate().

DataciteExportDom::_appendNonMandatoryChild ( $parentNode,
$child 
)

Datacite does not allow empty nodes. So we have to check nodes before we add them.

Parameters
$parentNodeXmlNode|DOMElement
$childXmlNode|DOMElement

Definition at line 906 of file DataciteExportDom.inc.php.

Referenced by generate().

& DataciteExportDom::_creatorElement (   $creator)

Create a single creator element.

Parameters
$creatorstring
Returns
XMLNode|DOMImplementation

Definition at line 364 of file DataciteExportDom.inc.php.

References DOIExportDom\getDoc().

Referenced by _creatorsElement().

& DataciteExportDom::_creatorsElement ( $object,
  $objectLocalePrecedence,
  $publisher 
)

Create the creators element list.

Parameters
$objectIssue|PublishedArticle|ArticleGalley|SuppFile
$objectLocalePrecedencearray
$publisherstring
Returns
XMLNode|DOMImplementation

Definition at line 316 of file DataciteExportDom.inc.php.

References _creatorElement(), DOIExportDom\getCache(), DOIExportDom\getDoc(), and DOIExportDom\getPrimaryTranslation().

Referenced by generate().

& DataciteExportDom::_dateElement (   $dateType,
  $date 
)

Create a single date element.

Parameters
$dateTypestring One of the DATACITE_DATE_* constants.
$datestring
Returns
XMLNode|DOMImplementation

Definition at line 559 of file DataciteExportDom.inc.php.

References DOIExportDom\createElementWithText().

Referenced by _datesElement().

& DataciteExportDom::_datesElement ( $issue,
$article,
$articleFile,
$suppFile,
  $publicationDate 
)

Create a date element list.

Parameters
$issueIssue
$articlePublishedArticle
$articleFileArticleFile
$suppFileSuppFile
$publicationDatestring
Returns
XMLNode|DOMImplementation

Definition at line 492 of file DataciteExportDom.inc.php.

References _dateElement(), and DOIExportDom\getDoc().

Referenced by generate().

& DataciteExportDom::_descriptionsElement ( $issue,
$article,
$suppFile,
  $objectLocalePrecedence,
$articlesByIssue 
)

Create a descriptions element list.

Parameters
$issueIssue
$articlePublishedArticle
$suppFileSuppFile
$objectLocalePrecedencearray
$articlesByIssuearray
Returns
XMLNode|DOMImplementation|null Can be null if no descriptions can be identified for the given object.

Definition at line 812 of file DataciteExportDom.inc.php.

References _getIssueInformation(), _getIssueToc(), DOIExportDom\createElementWithText(), DOIExportDom\getDoc(), and DOIExportDom\getPrimaryTranslation().

Referenced by generate().

& DataciteExportDom::_formatsElement ( $articleFile)

Create a formats element list.

Parameters
$articleFileArticleFile
Returns
XMLNode|DOMImplementation|null Can be null if a format cannot be identified for the given object.

Definition at line 790 of file DataciteExportDom.inc.php.

References DOIExportDom\getDoc().

Referenced by generate().

DataciteExportDom::_getIssueInformation ( $issue,
  $objectLocalePrecedence = null 
)

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

Parameters
$issueIssue
$objectLocalePrecedencearray
Returns
array|string An array of localized issue titles or a string if a locale has been given.

Definition at line 858 of file DataciteExportDom.inc.php.

References DOIExportDom\getJournal(), and DOIExportDom\getPrimaryTranslation().

Referenced by _descriptionsElement(), and _titlesElement().

DataciteExportDom::_getIssueToc ( $articlesByIssue,
  $objectLocalePrecedence 
)

Construct a table of content from an article list.

Parameters
$articlesByIssue
$objectLocalePrecedencearray
Returns
string

Definition at line 884 of file DataciteExportDom.inc.php.

References DOIExportDom\getPrimaryTranslation().

Referenced by _descriptionsElement().

& DataciteExportDom::_identifierElement ( $object)

Create an identifier element.

Parameters
$objectIssue|PublishedArticle|ArticleGalley|SuppFile
Returns
XMLNode|DOMImplementation

Definition at line 297 of file DataciteExportDom.inc.php.

References DOIExportDom\_addError(), DOIExportDom\createElementWithText(), DOIExportDom\getTestMode(), and String\regexp_replace().

Referenced by generate().

& DataciteExportDom::_relatedIdentifierElement ( $object,
  $relationType 
)

Create an identifier element with the object's DOI.

Parameters
$objectIssue|PublishedArticle|ArticleGalley|SuppFile
$relationTypestring One of the DATACITE_RELTYPE_* constants.
Returns
XMLNode|DOMImplementation|null Can be null if the given ID Type has not been assigned to the given object.

Definition at line 708 of file DataciteExportDom.inc.php.

References DOIExportDom\createElementWithText(), DOIExportDom\getTestMode(), and String\regexp_replace().

Referenced by _relatedIdentifiersElement().

& DataciteExportDom::_relatedIdentifiersElement ( $object,
$articlesByIssue,
$galleysByArticle,
$suppFilesByArticle,
$issue,
$article 
)

Generate related identifiers element list.

Parameters
$objectIssue|PublishedArticle|ArticleGalley|SuppFile
$articlesByIssuearray
$galleysByArticlearray
$suppFilesByArticlearray
$issueIssue
$articlePublishedArticle
Returns
XMLNode|DOMImplementation

Definition at line 653 of file DataciteExportDom.inc.php.

References _relatedIdentifierElement(), DOIExportDom\getDoc(), and DOIExportDom\getJournal().

Referenced by generate().

& DataciteExportDom::_resourceTypeElement (   $object)

Create a resource type element.

Parameters
$objectIssue|PublishedArticle|ArticleGalley
Returns
XMLNode|DOMImplementation

Definition at line 573 of file DataciteExportDom.inc.php.

References DOIExportDom\createElementWithText().

Referenced by generate().

& DataciteExportDom::_retrieveSuppFilesByArticle ( $article)

Retrieve all supp files for the given article and commit them to the cache.

Parameters
$articlePublishedArticle
Returns
array

Definition at line 273 of file DataciteExportDom.inc.php.

References DOIExportDom\getCache(), and DAORegistry\getDAO().

Referenced by retrievePublicationObjects().

& DataciteExportDom::_sizesElement ( $object,
$article 
)

Create a sizes element list.

Parameters
$objectIssue|PublishedArticle|ArticleFile
$articlePublishedArticle|null
Returns
XMLNode|DOMImplementation|null Can be null if a size cannot be identified for the given object.

Definition at line 735 of file DataciteExportDom.inc.php.

References DAORegistry\getDAO(), and DOIExportDom\getDoc().

Referenced by generate().

& DataciteExportDom::_subjectElement (   $subject,
  $subjectScheme = null 
)

Create a single subject element.

Parameters
$subjectstring
$subjectSchemestring
Returns
XMLNode|DOMImplementation

Definition at line 475 of file DataciteExportDom.inc.php.

References DOIExportDom\createElementWithText().

Referenced by _subjectsElement().

& DataciteExportDom::_subjectsElement ( $object,
  $objectLocalePrecedence 
)

Create the subjects element list.

Parameters
$objectPublishedArticle|SuppFile
$objectLocalePrecedencearray
Returns
XMLNode|DOMImplementation

Definition at line 447 of file DataciteExportDom.inc.php.

References _subjectElement(), DOIExportDom\getDoc(), DOIExportDom\getPrimaryTranslation(), and DOIExportDom\getSubjectClass().

Referenced by generate().

& DataciteExportDom::_titleElement (   $title,
  $titleType = null 
)

Create a single title element.

Parameters
$titlestring
$titleTypestring One of the DATACITE_TITLETYPE_* constants.
Returns
XMLNode|DOMImplementation

Definition at line 433 of file DataciteExportDom.inc.php.

References DOIExportDom\createElementWithText().

Referenced by _titlesElement().

& DataciteExportDom::_titlesElement ( $object,
  $objectLocalePrecedence 
)

Create the titles element list.

Parameters
$objectIssue|PublishedArticle|ArticleGalley|SuppFile
$objectLocalePrecedencearray
Returns
XMLNode|DOMImplementation

Definition at line 376 of file DataciteExportDom.inc.php.

References _getIssueInformation(), _titleElement(), DOIExportDom\getCache(), DOIExportDom\getDoc(), DOIExportDom\getPrimaryTranslation(), and DOIExportDom\getTranslationsByPrecedence().

Referenced by generate().

DataciteExportDom::DataciteExportDom ( $request,
$plugin,
$journal,
$objectCache 
)

Constructor

Parameters
$requestRequest
$pluginDOIExportPlugin
$journalJournal
$objectCachePubObjectCache

Definition at line 68 of file DataciteExportDom.inc.php.

DataciteExportDom::getNamespace ( )
See Also
DOIExportDom::getNamespace()

Definition at line 197 of file DataciteExportDom.inc.php.

DataciteExportDom::getObjectLocalePrecedence ( $article,
$galley,
$suppFile 
)
See Also
DOIExportDom::getObjectLocalePrecedence()
Parameters
$suppFileSuppFile

Definition at line 248 of file DataciteExportDom.inc.php.

References DOIExportDom\translateLanguageToLocale().

Referenced by generate().

DataciteExportDom::getRootElementName ( )
DataciteExportDom::getXmlSchemaLocation ( )

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