From b56b0520e20e9d850514aa9cf1d5384730bfffa5 Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Tue, 17 Jul 2012 11:47:43 -0400
Subject: [PATCH] Adjusted getThumbnail() to return an array of cover generator
parameters instead of building a cover generator URL -- this eliminates some
ugly dependencies at the cost of requiring a new view helper to properly
render getThumbnail() output.
---
.../src/VuFind/RecordDriver/SolrDefault.php | 17 +++++------
.../src/VuFind/RecordDriver/SolrVudl.php | 10 ++++---
.../VuFind/src/VuFind/RecordDriver/Summon.php | 23 +++++++--------
.../src/VuFind/Theme/Root/Helper/Record.php | 28 +++++++++++++++++++
.../RecordDriver/SolrDefault/core.phtml | 2 +-
.../RecordDriver/SolrDefault/list-entry.phtml | 2 +-
.../SolrDefault/result-grid.phtml | 4 +--
.../SolrDefault/result-list.phtml | 2 +-
.../ajax/result-google-map-info.phtml | 2 +-
.../templates/myresearch/checkedout.phtml | 2 +-
.../templates/myresearch/holds.phtml | 2 +-
.../RecordDriver/SolrDefault/core.phtml | 2 +-
12 files changed, 60 insertions(+), 36 deletions(-)
diff --git a/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php b/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php
index e1567dffd60..328afd9496a 100644
--- a/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php
+++ b/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php
@@ -959,24 +959,21 @@ class SolrDefault extends AbstractBase
}
/**
- * Return a URL to a thumbnail preview of the record, if available; false
- * otherwise.
+ * Returns one of three things: a full URL to a thumbnail preview of the record
+ * if an image is available in an external system; an array of parameters to
+ * send to VuFind's internal cover generator if no fixed URL exists; or false
+ * if no thumbnail can be generated.
*
- * @param array $size Size of thumbnail (small, medium or large -- small is
+ * @param string $size Size of thumbnail (small, medium or large -- small is
* default).
*
- * @return string|bool
+ * @return string|array|bool
*/
public function getThumbnail($size = 'small')
{
- /* TODO
if ($isbn = $this->getCleanISBN()) {
- $frontController = Zend_Controller_Front::getInstance();
- return $frontController->getBaseUrl() . '/Cover/Show?isn=' .
- urlencode($isbn) . '&size=' . urlencode($size);
+ return array('isn' => $isbn, 'size' => $size);
}
- */
-
return false;
}
diff --git a/module/VuFind/src/VuFind/RecordDriver/SolrVudl.php b/module/VuFind/src/VuFind/RecordDriver/SolrVudl.php
index 572f0c38092..8c67016c549 100644
--- a/module/VuFind/src/VuFind/RecordDriver/SolrVudl.php
+++ b/module/VuFind/src/VuFind/RecordDriver/SolrVudl.php
@@ -55,13 +55,15 @@ class SolrVudl extends SolrDefault
}
/**
- * Return a URL to a thumbnail preview of the record, if available; false
- * otherwise.
+ * Returns one of three things: a full URL to a thumbnail preview of the record
+ * if an image is available in an external system; an array of parameters to
+ * send to VuFind's internal cover generator if no fixed URL exists; or false
+ * if no thumbnail can be generated.
*
- * @param array $size Size of thumbnail (small, medium or large -- small is
+ * @param string $size Size of thumbnail (small, medium or large -- small is
* default).
*
- * @return string|bool
+ * @return string|array|bool
*/
public function getThumbnail($size = 'small')
{
diff --git a/module/VuFind/src/VuFind/RecordDriver/Summon.php b/module/VuFind/src/VuFind/RecordDriver/Summon.php
index 563127ab336..1117498ad8e 100644
--- a/module/VuFind/src/VuFind/RecordDriver/Summon.php
+++ b/module/VuFind/src/VuFind/RecordDriver/Summon.php
@@ -406,32 +406,29 @@ class Summon extends SolrDefault
}
/**
- * Return a URL to a thumbnail preview of the record, if available; false
- * otherwise.
+ * Returns one of three things: a full URL to a thumbnail preview of the record
+ * if an image is available in an external system; an array of parameters to
+ * send to VuFind's internal cover generator if no fixed URL exists; or false
+ * if no thumbnail can be generated.
*
- * @param array $size Size of thumbnail (small, medium or large -- small is
+ * @param string $size Size of thumbnail (small, medium or large -- small is
* default).
*
- * @return string|bool
+ * @return string|array|bool
*/
public function getThumbnail($size = 'small')
{
- /* TODO
$formats = $this->getFormats();
if ($isbn = $this->getCleanISBN() || !empty($formats)) {
- $frontController = Zend_Controller_Front::getInstance();
- $url = $frontController->getBaseUrl() . '/Cover/Show?';
- $params = array('size=' . urlencode($size));
+ $params = array('size' => $size);
if ($isbn) {
- $params[] = 'isn=' . urlencode($isbn);
+ $params['isn'] = $isbn;
}
if (!empty($formats)) {
- $params[] = 'contenttype=' . urlencode($formats[0]);
+ $params['contenttype'] = $formats[0];
}
- return $url . implode('&', $params);
+ return $params;
}
- */
-
return false;
}
diff --git a/module/VuFind/src/VuFind/Theme/Root/Helper/Record.php b/module/VuFind/src/VuFind/Theme/Root/Helper/Record.php
index 662d593afb8..26a0f31daca 100644
--- a/module/VuFind/src/VuFind/Theme/Root/Helper/Record.php
+++ b/module/VuFind/src/VuFind/Theme/Root/Helper/Record.php
@@ -306,4 +306,32 @@ class Record extends AbstractHelper
'record/checkbox.phtml', $context
);
}
+
+ /**
+ * Generate a thumbnail URL (return false if unsupported).
+ *
+ * @param string $size Size of thumbnail (small, medium or large -- small is
+ * default).
+ *
+ * @return string|bool
+ */
+ public function getThumbnail($size = 'small')
+ {
+ // Try to build thumbnail:
+ $thumb = $this->driver->tryMethod('getThumbnail', array($size));
+
+ // No thumbnail? Return false:
+ if (empty($thumb)) {
+ return false;
+ }
+
+ // Array? It's parameters to send to the cover generator:
+ if (is_array($thumb)) {
+ $urlHelper = $this->getView()->plugin('url');
+ return $urlHelper('cover-show') . '?' . http_build_query($thumb);
+ }
+
+ // Default case -- return fixed string:
+ return $thumb;
+ }
}
\ No newline at end of file
diff --git a/themes/blueprint/templates/RecordDriver/SolrDefault/core.phtml b/themes/blueprint/templates/RecordDriver/SolrDefault/core.phtml
index 316cd456f13..b5581e64dc4 100644
--- a/themes/blueprint/templates/RecordDriver/SolrDefault/core.phtml
+++ b/themes/blueprint/templates/RecordDriver/SolrDefault/core.phtml
@@ -209,7 +209,7 @@
<div class="span-4 last">
<? /* Display thumbnail if appropriate: */ ?>
- <? $mediumThumb = $this->driver->getThumbnail('medium'); $largeThumb = $this->driver->getThumbnail('large'); ?>
+ <? $mediumThumb = $this->record($this->driver)->getThumbnail('medium'); $largeThumb = $this->record($this->driver)->getThumbnail('large'); ?>
<? if ($mediumThumb): ?>
<? if ($largeThumb): ?><a href="<?=$this->escapeHtml($largeThumb)?>"><? endif; ?>
<img alt="<?=$this->transEsc('Cover Image')?>" class="recordcover" src="<?=$this->escapeHtml($mediumThumb);?>"/>
diff --git a/themes/blueprint/templates/RecordDriver/SolrDefault/list-entry.phtml b/themes/blueprint/templates/RecordDriver/SolrDefault/list-entry.phtml
index e140ef99227..0cf68bcdcd6 100644
--- a/themes/blueprint/templates/RecordDriver/SolrDefault/list-entry.phtml
+++ b/themes/blueprint/templates/RecordDriver/SolrDefault/list-entry.phtml
@@ -12,7 +12,7 @@
?>
<div class="listentry recordId source<?=$this->escapeHtml($source)?>" id="record<?=$this->escapeHtml($id)?>">
<div class="span-2">
- <? if ($listThumb = $this->driver->getThumbnail()): ?>
+ <? if ($listThumb = $this->record($this->driver)->getThumbnail()): ?>
<img src="<?=$this->escapeHtml($listThumb)?>" class="summcover" alt="<?=$this->transEsc('Cover Image')?>"/>
<? else: ?>
<img src="<?=$this->url('cover-unavailable')?>" class="summcover" alt="<?=$this->transEsc('No Cover Image')?>"/>
diff --git a/themes/blueprint/templates/RecordDriver/SolrDefault/result-grid.phtml b/themes/blueprint/templates/RecordDriver/SolrDefault/result-grid.phtml
index 586884f6d90..0570b2ead56 100644
--- a/themes/blueprint/templates/RecordDriver/SolrDefault/result-grid.phtml
+++ b/themes/blueprint/templates/RecordDriver/SolrDefault/result-grid.phtml
@@ -2,9 +2,9 @@
<input type="hidden" value="<?=$this->escapeHtml($this->driver->getUniqueID())?>" class="hiddenId" />
<span class="gridImageBox">
<a href="<?=$this->recordLink()->getUrl($this->driver)?>">
- <? if ($summThumb = $this->driver->getThumbnail('large')): ?>
+ <? if ($summThumb = $this->record($this->driver)->getThumbnail('large')): ?>
<img src="<?=$this->escapeHtml($summThumb)?>" class="gridImage" alt="<?=$this->transEsc('Cover Image')?>"/>
- <? elseif ($summThumb = $this->driver->getThumbnail()): ?>
+ <? elseif ($summThumb = $this->record($this->driver)->getThumbnail()): ?>
<img src="<?=$this->escapeHtml($summThumb)?>" class="gridImage" alt="<?=$this->transEsc('Cover Image')?>"/>
<? else: ?>
<img src="<?=$this->url('cover-unavailable')?>" class="gridImage" alt="<?=$this->transEsc('No Cover Image')?>"/>
diff --git a/themes/blueprint/templates/RecordDriver/SolrDefault/result-list.phtml b/themes/blueprint/templates/RecordDriver/SolrDefault/result-list.phtml
index 5f00940f1dd..784c1a5bfd2 100644
--- a/themes/blueprint/templates/RecordDriver/SolrDefault/result-list.phtml
+++ b/themes/blueprint/templates/RecordDriver/SolrDefault/result-list.phtml
@@ -1,7 +1,7 @@
<div class="result source<?=$this->escapeHtml($this->driver->getResourceSource())?> recordId<?=$this->driver->supportsAjaxStatus()?' ajaxItemId':''?>">
<input type="hidden" value="<?=$this->escapeHtml($this->driver->getUniqueID())?>" class="hiddenId" />
<div class="span-2">
- <? if ($summThumb = $this->driver->getThumbnail()): ?>
+ <? if ($summThumb = $this->record($this->driver)->getThumbnail()): ?>
<img src="<?=$this->escapeHtml($summThumb)?>" class="summcover" alt="<?=$this->transEsc('Cover Image')?>"/>
<? else: ?>
<img src="<?=$this->url('cover-unavailable')?>" class="summcover" alt="<?=$this->transEsc('No Cover Image')?>"/>
diff --git a/themes/blueprint/templates/ajax/result-google-map-info.phtml b/themes/blueprint/templates/ajax/result-google-map-info.phtml
index 353c3a40785..aee2f171523 100644
--- a/themes/blueprint/templates/ajax/result-google-map-info.phtml
+++ b/themes/blueprint/templates/ajax/result-google-map-info.phtml
@@ -6,7 +6,7 @@
<? $i++; ?>
<div class="mapInfoResult <? if ($i % 2 == 0): ?>alt <? endif; ?>record<?=$i ?>">
<div class="mapInfoResultThumb">
- <? if ($record->getThumbnail()): ?><img class="mapInfoResultThumbImg" src="<?=$this->escapeHtml($record->getThumbnail()) ?>" style="display:block"/><? endif; ?>
+ <? if ($thumb = $this->record($record)->getThumbnail()): ?><img class="mapInfoResultThumbImg" src="<?=$this->escapeHtml($thumb) ?>" style="display:block"/><? endif; ?>
</div>
<div class="mapInfoResultText">
diff --git a/themes/blueprint/templates/myresearch/checkedout.phtml b/themes/blueprint/templates/myresearch/checkedout.phtml
index 974ca392f2d..e4152da5190 100644
--- a/themes/blueprint/templates/myresearch/checkedout.phtml
+++ b/themes/blueprint/templates/myresearch/checkedout.phtml
@@ -37,7 +37,7 @@
<? endif; ?>
<div id="record<?=$this->escapeHtml($resource->getUniqueId())?>">
<div class="span-2">
- <? if ($summThumb = $resource->getThumbnail()): ?>
+ <? if ($summThumb = $this->record($resource)->getThumbnail()): ?>
<img src="<?=$this->escapeHtml($summThumb)?>" class="summcover" alt="<?=$this->transEsc('Cover Image')?>"/>
<? else: ?>
<img src="<?=$this->url('cover-unavailable')?>" class="summcover" alt="<?=$this->transEsc('No Cover Image')?>"/>
diff --git a/themes/blueprint/templates/myresearch/holds.phtml b/themes/blueprint/templates/myresearch/holds.phtml
index 7b9c528da14..549e939ac25 100644
--- a/themes/blueprint/templates/myresearch/holds.phtml
+++ b/themes/blueprint/templates/myresearch/holds.phtml
@@ -38,7 +38,7 @@
<? endif; ?>
<div id="record<?=$this->escapeHtml($resource->getUniqueId()) ?>">
<div class="span-2">
- <? if ($summThumb = $resource->getThumbnail()): ?>
+ <? if ($summThumb = $this->record($resource)->getThumbnail()): ?>
<img src="<?=$this->escapeHtml($summThumb)?>" class="summcover" alt="<?=$this->transEsc('Cover Image')?>"/>
<? else: ?>
<img src="<?=$this->url('cover-unavailable')?>" class="summcover" alt="<?=$this->transEsc('No Cover Image')?>"/>
diff --git a/themes/jquerymobile/templates/RecordDriver/SolrDefault/core.phtml b/themes/jquerymobile/templates/RecordDriver/SolrDefault/core.phtml
index 709e438fc31..203d5856fc7 100644
--- a/themes/jquerymobile/templates/RecordDriver/SolrDefault/core.phtml
+++ b/themes/jquerymobile/templates/RecordDriver/SolrDefault/core.phtml
@@ -1,5 +1,5 @@
<? /* Display thumbnail if appropriate: */ ?>
-<? $mediumThumb = $this->driver->getThumbnail('medium'); $largeThumb = $this->driver->getThumbnail('large'); ?>
+<? $mediumThumb = $this->record($this->driver)->getThumbnail('medium'); $largeThumb = $this->record($this->driver)->getThumbnail('large'); ?>
<? if ($mediumThumb): ?>
<? if ($largeThumb): ?><a rel="external" href="<?=$this->escapeHtml($largeThumb)?>"><? endif; ?>
<div class="recordcover">
--
GitLab