Refactor IdentifierLinker helper for simplicity.

vufind-org · Jan 14, 2025 · b75e986 · b75e986
1 parent 3e567fd
commit b75e986
Show file tree

Hide file tree

Showing 19 changed files with 85 additions and 108 deletions.
diff --git a/module/VuFind/src/VuFind/View/Helper/Root/IdentifierLinker.php b/module/VuFind/src/VuFind/View/Helper/Root/IdentifierLinker.php
@@ -44,20 +44,6 @@
  */
 class IdentifierLinker extends \Laminas\View\Helper\AbstractHelper
 {
-    /**
-     * Current RecordDriver
-     *
-     * @var RecordDriver
-     */
-    protected RecordDriver $recordDriver;
-
-    /**
-     * Identifier link context ('results', 'record' or 'holdings')
-     *
-     * @var string
-     */
-    protected string $context;
-
     /**
      * Instance counter (used for keeping track of records)
      *
@@ -86,35 +72,35 @@ public function __construct(protected Context $contextHelper, protected array $c
     }
 
     /**
-     * Set up context for helper
+     * Display identifier links (or blank string, if not active).
      *
      * @param RecordDriver $driver  The current record driver
      * @param string       $context Display context ('results', 'record' or 'holdings')
      *
-     * @return static
+     * @return string
      */
-    public function __invoke(RecordDriver $driver, string $context): static
+    public function __invoke(RecordDriver $driver, string $context): string
     {
-        $this->recordDriver = $driver;
-        $this->context = $context;
-        return $this;
+        return $this->isActive($driver, $context) ? $this->renderTemplate($driver) : '';
     }
 
     /**
      * Get all available identifiers.
      *
+     * @param RecordDriver $driver The current record driver
+     *
      * @return array
      */
-    protected function getIdentifiers(): array
+    protected function getIdentifiers(RecordDriver $driver): array
     {
         $ids = [];
-        if (in_array('doi', $this->supportedIdentifiers) && $doi = $this->recordDriver->tryMethod('getCleanDOI')) {
+        if (in_array('doi', $this->supportedIdentifiers) && $doi = $driver->tryMethod('getCleanDOI')) {
             $ids['doi'] = $doi;
         }
-        if (in_array('isbn', $this->supportedIdentifiers) && $isbn = $this->recordDriver->tryMethod('getCleanISBN')) {
+        if (in_array('isbn', $this->supportedIdentifiers) && $isbn = $driver->tryMethod('getCleanISBN')) {
             $ids['isbn'] = $isbn;
         }
-        if (in_array('issn', $this->supportedIdentifiers) && $issn = $this->recordDriver->tryMethod('getCleanISSN')) {
+        if (in_array('issn', $this->supportedIdentifiers) && $issn = $driver->tryMethod('getCleanISSN')) {
             $ids['issn'] = $issn;
         }
         return $ids;
@@ -123,13 +109,15 @@ protected function getIdentifiers(): array
     /**
      * Public method to render the identifier links template
      *
+     * @param RecordDriver $driver The current record driver
+     *
      * @return string
      */
-    public function renderTemplate(): string
+    protected function renderTemplate(RecordDriver $driver): string
     {
         // Build parameters needed to display the control:
         $instance = $this->counter++;
-        $params = $this->getIdentifiers() + compact('instance');
+        $params = $this->getIdentifiers($driver) + compact('instance');
 
         // Render the subtemplate:
         return ($this->contextHelper)($this->getView())
@@ -140,34 +128,39 @@ public function renderTemplate(): string
      * Does the configuration indicate that we should display identifier links in
      * the specified context?
      *
+     * @param string $context Display context ('results', 'record' or 'holdings')
+     *
      * @return bool
      */
-    protected function checkContext(): bool
+    protected function checkContext(string $context): bool
     {
         // Doesn't matter the target context if no resolver is specified:
         if (empty($this->config['resolver'])) {
             return false;
         }
 
         // If a setting exists, return that:
-        $key = 'show_in_' . $this->context;
+        $key = 'show_in_' . $context;
         if (isset($this->config[$key])) {
             return $this->config[$key];
         }
 
         // If we got this far, use the defaults -- true for results, false for
         // everywhere else.
-        return $this->context == 'results';
+        return $context == 'results';
     }
 
     /**
      * Public method to check whether identifier links are active for current record
      *
+     * @param RecordDriver $driver  The current record driver
+     * @param string       $context Display context ('results', 'record' or 'holdings')
+     *
      * @return bool
      */
-    public function isActive(): bool
+    protected function isActive(RecordDriver $driver, string $context): bool
     {
-        $ids = $this->getIdentifiers();
-        return !empty($ids) && $this->checkContext();
+        $ids = $this->getIdentifiers($driver);
+        return !empty($ids) && $this->checkContext($context);
     }
 }
diff --git a/themes/bootstrap3/templates/RecordDriver/DefaultRecord/data-onlineAccess.phtml b/themes/bootstrap3/templates/RecordDriver/DefaultRecord/data-onlineAccess.phtml
@@ -1,8 +1,6 @@
 <?php
   $openUrl = $this->openUrl($this->driver, 'record');
   $openUrlActive = $openUrl->isActive();
-  $identifierLinker = $this->identifierLinker($this->driver, 'record');
-  $identifierLinkerActive = $identifierLinker->isActive();
   // Account for replace_other_urls setting
   $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
 ?>
@@ -12,4 +10,4 @@
 <?php if ($openUrlActive): ?>
   <?=$openUrl->renderTemplate()?><br>
 <?php endif; ?>
-<?php if ($identifierLinkerActive): ?><?=$identifierLinker->renderTemplate()?><?php endif; ?>
+<?=$this->identifierLinker($this->driver, 'record')?>
diff --git a/themes/bootstrap3/templates/RecordDriver/DefaultRecord/list-entry.phtml b/themes/bootstrap3/templates/RecordDriver/DefaultRecord/list-entry.phtml
@@ -160,20 +160,19 @@
              */
             $openUrl = $this->openUrl($this->driver, 'results');
             $openUrlActive = $openUrl->isActive();
-            $identifierLinker = $this->identifierLinker($this->driver, 'results');
-            $identifierLinkerActive = $identifierLinker->isActive();
+            $identifierLinksHtml = $this->identifierLinker($this->driver, 'results');
             // Account for replace_other_urls setting
             $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
           ?>
-          <?php if ($openUrlActive || $identifierLinkerActive || !empty($urls)): ?>
+          <?php if ($openUrlActive || $identifierLinksHtml || !empty($urls)): ?>
             <?php if ($openUrlActive): ?>
               <br>
               <?=$openUrl->renderTemplate()?>
             <?php endif;?>
 
-            <?php if ($identifierLinkerActive): ?>
+            <?php if ($identifierLinksHtml): ?>
               <br>
-              <?=$identifierLinker->renderTemplate()?>
+              <?=$identifierLinksHtml?>
             <?php endif; ?>
 
             <?php $urls = is_array($urls) ? $urls : []; ?>

diff --git a/themes/bootstrap3/templates/RecordDriver/DefaultRecord/result-grid.phtml b/themes/bootstrap3/templates/RecordDriver/DefaultRecord/result-grid.phtml
@@ -5,8 +5,7 @@
 */
 $openUrl = $this->openUrl($this->driver, 'results');
 $openUrlActive = $openUrl->isActive();
-$identifierLinker = $this->identifierLinker($this->driver, 'results');
-$identifierLinkerActive = $identifierLinker->isActive();
+$identifierLinksHtml = $this->identifierLinker($this->driver, 'results');
 // Account for replace_other_urls setting
 $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
 $recordLinker = $this->recordLinker($this->results);
@@ -35,13 +34,13 @@ $showCheckboxes = $this->searchSettings($this->results->getParams())->checkboxes
           <?=$this->record($this->driver)->getTitleHtml(80)?>
         </a>
       </h2>
-      <?php if ($openUrlActive || $identifierLinkerActive || !empty($urls)): ?>
+      <?php if ($openUrlActive || $identifierLinksHtml || !empty($urls)): ?>
         <br><br>
         <?php if ($openUrlActive): ?>
           <?=$openUrl->renderTemplate()?><br>
         <?php endif; ?>
-        <?php if ($identifierLinkerActive): ?>
-          <?=$identifierLinker->renderTemplate()?><br>
+        <?php if ($identifierLinksHtml): ?>
+          <?=$identifierLinksHtml?><br>
         <?php endif; ?>
         <?php foreach (is_array($urls) ? $urls : [] as $current): ?>
           <a href="<?=$this->escapeHtmlAttr($this->proxyUrl($current['url']))?>" class="fulltext" target="new">

diff --git a/themes/bootstrap3/templates/RecordDriver/DefaultRecord/result-list.phtml b/themes/bootstrap3/templates/RecordDriver/DefaultRecord/result-list.phtml
@@ -139,19 +139,18 @@
         // Display an OpenURL link if configured to do so:
         $openUrl = $this->openUrl($this->driver, 'results');
         $openUrlActive = $openUrl->isActive();
-        $identifierLinker = $this->identifierLinker($this->driver, 'results');
-        $identifierLinkerActive = $identifierLinker->isActive();
+        $identifierLinksHtml = $this->identifierLinker($this->driver, 'results');
         // Account for replace_other_urls setting
         $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
       ?>
-      <?php if ($openUrlActive || $identifierLinkerActive || !empty($urls)): ?>
+      <?php if ($openUrlActive || $identifierLinksHtml || !empty($urls)): ?>
         <?php if ($openUrlActive): ?>
           <br>
           <?=$openUrl->renderTemplate()?>
         <?php endif; ?>
-        <?php if ($identifierLinkerActive): ?>
+        <?php if ($identifierLinksHtml): ?>
           <br>
-          <?=$identifierLinker->renderTemplate()?>
+          <?=$identifierLinksHtml?>
         <?php endif; ?>
         <?php $urls = is_array($urls) ? $urls : []; ?>
         <?php if (!$this->driver->isCollection()): ?>

diff --git a/themes/bootstrap3/templates/RecordDriver/EDS/core.phtml b/themes/bootstrap3/templates/RecordDriver/EDS/core.phtml
@@ -162,9 +162,9 @@
       <?php endforeach; ?>
     <?php endif; ?>
 
-    <?php $identifierLinker = $this->identifierLinker($this->driver, 'record'); ?>
-    <?php if ($identifierLinker->isActive()): ?>
-      <div><?=$identifierLinker->renderTemplate()?></div>
+    <?php $identifierLinksHtml = $this->identifierLinker($this->driver, 'record'); ?>
+    <?php if ($identifierLinksHtml): ?>
+      <div><?=$identifierLinksHtml?></div>
     <?php endif; ?>
     </div>
   </div>

diff --git a/themes/bootstrap3/templates/RecordDriver/EDS/result-list.phtml b/themes/bootstrap3/templates/RecordDriver/EDS/result-list.phtml
@@ -111,9 +111,9 @@
       ?>
 
       <?php /* Links from identifier linker */ ?>
-      <?php $identifierLinker = $this->identifierLinker($this->driver, 'results'); ?>
-      <?php if ($identifierLinker->isActive()): ?>
-        <div><?=$identifierLinker->renderTemplate()?></div>
+      <?php $identifierLinksHtml = $this->identifierLinker($this->driver, 'results'); ?>
+      <?php if ($identifierLinksHtml): ?>
+        <div><?=$identifierLinksHtml?></div>
       <?php endif; ?>
     </div>
     <div class="result-links hidden-print">

diff --git a/themes/bootstrap3/templates/RecordDriver/Pazpar2/result-list.phtml b/themes/bootstrap3/templates/RecordDriver/Pazpar2/result-list.phtml
@@ -86,19 +86,18 @@
           */
         $openUrl = $this->openUrl($this->driver, 'results');
         $openUrlActive = $openUrl->isActive();
-        $identifierLinker = $this->identifierLinker($this->driver, 'results');
-        $identifierLinkerActive = $identifierLinker->isActive();
+        $identifierLinksHtml = $this->identifierLinker($this->driver, 'results');
         // Account for replace_other_urls setting
         $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
 
-        if ($openUrlActive || $identifierLinkerActive || !empty($urls)): ?>
+        if ($openUrlActive || $identifierLinksHtml || !empty($urls)): ?>
         <?php if ($openUrlActive): ?>
           <br>
           <?=$openUrl->renderTemplate()?>
         <?php endif; ?>
-        <?php if ($identifierLinkerActive): ?>
+        <?php if ($identifierLinksHtml): ?>
           <br>
-          <?=$identifierLinker->renderTemplate()?>
+          <?=$identifierLinksHtml?>
         <?php endif; ?>
         <?php $urls = is_array($urls) ? $urls : []; ?>
         <?php if (!$this->driver->isCollection()): ?>

diff --git a/themes/bootstrap3/templates/RecordDriver/SolrOverdrive/result-list.phtml b/themes/bootstrap3/templates/RecordDriver/SolrOverdrive/result-list.phtml
@@ -128,19 +128,18 @@
         // Display an OpenURL link if configured to do so:
         $openUrl = $this->openUrl($this->driver, 'results');
         $openUrlActive = $openUrl->isActive();
-        $identifierLinker = $this->identifierLinker($this->driver, 'results');
-        $identifierLinkerActive = $identifierLinker->isActive();
+        $identifierLinksHtml = $this->identifierLinker($this->driver, 'results');
         // Account for replace_other_urls setting
         $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
         ?>
-        <?php if ($openUrlActive || $identifierLinkerActive || !empty($urls)): ?>
+        <?php if ($openUrlActive || $identifierLinksHtml || !empty($urls)): ?>
         <?php if ($openUrlActive): ?>
           <br>
           <?=$openUrl->renderTemplate()?>
         <?php endif; ?>
-        <?php if ($identifierLinkerActive): ?>
+        <?php if ($identifierLinksHtml): ?>
           <br>
-          <?=$identifierLinker->renderTemplate()?>
+          <?=$identifierLinksHtml?>
         <?php endif; ?>
         <?php $urls = is_array($urls) ? $urls : []; ?>
         <?php if (!$this->driver->isCollection()): ?>

diff --git a/themes/bootstrap3/templates/RecordTab/holdingsils.phtml b/themes/bootstrap3/templates/RecordTab/holdingsils.phtml
@@ -4,8 +4,7 @@
     $user = $account->getUserObject();
     $openUrl = $this->openUrl($this->driver, 'holdings');
     $openUrlActive = $openUrl->isActive();
-    $identifierLinker = $this->identifierLinker($this->driver, 'holdings');
-    $identifierLinkerActive = $identifierLinker->isActive();
+    $identifierLinksHtml = $this->identifierLinker($this->driver, 'holdings');
     // Account for replace_other_urls setting
     $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
     $offlineMode = $this->ils()->getOfflineMode();
@@ -62,15 +61,15 @@
     <span class="icon-link__label"><?=$this->transEsc('title_hold_place')?></span>
   </a>
 <?php endif; ?>
-<?php if (!empty($urls) || $openUrlActive || $identifierLinkerActive): ?>
+<?php if (!empty($urls) || $openUrlActive || $identifierLinksHtml): ?>
   <h2><?=$this->transEsc('Internet')?></h2>
   <?php if (!empty($urls)): ?>
     <?php foreach ($urls as $current): ?>
       <a href="<?=$this->escapeHtmlAttr($this->proxyUrl($current['url']))?>"><?=$this->escapeHtml($current['desc'])?></a><br>
     <?php endforeach; ?>
   <?php endif; ?>
   <?php if ($openUrlActive): ?><?=$openUrl->renderTemplate()?><?php endif; ?>
-  <?php if ($identifierLinkerActive): ?><?=$identifierLinker->renderTemplate()?><?php endif; ?>
+  <?=$identifierLinksHtml?>
 <?php endif; ?>
 
 <?php if (!empty($holdings['electronic_holdings'])): ?>

diff --git a/themes/bootstrap5/templates/RecordDriver/DefaultRecord/data-onlineAccess.phtml b/themes/bootstrap5/templates/RecordDriver/DefaultRecord/data-onlineAccess.phtml
@@ -1,8 +1,6 @@
 <?php
   $openUrl = $this->openUrl($this->driver, 'record');
   $openUrlActive = $openUrl->isActive();
-  $identifierLinker = $this->identifierLinker($this->driver, 'record');
-  $identifierLinkerActive = $identifierLinker->isActive();
   // Account for replace_other_urls setting
   $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
 ?>
@@ -12,4 +10,4 @@
 <?php if ($openUrlActive): ?>
   <?=$openUrl->renderTemplate()?><br>
 <?php endif; ?>
-<?php if ($identifierLinkerActive): ?><?=$identifierLinker->renderTemplate()?><?php endif; ?>
+<?=$this->identifierLinker($this->driver, 'record')?>
diff --git a/themes/bootstrap5/templates/RecordDriver/DefaultRecord/list-entry.phtml b/themes/bootstrap5/templates/RecordDriver/DefaultRecord/list-entry.phtml
@@ -160,20 +160,19 @@
              */
             $openUrl = $this->openUrl($this->driver, 'results');
             $openUrlActive = $openUrl->isActive();
-            $identifierLinker = $this->identifierLinker($this->driver, 'results');
-            $identifierLinkerActive = $identifierLinker->isActive();
+            $identifierLinksHtml = $this->identifierLinker($this->driver, 'results');
             // Account for replace_other_urls setting
             $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
           ?>
-          <?php if ($openUrlActive || $identifierLinkerActive || !empty($urls)): ?>
+          <?php if ($openUrlActive || $identifierLinksHtml || !empty($urls)): ?>
             <?php if ($openUrlActive): ?>
               <br>
               <?=$openUrl->renderTemplate()?>
             <?php endif;?>
 
-            <?php if ($identifierLinkerActive): ?>
+            <?php if ($identifierLinksHtml): ?>
               <br>
-              <?=$identifierLinker->renderTemplate()?>
+              <?=$identifierLinksHtml?>
             <?php endif; ?>
 
             <?php $urls = is_array($urls) ? $urls : []; ?>

diff --git a/themes/bootstrap5/templates/RecordDriver/DefaultRecord/result-grid.phtml b/themes/bootstrap5/templates/RecordDriver/DefaultRecord/result-grid.phtml
@@ -5,8 +5,7 @@
 */
 $openUrl = $this->openUrl($this->driver, 'results');
 $openUrlActive = $openUrl->isActive();
-$identifierLinker = $this->identifierLinker($this->driver, 'results');
-$identifierLinkerActive = $identifierLinker->isActive();
+$identifierLinksHtml = $this->identifierLinker($this->driver, 'results');
 // Account for replace_other_urls setting
 $urls = $this->record($this->driver)->getLinkDetails($openUrlActive);
 $recordLinker = $this->recordLinker($this->results);
@@ -35,13 +34,13 @@ $showCheckboxes = $this->searchSettings($this->results->getParams())->checkboxes
           <?=$this->record($this->driver)->getTitleHtml(80)?>
         </a>
       </h2>
-      <?php if ($openUrlActive || $identifierLinkerActive || !empty($urls)): ?>
+      <?php if ($openUrlActive || $identifierLinksHtml || !empty($urls)): ?>
         <br><br>
         <?php if ($openUrlActive): ?>
           <?=$openUrl->renderTemplate()?><br>
         <?php endif; ?>
-        <?php if ($identifierLinkerActive): ?>
-          <?=$identifierLinker->renderTemplate()?><br>
+        <?php if ($identifierLinksHtml): ?>
+          <?=$identifierLinksHtml?><br>
         <?php endif; ?>
         <?php foreach (is_array($urls) ? $urls : [] as $current): ?>
           <a href="<?=$this->escapeHtmlAttr($this->proxyUrl($current['url']))?>" class="fulltext" target="new">