| Server IP : 172.66.157.178 / Your IP : 172.16.20.3 Web Server : Apache/2.4.25 (Debian) System : Linux f64a392e70de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 User : application ( 1000) PHP Version : 5.6.40 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /app/plugins/importexport/datacite/classes/ |
Upload File : |
<?php
/**
* @file plugins/importexport/datacite/classes/DataciteExportDom.inc.php
*
* Copyright (c) 2013-2019 Simon Fraser University
* Copyright (c) 2003-2019 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class DataciteExportDom
* @ingroup plugins_importexport_datacite_classes
*
* @brief DataCite XML export format implementation.
*/
if (!class_exists('DOIExportDom')) { // Bug #7848
import('plugins.importexport.datacite.classes.DOIExportDom');
}
// XML attributes
define('DATACITE_XMLNS' , 'http://datacite.org/schema/kernel-3');
define('DATACITE_XSI_SCHEMALOCATION' , 'http://datacite.org/schema/kernel-3 http://schema.datacite.org/meta/kernel-3/metadata.xsd');
// Date types
define('DATACITE_DATE_AVAILABLE', 'Available');
define('DATACITE_DATE_ISSUED', 'Issued');
define('DATACITE_DATE_SUBMITTED', 'Submitted');
define('DATACITE_DATE_ACCEPTED', 'Accepted');
define('DATACITE_DATE_CREATED', 'Created');
define('DATACITE_DATE_UPDATED', 'Updated');
// Identifier types
define('DATACITE_IDTYPE_PROPRIETARY', 'publisherId');
define('DATACITE_IDTYPE_EISSN', 'EISSN');
define('DATACITE_IDTYPE_ISSN', 'ISSN');
define('DATACITE_IDTYPE_DOI', 'DOI');
// Title types
define('DATACITE_TITLETYPE_TRANSLATED', 'TranslatedTitle');
define('DATACITE_TITLETYPE_ALTERNATIVE', 'AlternativeTitle');
// Relation types
define('DATACITE_RELTYPE_ISVARIANTFORMOF', 'IsVariantFormOf');
define('DATACITE_RELTYPE_HASPART', 'HasPart');
define('DATACITE_RELTYPE_ISPARTOF', 'IsPartOf');
define('DATACITE_RELTYPE_ISPREVIOUSVERSIONOF', 'IsPreviousVersionOf');
define('DATACITE_RELTYPE_ISNEWVERSIONOF', 'IsNewVersionOf');
// Description types
define('DATACITE_DESCTYPE_ABSTRACT', 'Abstract');
define('DATACITE_DESCTYPE_SERIESINFO', 'SeriesInformation');
define('DATACITE_DESCTYPE_TOC', 'TableOfContents');
define('DATACITE_DESCTYPE_OTHER', 'Other');
class DataciteExportDom extends DOIExportDom {
//
// Constructor
//
/**
* Constructor
* @param $request Request
* @param $plugin DOIExportPlugin
* @param $journal Journal
* @param $objectCache PubObjectCache
*/
function DataciteExportDom(&$request, &$plugin, &$journal, &$objectCache) {
// Configure the DOM.
parent::DOIExportDom($request, $plugin, $journal, $objectCache);
}
//
// Public methods
//
/**
* @see DOIExportDom::generate()
*/
function &generate(&$object) {
$falseVar = false;
// Declare variables that will contain publication objects.
$journal =& $this->getJournal();
$issue = null; /* @var $issue Issue */
$article = null; /* @var $article PublishedArticle */
$galley = null; /* @var $galley ArticleGalley */
$suppFile = null; /* @var $suppFile SuppFile */
$articlesByIssue = null;
$galleysByArticle = null;
$suppFilesByArticle = null;
// Retrieve required publication objects (depends on the object to be exported).
$pubObjects =& $this->retrievePublicationObjects($object);
extract($pubObjects);
// Identify an object implementing an ArticleFile (if any).
$articleFile = (empty($suppFile) ? $galley : $suppFile);
// Identify the object locale.
$objectLocalePrecedence = $this->getObjectLocalePrecedence($article, $galley, $suppFile);
// The publisher is required.
$publisher = (is_a($object, 'SuppFile') ? $object->getSuppFilePublisher() : null);
if (empty($publisher)) {
$publisher = $this->getPublisher($objectLocalePrecedence);
}
// The publication date is required.
$publicationDate = (is_a($article, 'PublishedArticle') ? $article->getDatePublished() : null);
if (empty($publicationDate)) {
$publicationDate = $issue->getDatePublished();
}
assert(!empty($publicationDate));
// Create the XML document and its root element.
$doc =& $this->getDoc();
$rootElement =& $this->rootElement();
XMLCustomWriter::appendChild($doc, $rootElement);
// DOI (mandatory)
if (($identifierElement =& $this->_identifierElement($object)) === false) return false;
XMLCustomWriter::appendChild($rootElement, $identifierElement);
// Creators (mandatory)
XMLCustomWriter::appendChild($rootElement, $this->_creatorsElement($object, $objectLocalePrecedence, $publisher));
// Title (mandatory)
XMLCustomWriter::appendChild($rootElement, $this->_titlesElement($object, $objectLocalePrecedence));
// Publisher (mandatory)
XMLCustomWriter::createChildWithText($this->getDoc(), $rootElement, 'publisher', $publisher);
// Publication Year (mandatory)
XMLCustomWriter::createChildWithText($this->getDoc(), $rootElement, 'publicationYear', date('Y', strtotime($publicationDate)));
// Subjects
if (!empty($suppFile)) {
$this->_appendNonMandatoryChild($rootElement, $this->_subjectsElement($suppFile, $objectLocalePrecedence));
} elseif (!empty($article)) {
$this->_appendNonMandatoryChild($rootElement, $this->_subjectsElement($article, $objectLocalePrecedence));
}
// Dates
XMLCustomWriter::appendChild($rootElement, $this->_datesElement($issue, $article, $articleFile, $suppFile, $publicationDate));
// Language
XMLCustomWriter::createChildWithText($this->getDoc(), $rootElement, 'language', AppLocale::getIso1FromLocale($objectLocalePrecedence[0]));
// Resource Type
if (!is_a($object, 'SuppFile')) {
$resourceTypeElement =& $this->_resourceTypeElement($object);
XMLCustomWriter::appendChild($rootElement, $resourceTypeElement);
}
// Alternate Identifiers
$this->_appendNonMandatoryChild($rootElement, $this->_alternateIdentifiersElement($object, $issue, $article, $articleFile));
// Related Identifiers
$this->_appendNonMandatoryChild($rootElement, $this->_relatedIdentifiersElement($object, $articlesByIssue, $galleysByArticle, $suppFilesByArticle, $issue, $article));
// Sizes
$sizesElement =& $this->_sizesElement($object, $article);
if ($sizesElement) XMLCustomWriter::appendChild($rootElement, $sizesElement);
// Formats
if (!empty($articleFile)) {
$formatsElement =& $this->_formatsElement($articleFile);
if ($formatsElement) XMLCustomWriter::appendChild($rootElement, $formatsElement);
}
// Rights
$rightsURL = $article?$article->getLicenseURL():$journal->getSetting('licenseURL');
$rightsListElement =& XMLCustomWriter::createElement($this->getDoc(), 'rightsList');
$rightsElement = $this->createElementWithText('rights', strip_tags(Application::getCCLicenseBadge($rightsURL)), array('rightsURI' => $rightsURL));
XMLCustomWriter::appendChild($rightsListElement, $rightsElement);
XMLCustomWriter::appendChild($rootElement, $rightsListElement);
// Descriptions
$descriptionsElement =& $this->_descriptionsElement($issue, $article, $suppFile, $objectLocalePrecedence, $articlesByIssue);
if ($descriptionsElement) XMLCustomWriter::appendChild($rootElement, $descriptionsElement);
return $doc;
}
//
// Implementation of template methods from DOIExportDom
//
/**
* @see DOIExportDom::getRootElementName()
*/
function getRootElementName() {
return 'resource';
}
/**
* @see DOIExportDom::getNamespace()
*/
function getNamespace() {
return DATACITE_XMLNS;
}
/**
* @see DOIExportDom::getXmlSchemaLocation()
*/
function getXmlSchemaLocation() {
return DATACITE_XSI_SCHEMALOCATION;
}
/**
* @see DOIExportDom::retrievePublicationObjects()
*/
function &retrievePublicationObjects(&$object) {
// Initialize local variables.
$nullVar = null;
$journal =& $this->getJournal();
$cache =& $this->getCache();
// Retrieve basic OJS objects.
$publicationObjects = parent::retrievePublicationObjects($object);
if (is_a($object, 'SuppFile')) {
assert(isset($publicationObjects['article']));
$cache->add($object, $publicationObjects['article']);
$publicationObjects['suppFile'] =& $object;
}
// Retrieve additional related objects.
// For articles: Retrieve all galleys and supp files of the article:
if (is_a($object, 'PublishedArticle')) {
$article =& $publicationObjects['article'];
$publicationObjects['galleysByArticle'] =& $this->retrieveGalleysByArticle($article);
$publicationObjects['suppFilesByArticle'] =& $this->_retrieveSuppFilesByArticle($article);
}
// For issues: Retrieve all articles of the issue:
if (is_a($object, 'Issue')) {
// Articles by issue.
assert(isset($publicationObjects['issue']));
$issue =& $publicationObjects['issue'];
$publicationObjects['articlesByIssue'] =& $this->retrieveArticlesByIssue($issue);
}
return $publicationObjects;
}
/**
* @see DOIExportDom::getObjectLocalePrecedence()
* @param $suppFile SuppFile
*/
function getObjectLocalePrecedence(&$article, &$galley, &$suppFile) {
$locales = array();
if (is_a($suppFile, 'SuppFile')) {
// Try to map the supp-file language to a PKP locale.
$suppFileLocale = $this->translateLanguageToLocale($suppFile->getLanguage());
if (!is_null($suppFileLocale)) {
$locales[] = $suppFileLocale;
}
}
// Retrieve further locales from the other objects.
$locales = array_merge($locales, parent::getObjectLocalePrecedence($article, $galley));
return $locales;
}
/**
* Identify the publisher of the journal (journal title for DataCite citation purposes).
* @param $localePrecedence array
* @return string
*/
function getPublisher($localePrecedence) {
$journal =& $this->getJournal();
$publisher = $this->getPrimaryTranslation($journal->getTitle(null), $localePrecedence);
assert(!empty($publisher));
return $publisher;
}
//
// Private helper methods
//
/**
* Retrieve all supp files for the given article
* and commit them to the cache.
* @param $article PublishedArticle
* @return array
*/
function &_retrieveSuppFilesByArticle(&$article) {
$suppFilesByArticle = array();
$cache =& $this->getCache();
$articleId = $article->getId();
if (!$cache->isCached('suppFilesByArticle', $articleId)) {
$suppFileDao =& DAORegistry::getDAO('SuppFileDAO'); /* @var $suppFileDao SuppFileDAO */
$suppFiles =& $suppFileDao->getSuppFilesByArticle($articleId);
if (!empty($suppFiles)) {
foreach($suppFiles as $suppFile) {
$cache->add($suppFile, $article);
unset($suppFile);
}
$cache->markComplete('suppFilesByArticle', $articleId);
$suppFilesByArticle = $cache->get('suppFilesByArticle', $articleId);
}
} else {
$suppFilesByArticle = $cache->get('suppFilesByArticle', $articleId);
}
return $suppFilesByArticle;
}
/**
* Create an identifier element.
* @param $object Issue|PublishedArticle|ArticleGalley|SuppFile
* @return XMLNode|DOMImplementation
*/
function &_identifierElement(&$object) {
$doi = $object->getPubId('doi');
if (empty($doi)) {
$this->_addError('plugins.importexport.common.export.error.noDoiAssigned', $object->getId());
return $falseVar;
}
if ($this->getTestMode()) {
$doi = PKPString::regexp_replace('#^[^/]+/#', DATACITE_API_TESTPREFIX . '/', $doi);
}
return $this->createElementWithText('identifier', $doi, array('identifierType' => 'DOI'));
}
/**
* Create the creators element list.
* @param $object Issue|PublishedArticle|ArticleGalley|SuppFile
* @param $objectLocalePrecedence array
* @param $publisher string
* @return XMLNode|DOMImplementation
*/
function &_creatorsElement(&$object, $objectLocalePrecedence, $publisher) {
$cache =& $this->getCache();
$creators = array();
switch (true) {
case is_a($object, 'SuppFile'):
// Check whether we have a supp file creator set...
$creator = $this->getPrimaryTranslation($object->getCreator(null), $objectLocalePrecedence);
if (!empty($creator)) {
$creators[] = $creator;
break;
}
// ...if not then go on by retrieving the article
// authors.
case is_a($object, 'ArticleGalley'):
// Retrieve the article of the supp file or galley...
$article =& $cache->get('articles', $object->getArticleId());
// ...then go on by retrieving the article authors.
case is_a($object, 'PublishedArticle'):
// Retrieve the article authors.
if (!isset($article)) $article =& $object;
$authors =& $article->getAuthors();
assert(!empty($authors));
foreach ($authors as $author) { /* @var $author Author */
$creators[] = $author->getFullName(true);
}
break;
case is_a($object, 'Issue'):
$creators[] = $publisher;
break;
}
assert(count($creators) >= 1);
$creatorsElement =& XMLCustomWriter::createElement($this->getDoc(), 'creators');
foreach($creators as $creator) {
XMLCustomWriter::appendChild($creatorsElement, $this->_creatorElement($creator));
}
return $creatorsElement;
}
/**
* Create a single creator element.
* @param $creator string
* @return XMLNode|DOMImplementation
*/
function &_creatorElement($creator) {
$creatorElement =& XMLCustomWriter::createElement($this->getDoc(), 'creator');
XMLCustomWriter::createChildWithText($this->getDoc(), $creatorElement, 'creatorName', $creator);
return $creatorElement;
}
/**
* Create the titles element list.
* @param $object Issue|PublishedArticle|ArticleGalley|SuppFile
* @param $objectLocalePrecedence array
* @return XMLNode|DOMImplementation
*/
function &_titlesElement(&$object, $objectLocalePrecedence) {
$cache =& $this->getCache();
// Get an array of localized titles.
$alternativeTitle = null;
switch (true) {
case is_a($object, 'SuppFile'):
$titles = $object->getTitle(null);
break;
case is_a($object, 'ArticleGalley'):
// Retrieve the article of the galley...
$article =& $cache->get('articles', $object->getArticleId());
// ...then go on by retrieving the article titles.
case is_a($object, 'PublishedArticle'):
if (!isset($article)) $article =& $object;
$titles =& $article->getTitle(null);
break;
case is_a($object, 'Issue'):
$titles = $this->_getIssueInformation($object);
$alternativeTitle = $this->getPrimaryTranslation($object->getTitle(null), $objectLocalePrecedence);
break;
}
// Order titles by locale precedence.
$titles = $this->getTranslationsByPrecedence($titles, $objectLocalePrecedence);
// We expect at least one title.
assert(count($titles)>=1);
$titlesElement =& XMLCustomWriter::createElement($this->getDoc(), 'titles');
// Start with the primary object locale.
$primaryTitle = array_shift($titles);
XMLCustomWriter::appendChild($titlesElement, $this->_titleElement($primaryTitle));
// Then let the translated titles follow.
foreach($titles as $locale => $title) {
XMLCustomWriter::appendChild($titlesElement, $this->_titleElement($title, DATACITE_TITLETYPE_TRANSLATED));
}
// And finally the alternative title.
if (!empty($alternativeTitle)) {
XMLCustomWriter::appendChild($titlesElement, $this->_titleElement($alternativeTitle, DATACITE_TITLETYPE_ALTERNATIVE));
}
return $titlesElement;
}
/**
* Create a single title element.
* @param $title string
* @param $titleType string One of the DATACITE_TITLETYPE_* constants.
* @return XMLNode|DOMImplementation
*/
function &_titleElement($title, $titleType = null) {
$titleElement =& $this->createElementWithText('title', $title);
if (!is_null($titleType)) {
XMLCustomWriter::setAttribute($titleElement, 'titleType', $titleType);
}
return $titleElement;
}
/**
* Create the subjects element list.
* @param $object PublishedArticle|SuppFile
* @param $objectLocalePrecedence array
* @return XMLNode|DOMImplementation
*/
function &_subjectsElement(&$object, $objectLocalePrecedence) {
$subjectsElement =& XMLCustomWriter::createElement($this->getDoc(), 'subjects');
if (is_a($object, 'SuppFile')) {
$suppFileSubject = $this->getPrimaryTranslation($object->getSubject(null), $objectLocalePrecedence);
if (!empty($suppFileSubject)) {
XMLCustomWriter::appendChild($subjectsElement, $this->_subjectElement($suppFileSubject));
}
} else {
assert(is_a($object, 'PublishedArticle'));
$keywords = $this->getPrimaryTranslation($object->getSubject(null), $objectLocalePrecedence);
if (!empty($keywords)) {
XMLCustomWriter::appendChild($subjectsElement, $this->_subjectElement($keywords));
}
list($subjectSchemeName, $subjectCode) = $this->getSubjectClass($object, $objectLocalePrecedence);
if (!(empty($subjectSchemeName) || empty($subjectCode))) {
XMLCustomWriter::appendChild($subjectsElement, $this->_subjectElement($subjectCode, $subjectSchemeName));
}
}
return $subjectsElement;
}
/**
* Create a single subject element.
* @param $subject string
* @param $subjectScheme string
* @return XMLNode|DOMImplementation
*/
function &_subjectElement($subject, $subjectScheme = null) {
$subjectElement =& $this->createElementWithText('subject', $subject);
if (!empty($subjectScheme)) {
XMLCustomWriter::setAttribute($subjectElement, 'subjectScheme', $subjectScheme);
}
return $subjectElement;
}
/**
* Create a date element list.
* @param $issue Issue
* @param $article PublishedArticle
* @param $articleFile ArticleFile
* @param $suppFile SuppFile
* @param $publicationDate string
* @return XMLNode|DOMImplementation
*/
function &_datesElement(&$issue, &$article, &$articleFile, &$suppFile, $publicationDate) {
$datesElement =& XMLCustomWriter::createElement($this->getDoc(), 'dates');
$dates = array();
// Created date (for supp files only): supp file date created.
if (!empty($suppFile)) {
$createdDate = $suppFile->getDateCreated();
if (!empty($createdDate)) {
$dates[DATACITE_DATE_CREATED] = $createdDate;
}
}
// Submitted date (for articles and galleys): article date submitted.
if (!empty($article)) {
$submittedDate = $article->getDateSubmitted();
if (!empty($submittedDate)) {
$dates[DATACITE_DATE_SUBMITTED] = $submittedDate;
// Default accepted date: submitted date.
$dates[DATACITE_DATE_ACCEPTED] = $submittedDate;
}
}
// Submitted date (for supp files): supp file date submitted.
if (!empty($suppFile)) {
$submittedDate = $suppFile->getDateSubmitted();
if (!empty($submittedDate)) {
$dates[DATACITE_DATE_SUBMITTED] = $submittedDate;
}
}
// Accepted date (for galleys and supp files): article file uploaded.
if (!empty($articleFile)) {
$acceptedDate = $articleFile->getDateUploaded();
if (!empty($acceptedDate)) {
$dates[DATACITE_DATE_ACCEPTED] = $acceptedDate;
}
}
// Issued date: publication date.
$dates[DATACITE_DATE_ISSUED] = $publicationDate;
// Available date: issue open access date.
$availableDate = $issue->getOpenAccessDate();
if (!empty($availableDate)) {
$dates[DATACITE_DATE_AVAILABLE] = $availableDate;
}
// Last modified date (for articles): last modified date.
if (!empty($article) && empty($articleFile)) {
$dates[DATACITE_DATE_UPDATED] = $article->getLastModified();
}
// Create the date elements for all dates.
foreach($dates as $dateType => $date) {
XMLCustomWriter::appendChild($datesElement, $this->_dateElement($dateType, $date));
}
return $datesElement;
}
/**
* Create a single date element.
* @param $dateType string One of the DATACITE_DATE_* constants.
* @param $date string
* @return XMLNode|DOMImplementation
*/
function &_dateElement($dateType, $date) {
// Format the date.
assert(!empty($date));
$date = date('Y-m-d', strtotime($date));
// Create the date element.
return $this->createElementWithText('date', $date, array('dateType' => $dateType));
}
/**
* Create a resource type element.
* @param $object Issue|PublishedArticle|ArticleGalley
* @return XMLNode|DOMImplementation
*/
function &_resourceTypeElement($object) {
switch (true) {
case is_a($object, 'Issue'):
$resourceType = 'Journal Issue';
break;
case is_a($object, 'PublishedArticle'):
case is_a($object, 'ArticleGalley'):
$resourceType = 'Article';
break;
default:
assert(false);
}
// Create the resourceType element.
return $this->createElementWithText('resourceType', $resourceType, array('resourceTypeGeneral' => 'Text'));
}
/**
* Generate alternate identifiers element list.
* @param $object Issue|PublishedArticle|ArticleGalley|SuppFile
* @param $issue Issue
* @param $article PublishedArticle
* @param $articleFile ArticleFile
* @return XMLNode|DOMImplementation
*/
function &_alternateIdentifiersElement(&$object, &$issue, &$article, &$articleFile) {
$journal =& $this->getJournal();
$alternateIdentifiersElement =& XMLCustomWriter::createElement($this->getDoc(), 'alternateIdentifiers');
// Proprietary ID
$proprietaryId = $this->getProprietaryId($journal, $issue, $article, $articleFile);
XMLCustomWriter::appendChild(
$alternateIdentifiersElement,
$this->createElementWithText(
'alternateIdentifier', $proprietaryId,
array('alternateIdentifierType' => DATACITE_IDTYPE_PROPRIETARY)
)
);
// ISSN - for issues only.
if (is_a($object, 'Issue')) {
$onlineIssn = $journal->getSetting('onlineIssn');
if (!empty($onlineIssn)) {
XMLCustomWriter::appendChild(
$alternateIdentifiersElement,
$this->createElementWithText(
'alternateIdentifier', $onlineIssn,
array('alternateIdentifierType' => DATACITE_IDTYPE_EISSN)
)
);
}
$printIssn = $journal->getSetting('printIssn');
if (!empty($printIssn)) {
XMLCustomWriter::appendChild(
$alternateIdentifiersElement,
$this->createElementWithText(
'alternateIdentifier', $printIssn,
array('alternateIdentifierType' => DATACITE_IDTYPE_ISSN)
)
);
}
}
return $alternateIdentifiersElement;
}
/**
* Generate related identifiers element list.
* @param $object Issue|PublishedArticle|ArticleGalley|SuppFile
* @param $articlesByIssue array
* @param $galleysByArticle array
* @param $suppFilesByArticle array
* @param $issue Issue
* @param $article PublishedArticle
* @return XMLNode|DOMImplementation
*/
function &_relatedIdentifiersElement(&$object, &$articlesByIssue, &$galleysByArticle, &$suppFilesByArticle, &$issue, &$article) {
$journal =& $this->getJournal();
$relatedIdentifiersElement =& XMLCustomWriter::createElement($this->getDoc(), 'relatedIdentifiers');
switch (true) {
case is_a($object, 'Issue'):
// Parts: articles in this issue.
assert(is_array($articlesByIssue));
foreach($articlesByIssue as $articleInIssue) {
$doi =& $this->_relatedIdentifierElement($articleInIssue, DATACITE_RELTYPE_HASPART);
if (!is_null($doi)) XMLCustomWriter::appendChild($relatedIdentifiersElement, $doi);
unset($articleInIssue, $doi);
}
break;
case is_a($object, 'PublishedArticle'):
// Part of: issue.
assert(is_a($issue, 'Issue'));
$doi =& $this->_relatedIdentifierElement($issue, DATACITE_RELTYPE_ISPARTOF);
if (!is_null($doi)) XMLCustomWriter::appendChild($relatedIdentifiersElement, $doi);
unset($doi);
// Parts: galleys and supp files.
assert(is_array($galleysByArticle) && is_array($suppFilesByArticle));
$relType = DATACITE_RELTYPE_HASPART;
foreach($galleysByArticle as $galleyInArticle) {
$doi =& $this->_relatedIdentifierElement($galleyInArticle, $relType);
if (!is_null($doi)) XMLCustomWriter::appendChild($relatedIdentifiersElement, $doi);
unset($galleyInArticle, $doi);
}
foreach($suppFilesByArticle as $suppFileInArticle) {
$doi =& $this->_relatedIdentifierElement($suppFileInArticle, $relType);
if (!is_null($doi)) XMLCustomWriter::appendChild($relatedIdentifiersElement, $doi);
unset($suppFileInArticle, $doi);
}
break;
case is_a($object, 'ArticleFile'):
// Part of: article.
assert(is_a($article, 'Article'));
$doi =& $this->_relatedIdentifierElement($article, DATACITE_RELTYPE_ISPARTOF);
if (!is_null($doi)) XMLCustomWriter::appendChild($relatedIdentifiersElement, $doi);
break;
}
return $relatedIdentifiersElement;
}
/**
* Create an identifier element with the object's DOI.
* @param $object Issue|PublishedArticle|ArticleGalley|SuppFile
* @param $relationType string One of the DATACITE_RELTYPE_* constants.
* @return XMLNode|DOMImplementation|null Can be null if the given ID Type
* has not been assigned to the given object.
*/
function &_relatedIdentifierElement(&$object, $relationType) {
$id = $object->getPubId('doi');
if (empty($id)) {
return $nullVar;
$nullVar = null;
}
if ($this->getTestMode()) {
$id = PKPString::regexp_replace('#^[^/]+/#', DATACITE_API_TESTPREFIX . '/', $id);
}
return $this->createElementWithText(
'relatedIdentifier', $id,
array(
'relatedIdentifierType' => DATACITE_IDTYPE_DOI,
'relationType' => $relationType
)
);
}
/**
* Create a sizes element list.
* @param $object Issue|PublishedArticle|ArticleFile
* @param $article PublishedArticle|null
* @return XMLNode|DOMImplementation|null Can be null if a size
* cannot be identified for the given object.
*/
function &_sizesElement(&$object, &$article) {
switch (true) {
case is_a($object, 'Issue'):
$issueGalleyDao =& DAORegistry::getDAO('IssueGalleyDAO'); /* @var $issueGalleyDao IssueGalleyDAO */
$files =& $issueGalleyDao->getGalleysByIssue($object->getId());
break;
case is_a($object, 'PublishedArticle'):
$pages = $object->getPages();
$files = array();
break;
case is_a($object, 'ArticleFile'):
if (is_a($object, 'ArticleGalley')) {
// The galley represents the article.
$pages = $article->getPages();
}
$files = array(&$object);
break;
default:
assert(false);
}
$sizes = array();
if (!empty($pages)) {
$sizes[] = $pages . ' ' . __('editor.issues.pages');
}
foreach($files as $file) { /* @var $file PKPFile */
$fileSize = round(((int)$file->getFileSize()) / 1024);
if ($fileSize >= 1024) {
$fileSize = round($fileSize / 1024, 2);
$sizes[] = $fileSize . ' MB';
} elseif ($fileSize >= 1) {
$sizes[] = $fileSize . ' kB';
}
unset($file);
}
$sizesElement = null;
if (!empty($sizes)) {
$sizesElement =& XMLCustomWriter::createElement($this->getDoc(), 'sizes');
foreach($sizes as $size) {
XMLCustomWriter::createChildWithText($this->getDoc(), $sizesElement, 'size', $size);
}
}
return $sizesElement;
}
/**
* Create a formats element list.
* @param $articleFile ArticleFile
* @return XMLNode|DOMImplementation|null Can be null if a format
* cannot be identified for the given object.
*/
function &_formatsElement(&$articleFile) {
$format = $articleFile->getFileType();
if (empty($format)) {
$nullVar = null;
return $nullVar;
}
$formatsElement =& XMLCustomWriter::createElement($this->getDoc(), 'formats');
XMLCustomWriter::createChildWithText($this->getDoc(), $formatsElement, 'format', $format);
return $formatsElement;
}
/**
* Create a descriptions element list.
* @param $issue Issue
* @param $article PublishedArticle
* @param $suppFile SuppFile
* @param $objectLocalePrecedence array
* @param $articlesByIssue array
* @return XMLNode|DOMImplementation|null Can be null if no descriptions
* can be identified for the given object.
*/
function &_descriptionsElement(&$issue, &$article, &$suppFile, $objectLocalePrecedence, &$articlesByIssue) {
$descriptions = array();
if (isset($article) && !isset($suppFile)) {
// Articles and galleys.
$articleAbstract = $this->getPrimaryTranslation($article->getAbstract(null), $objectLocalePrecedence);
if (!empty($articleAbstract)) $descriptions[DATACITE_DESCTYPE_ABSTRACT] = $articleAbstract;
}
if (isset($suppFile)) {
// Supp files.
$suppFileDesc = $this->getPrimaryTranslation($suppFile->getDescription(null), $objectLocalePrecedence);
if (!empty($suppFileDesc)) $descriptions[DATACITE_DESCTYPE_OTHER] = $suppFileDesc;
}
if (isset($article)) {
// Articles, galleys and supp files.
$descriptions[DATACITE_DESCTYPE_SERIESINFO] = $this->_getIssueInformation($issue, $objectLocalePrecedence);
} else {
// Issues.
$issueDesc = $this->getPrimaryTranslation($issue->getDescription(null), $objectLocalePrecedence);
if (!empty($issueDesc)) $descriptions[DATACITE_DESCTYPE_OTHER] = $issueDesc;
$descriptions[DATACITE_DESCTYPE_TOC] = $this->_getIssueToc($articlesByIssue, $objectLocalePrecedence);
}
$descriptionsElement = null;
if (!empty($descriptions)) {
$descriptionsElement =& XMLCustomWriter::createElement($this->getDoc(), 'descriptions');
foreach($descriptions as $descType => $description) {
XMLCustomWriter::appendChild(
$descriptionsElement,
$this->createElementWithText('description', $description, array('descriptionType' => $descType))
);
}
}
return $descriptionsElement;
}
/**
* Construct an issue title from the journal title
* and the issue identification.
* @param $issue Issue
* @param $objectLocalePrecedence array
* @return array|string An array of localized issue titles
* or a string if a locale has been given.
*/
function _getIssueInformation(&$issue, $objectLocalePrecedence = null) {
$issueIdentification = $issue->getIssueIdentification();
assert(!empty($issueIdentification));
$journal =& $this->getJournal();
if (is_null($objectLocalePrecedence)) {
$issueInfo = array();
foreach ($journal->getTitle(null) as $locale => $journalTitle) {
$issueInfo[$locale] = "$journalTitle, $issueIdentification";
}
} else {
$issueInfo = $this->getPrimaryTranslation($journal->getTitle(null), $objectLocalePrecedence);
if (!empty($issueInfo)) {
$issueInfo .= ', ';
}
$issueInfo .= $issueIdentification;
}
return $issueInfo;
}
/**
* Construct a table of content from an article list.
* @param $articlesByIssue
* @param $objectLocalePrecedence array
* @return string
*/
function _getIssueToc(&$articlesByIssue, $objectLocalePrecedence) {
assert(is_array($articlesByIssue));
$toc = '';
foreach($articlesByIssue as $articleInIssue) {
$currentEntry = $this->getPrimaryTranslation($articleInIssue->getTitle(null), $objectLocalePrecedence);
assert(!empty($currentEntry));
$pages = $articleInIssue->getPages();
if (!empty($pages)) {
$currentEntry .= '...' . $pages;
}
$toc .= $currentEntry . "<br />";
unset($articleInIssue);
}
return $toc;
}
/**
* Datacite does not allow empty nodes. So we have to
* check nodes before we add them.
* @param $parentNode XmlNode|DOMElement
* @param $child XmlNode|DOMElement
*/
function _appendNonMandatoryChild(&$parentNode, &$child) {
if (is_a($child, 'XMLNode')) {
$childChildren = $child->getChildren();
$childEmpty = empty($childChildren);
} else {
$childEmpty = !$child->hasChildNodes();
}
if ($childEmpty) return;
XMLCustomWriter::appendChild($parentNode, $child);
}
}
?>