pkp/pkp-lib#2163 Handle issue and article cover images in entity props.

- Moves coverImage props into OJS service classes. - Delivers full URLs to cover images.
NateWr · Oct 19, 2017 · 63e10ef · 63e10ef
1 parent 42fb1a4
commit 63e10ef
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 2 deletions.
diff --git a/classes/article/Article.inc.php b/classes/article/Article.inc.php
@@ -258,6 +258,30 @@ function getLocalizedCoverImageUrl() {
 
 		return $request->getBaseUrl() . '/' . $publicFileManager->getJournalFilesPath($this->getContextId()) . '/' . $coverImage;
 	}
+
+	/**
+	 * Get full URLs all cover images
+	 *
+	 * @return array
+	 */
+	function getCoverImageUrls() {
+		$coverImages = $this->getCoverImage(null);
+		if (empty($coverImages)) {
+			return array();
+		}
+
+		$request = Application::getRequest();
+		import('classes.file.PublicFileManager');
+		$publicFileManager = new PublicFileManager();
+
+		$urls = array();
+
+		foreach ($coverImages as $locale => $coverImage) {
+			$urls[$locale] = sprintf('%s/%s/%s', $request->getBaseUrl(), $publicFileManager->getJournalFilesPath($this->getJournalId()), $coverImage);
+		}
+
+		return $urls;
+	}
 }
 
 ?>
diff --git a/classes/issue/Issue.inc.php b/classes/issue/Issue.inc.php
@@ -406,6 +406,30 @@ function getLocalizedCoverImageUrl() {
 		return $request->getBaseUrl() . '/' . $publicFileManager->getJournalFilesPath($this->getJournalId()) . '/' . $coverImage;
 	}
 
+	/**
+	 * Get the full URL to all localized cover images
+	 *
+	 * @return array
+	 */
+	function getCoverImageUrls() {
+		$coverImages = $this->getCoverImage(null);
+		if (empty($coverImages)) {
+			return array();
+		}
+
+		$request = Application::getRequest();
+		import('classes.file.PublicFileManager');
+		$publicFileManager = new PublicFileManager();
+
+		$urls = array();
+
+		foreach ($coverImages as $locale => $coverImage) {
+			$urls[$locale] = sprintf('%s/%s/%s', $request->getBaseUrl(), $publicFileManager->getJournalFilesPath($this->getJournalId()), $coverImage);
+		}
+
+		return $urls;
+	}
+
 	/**
 	 * Set issue cover image alternate text
 	 * @param $coverImageAltText string

diff --git a/classes/services/IssueService.inc.php b/classes/services/IssueService.inc.php
@@ -172,7 +172,7 @@ public function getProperties($issue, $props, $args = null) {
 					}
 					break;
 				case 'coverImageUrl':
-					$values[$prop] = $issue->getCoverImage(null);
+					$values[$prop] = $issue->getCoverImageUrls(null);
 					break;
 				case 'coverImageAltText':
 					$values[$prop] = $issue->getCoverImageAltText(null);

diff --git a/classes/services/SubmissionService.inc.php b/classes/services/SubmissionService.inc.php
@@ -126,6 +126,10 @@ public function modifyProperties($hookName, $args) {
 
 		$props[] = 'issueSummary';
 		$props[] = 'sectionSummary';
+		$props[] = 'coverImageUrl';
+		$props[] = 'coverImageAltText';
+
+		return $props;
 	}
 
 	/**
@@ -162,7 +166,6 @@ public function modifyPropertyValues($hookName, $args) {
 
 		$issue = null;
 		if ($publishedArticle) {
-			$articleId = $publishedArticle->getId();
 			$issueDao = \DAORegistry::getDAO('IssueDAO');
 			$issue = $issueDao->getById(
 				$publishedArticle->getIssueId(),
@@ -183,6 +186,12 @@ public function modifyPropertyValues($hookName, $args) {
 						$submission->getBestArticleId()
 					);
 					break;
+				case 'coverImageUrl':
+					$values[$prop] = $submission->getCoverImageUrls(null);
+					break;
+				case 'coverImageAltText':
+					$values[$prop] = $submission->getCoverImageAltText(null);
+					break;
 				case 'issue':
 				case 'issueSummary':
 					$values['issue'] = null;