Combined jump links: configurable linking modes

demiankatz · Jan 8, 2025 · df1ea7a · df1ea7a
1 parent c8537e5
commit df1ea7a
Show file tree

Hide file tree

Showing 8 changed files with 106 additions and 13 deletions.
diff --git a/config/vufind/combined.ini b/config/vufind/combined.ini
@@ -99,6 +99,11 @@ columns = 3
 stack_placement = distributed
 ; Jump links appear above the search results and link to each result module
 ;jump_links = true
+; If jump_links is true, this setting can control what types of links are used:
+; 'anchor' will create anchor links that jump to the matching column on the page
+; 'link' will link directly to the expanded search results
+; The default is 'anchor'
+;jump_links_mode = anchor
 
 [Solr]
 label = Catalog

diff --git a/module/VuFind/tests/integration-tests/src/VuFindTest/Mink/CombinedSearchTest.php b/module/VuFind/tests/integration-tests/src/VuFindTest/Mink/CombinedSearchTest.php
@@ -239,16 +239,34 @@ public function testCombinedSearchResultsMixedAjax(): void
         $this->assertResultsForDefaultQuery($page);
     }
 
+    /**
+     * Data provider for testJumpMenu()
+     *
+     * @return array[]
+     */
+    public static function jumpMenuProvider(): array
+    {
+        return [
+            'anchor mode' => ['anchor'],
+            'link mode' => ['link'],
+        ];
+    }
+
     /**
      * Test that the jump menu can be enabled.
      *
+     * @param string $linkMode Linking mode to activate
+     *
      * @return void
+     *
+     * @dataProvider jumpMenuProvider
      */
-    public function testJumpMenu(): void
+    public function testJumpMenu(string $linkMode): void
     {
         $config = $this->getCombinedIniOverrides();
         $config['Solr:one']['ajax'] = true; // use mixed AJAX mode for more thorough test
         $config['Layout']['jump_links'] = true;
+        $config['Layout']['jump_links_mode'] = $linkMode;
         $this->changeConfigs(
             ['combined' => $config],
             ['combined']
@@ -262,6 +280,18 @@ public function testJumpMenu(): void
             $expectedContent,
             $this->findCssAndGetText($page, '.combined-jump-links')
         );
+        $firstLink = $this->findCss($page, '.combined-jump-links a')->getAttribute('href');
+        $secondLink = $this->findCss($page, '.combined-jump-links a', index: 1)->getAttribute('href');
+        $expectedFirstLink = $linkMode === 'anchor'
+            ? '#combined_Solr____one'
+            : '/Search/Results?hiddenFilters%5B%5D=building%3A%22journals.mrc%22&lookfor=id%3A%22testsample1%22'
+                . '+OR+id%3A%22theplus%2Bandtheminus-%22&type=AllFields';
+        $expectedSecondLink = $linkMode === 'anchor'
+            ? '#combined_Solr____two'
+            : '/Search/Results?hiddenFilters%5B%5D=building%3A%22weird_ids.mrc%22&lookfor=id%3A%22testsample1%22'
+                . '+OR+id%3A%22theplus%2Bandtheminus-%22&type=AllFields';
+        $this->assertStringEndsWith($expectedFirstLink, $firstLink);
+        $this->assertStringEndsWith($expectedSecondLink, $secondLink);
     }
 
     /**

diff --git a/themes/bootstrap3/templates/combined/jump-links.phtml b/themes/bootstrap3/templates/combined/jump-links.phtml
@@ -2,8 +2,24 @@
   <span><?=$this->translate('combined_jump_links_intro')?></span>
   <ul>
     <?php foreach ($combinedResults as $section) : ?>
+      <?php
+        // If we're in link mode, try to directly link to results, but fail back to the anchor if we don't
+        // have access to results, or if the results object is "combined" (indicating we're in AJAX mode
+        // and don't have results yet):
+        if (
+          ($mode ?? 'anchor') === 'link'
+          && ($results = $section['view']->results ?? null)
+          && !($results instanceof \VuFind\Search\Combined\Results)
+        ) {
+          $params = $results->getParams();
+          $lookfor = $results->getUrlQuery()->isQuerySuppressed() ? '' : $params->getDisplayQuery();
+          $href = $this->url($params->getOptions()->getSearchAction()) . $results->getUrlQuery()->setPage(1)->setLimit($params->getOptions()->getDefaultLimit());
+        } else {
+          $href = '#' . $section['domId'];
+        }
+      ?>
       <li class="<?= $this->escapeHtmlAttr($section['domId']) ?>">
-        <a href="#<?= $this->escapeHtmlAttr($section['domId']) ?>"><?= $this->transEsc($section['label']) ?></a>
+        <a href="<?= $this->escapeHtmlAttr($href) ?>" data-link-mode="<?= $this->escapeHtmlAttr($mode) ?>"><?= $this->transEsc($section['label']) ?></a>
       </li>
     <?php endforeach; ?>
   </ul>

diff --git a/themes/bootstrap3/templates/combined/results-list.phtml b/themes/bootstrap3/templates/combined/results-list.phtml
@@ -45,19 +45,24 @@
 
   // Update result counts in jump links
   $classId = $this->escapeHtml($domId ?? 'combined_' . $searchClassId);
+  $jsMoreUrl = $this->escapeJs(html_entity_decode($moreUrl));
   $countsJs = <<<JS
       function updateJumpLink_$classId() {
         const combinedJumpLinks = document.querySelector('.combined-jump-links');
-        const link = combinedJumpLinks?.querySelector('.$classId');
-        if (link) {
+        const linkContainer = combinedJumpLinks?.querySelector('.$classId');
+        if (linkContainer) {
           let count = $recordTotal;
           count = count.toLocaleString();
           const spanText = document.createTextNode('(' + count + ')');
           const totalSpan = document.createElement('span');
           totalSpan.className = 'record-total';
           totalSpan.append(spanText);
-          link.append(totalSpan);
-          link.style.display = "inline";
+          linkContainer.append(totalSpan);
+          linkContainer.style.display = "inline";
+          const link = linkContainer.querySelector('a');
+          if (link.dataset.linkMode === 'link') {
+            link.href = "$jsMoreUrl";
+          };
           combinedJumpLinks.style.visibility = "inherit";
         }
       }

diff --git a/themes/bootstrap3/templates/combined/results.phtml b/themes/bootstrap3/templates/combined/results.phtml
@@ -54,7 +54,15 @@
   </div>
 <?php endif; ?>
 <?php if ($config['Layout']['jump_links'] ?? false): ?>
-  <?=$this->render('combined/jump-links.phtml', ['combinedResults' => $this->combinedResults])?>
+  <?=
+    $this->render(
+        'combined/jump-links.phtml',
+        [
+        'combinedResults' => $this->combinedResults,
+        'mode' => $config['Layout']['jump_links_mode'] ?? 'anchor',
+      ]
+    )
+  ?>
 <?php endif; ?>
 <form id="search-cart-form" class="form-inline" method="post" name="bulkActionForm" action="<?=$this->url('cart-searchresultsbulk')?>">
   <?=$this->context($this)->renderInContext('search/bulk-action-buttons.phtml', ['idPrefix' => ''])?>

diff --git a/themes/bootstrap5/templates/combined/jump-links.phtml b/themes/bootstrap5/templates/combined/jump-links.phtml
@@ -2,8 +2,24 @@
   <span><?=$this->translate('combined_jump_links_intro')?></span>
   <ul>
     <?php foreach ($combinedResults as $section) : ?>
+      <?php
+        // If we're in link mode, try to directly link to results, but fail back to the anchor if we don't
+        // have access to results, or if the results object is "combined" (indicating we're in AJAX mode
+        // and don't have results yet):
+        if (
+          ($mode ?? 'anchor') === 'link'
+          && ($results = $section['view']->results ?? null)
+          && !($results instanceof \VuFind\Search\Combined\Results)
+        ) {
+          $params = $results->getParams();
+          $lookfor = $results->getUrlQuery()->isQuerySuppressed() ? '' : $params->getDisplayQuery();
+          $href = $this->url($params->getOptions()->getSearchAction()) . $results->getUrlQuery()->setPage(1)->setLimit($params->getOptions()->getDefaultLimit());
+        } else {
+          $href = '#' . $section['domId'];
+        }
+      ?>
       <li class="<?= $this->escapeHtmlAttr($section['domId']) ?>">
-        <a href="#<?= $this->escapeHtmlAttr($section['domId']) ?>"><?= $this->transEsc($section['label']) ?></a>
+        <a href="<?= $this->escapeHtmlAttr($href) ?>" data-link-mode="<?= $this->escapeHtmlAttr($mode) ?>"><?= $this->transEsc($section['label']) ?></a>
       </li>
     <?php endforeach; ?>
   </ul>

diff --git a/themes/bootstrap5/templates/combined/results-list.phtml b/themes/bootstrap5/templates/combined/results-list.phtml
@@ -45,19 +45,24 @@
 
   // Update result counts in jump links
   $classId = $this->escapeHtml($domId ?? 'combined_' . $searchClassId);
+  $jsMoreUrl = $this->escapeJs(html_entity_decode($moreUrl));
   $countsJs = <<<JS
       function updateJumpLink_$classId() {
         const combinedJumpLinks = document.querySelector('.combined-jump-links');
-        const link = combinedJumpLinks?.querySelector('.$classId');
-        if (link) {
+        const linkContainer = combinedJumpLinks?.querySelector('.$classId');
+        if (linkContainer) {
           let count = $recordTotal;
           count = count.toLocaleString();
           const spanText = document.createTextNode('(' + count + ')');
           const totalSpan = document.createElement('span');
           totalSpan.className = 'record-total';
           totalSpan.append(spanText);
-          link.append(totalSpan);
-          link.style.display = "inline";
+          linkContainer.append(totalSpan);
+          linkContainer.style.display = "inline";
+          const link = linkContainer.querySelector('a');
+          if (link.dataset.linkMode === 'link') {
+            link.href = "$jsMoreUrl";
+          };
           combinedJumpLinks.style.visibility = "inherit";
         }
       }

diff --git a/themes/bootstrap5/templates/combined/results.phtml b/themes/bootstrap5/templates/combined/results.phtml
@@ -54,7 +54,15 @@
   </div>
 <?php endif; ?>
 <?php if ($config['Layout']['jump_links'] ?? false): ?>
-  <?=$this->render('combined/jump-links.phtml', ['combinedResults' => $this->combinedResults])?>
+  <?=
+    $this->render(
+        'combined/jump-links.phtml',
+        [
+        'combinedResults' => $this->combinedResults,
+        'mode' => $config['Layout']['jump_links_mode'] ?? 'anchor',
+      ]
+    )
+  ?>
 <?php endif; ?>
 <form id="search-cart-form" class="form-inline" method="post" name="bulkActionForm" action="<?=$this->url('cart-searchresultsbulk')?>">
   <?=$this->context($this)->renderInContext('search/bulk-action-buttons.phtml', ['idPrefix' => ''])?>