Get unique html element id from record view helper

module/VuFind/src/VuFind/View/Helper/Root/Record.php

@@ -560,10 +560,11 @@ public function getSearchResult($view)
      */
     public function getCheckbox($idPrefix = '', $formAttr = false, $number = null)
     {
-        $id = $this->driver->getSourceIdentifier() . '|'
-            . $this->driver->getUniqueId();
-        $context
-            = ['id' => $id, 'number' => $number, 'prefix' => $idPrefix];
+        $context = compact('number') + [
+            'id' => $this->getUniqueIdWithSourcePrefix(),
+            'checkboxElementId' => $this->getUniqueHtmlElementId($idPrefix),
+            'prefix' => $idPrefix,
+        ];
         if ($formAttr) {
             $context['formAttr'] = $formAttr;
         }
@@ -857,4 +858,36 @@ protected function deduplicateLinks($links)
     {
         return array_values(array_unique($links, SORT_REGULAR));
     }
+
+    /**
+     * Get the source identifier + unique id of the record without spaces
+     *
+     * @param string $idPrefix Prefix for HTML ids
+     *
+     * @return string
+     */
+    public function getUniqueHtmlElementId($idPrefix = '')
+    {
+        return preg_replace(
+            "/\s+/",
+            '_',
+            ($idPrefix ? $idPrefix . '-' : '')
+            . $this->driver->getResultSetIdentifier() . '-'
+            . $this->driver->getUniqueId()
+        );
+    }
+
+    /**
+     * Get the source identifier + unique id of the record
+     *
+     * @return string
+     */
+    public function getUniqueIdWithSourcePrefix()
+    {
+        if ($this->driver) {
+            return "{$this->driver->getSourceIdentifier()}"
+                . "|{$this->driver->getUniqueId()}";
+        }
+        throw new \Exception('No record driver found.');
+    }
 }

module/VuFind/tests/unit-tests/src/VuFindTest/View/Helper/Root/RecordTest.php

@@ -389,32 +389,74 @@ public function testGetLink(
      */
     public function testGetCheckbox(): void
     {
+        $driver = $this->loadRecordFixture('testbug1.json');
+        $tpl = 'record/checkbox.phtml';
         $context = $this->getMockContext();
-        $this->expectConsecutiveCalls(
-            $context,
-            'renderInContext',
+        $randomIdentifier = 'baz';
+        $driver->setResultSetIdentifier($randomIdentifier);
+
+        $expectedCalls = [
             [
+                $tpl,
                 [
-                    'record/checkbox.phtml',
-                    ['id' => 'Solr|000105196', 'number' => 1, 'prefix' => 'bar', 'formAttr' => 'foo'],
+                    'number' => 1,
+                    'id' => 'Solr|000105196',
+                    'checkboxElementId' => "bar-{$randomIdentifier}-000105196",
+                    'prefix' => 'bar',
+                    'formAttr' => 'foo',
                 ],
+            ],
+            [
+                $tpl,
                 [
-                    'record/checkbox.phtml',
-                    ['id' => 'Solr|000105196', 'number' => 2, 'prefix' => 'bar', 'formAttr' => 'foo'],
+                    'number' => 2,
+                    'id' => 'Solr|000105196',
+                    'checkboxElementId' => "bar-{$randomIdentifier}-000105196",
+                    'prefix' => 'bar',
+                    'formAttr' => 'foo',
                 ],
             ],
-            'success'
-        );
-        $record = $this->getRecord(
-            $this->loadRecordFixture('testbug1.json'),
-            [],
-            $context
+        ];
+
+        $this->expectConsecutiveCalls(
+            $context,
+            'renderInContext',
+            $expectedCalls,
+            ['success', 'success']
         );
+
+        $record = $this->getRecord($driver, [], $context);
+
         // We run the test twice to ensure that checkbox incrementing works properly:
         $this->assertEquals('success', $record->getCheckbox('bar', 'foo', 1));
         $this->assertEquals('success', $record->getCheckbox('bar', 'foo', 2));
     }
 
+    /**
+     * Test getUniqueHtmlElementId.
+     *
+     * @return void
+     */
+    public function testGetUniqueHtmlElementId()
+    {
+        $driver = $this->loadRecordFixture('testbug1.json');
+        $record = $this->getRecord($driver);
+        $randomIdentifier = 'bar';
+        $driver->setResultSetIdentifier($randomIdentifier);
+
+        // with prefix
+        $this->assertEquals(
+            "testPrefix-{$randomIdentifier}-000105196",
+            $record->getUniqueHtmlElementId('testPrefix')
+        );
+
+        // without prefix
+        $this->assertEquals(
+            "{$randomIdentifier}-000105196",
+            $record->getUniqueHtmlElementId()
+        );
+    }
+
     /**
      * Test getTab.
      *

module/VuFindSearch/src/VuFindSearch/Backend/AbstractBackend.php

@@ -30,9 +30,12 @@
 namespace VuFindSearch\Backend;
 
 use Laminas\Log\LoggerAwareInterface;
+use Laminas\Math\Rand;
 use VuFindSearch\Response\RecordCollectionFactoryInterface;
 use VuFindSearch\Response\RecordCollectionInterface;
 
+use function sprintf;
+
 /**
  * Abstract backend.
  *
@@ -53,6 +56,13 @@ abstract class AbstractBackend implements BackendInterface, LoggerAwareInterface
      */
     protected $collectionFactory = null;
 
+    /**
+     * Record collection.
+     *
+     * @var RecordCollectionInterface|null
+     */
+    protected $recordCollection = null;
+
     /**
      * Backend identifier.
      *
@@ -116,6 +126,39 @@ abstract public function getRecordCollectionFactory();
     protected function injectSourceIdentifier(RecordCollectionInterface $response)
     {
         $response->setSourceIdentifiers($this->identifier);
+        $response->setResultSetIdentifier($this->generateUuid());
+
         return $response;
     }
+
+    /**
+     * Sets the result set identifier for the record collection.
+     *
+     * @param string $uuid A valid UUID associated with the data set.
+     *
+     * @return void
+     */
+    public function setResultSetIdentifier(string $uuid)
+    {
+        $this->recordCollection->setResultSetIdentifier($uuid);
+    }
+
+    /**
+     * Generates a shorter UUID-like identifier.
+     *
+     * This method uses Laminas\Math\Rand to generate cryptographically secure random bytes
+     * and formats them into a shorter identifier.
+     *
+     * @return string A randomly generated shorter UUID-like identifier.
+     */
+    public function generateUuid(): string
+    {
+        $data = bin2hex(Rand::getBytes(8));
+        return sprintf(
+            '%08s-%04s-%04s',
+            substr($data, 0, 8),
+            substr($data, 8, 4),
+            substr($data, 12, 4)
+        );
+    }
 }

module/VuFindSearch/src/VuFindSearch/Response/AbstractRecordCollection.php

@@ -297,4 +297,21 @@ public function count(): int
     {
         return count($this->records);
     }
+
+    /**
+     * Sets the result set identifier for all records in the collection.
+     *
+     * This method assigns a given UUID to each record in the collection by calling
+     * the `setResultSetIdentifier` method on each record.
+     *
+     * @param string $uuid A valid UUID to be assigned to each record in the collection.
+     *
+     * @return void
+     */
+    public function setResultSetIdentifier(string $uuid)
+    {
+        foreach ($this->records as $record) {
+            $record->setResultSetIdentifier($uuid);
+        }
+    }
 }

module/VuFindSearch/src/VuFindSearch/Response/RecordCollectionInterface.php

@@ -117,6 +117,17 @@ public function setSourceIdentifiers($identifier, $searchBackendId = '');
      */
     public function getSourceIdentifier();
 
+    /**
+     * Sets the result set identifier for the record.
+     *
+     * This method assigns a UUID or a unique string identifier to the result set.
+     *
+     * @param string $uuid A valid UUID or unique identifier to be assigned to the result set.
+     *
+     * @return void
+     */
+    public function setResultSetIdentifier(string $uuid);
+
     /**
      * Add a record to the collection.
      *

module/VuFindSearch/src/VuFindSearch/Response/RecordInterface.php

@@ -78,6 +78,25 @@ public function getSourceIdentifier();
      */
     public function getSearchBackendIdentifier();
 
+    /**
+     * Sets the result set identifier for the record collection.
+     *
+     * @param string $uuid A valid UUID associated with the data set.
+     *
+     * @return void
+     */
+    public function setResultSetIdentifier(string $uuid);
+
+    /**
+     * Retrieves the unique result set identifier.
+     *
+     * This method returns the UUID or similar identifier associated with the result set.
+     * If no identifier has been set, it will return null.
+     *
+     * @return string|null The UUID of the result set, or null if not set.
+     */
+    public function getResultSetIdentifier();
+
     /**
      * Add a label for the record
      *

module/VuFindSearch/src/VuFindSearch/Response/RecordTrait.php

@@ -47,6 +47,16 @@ trait RecordTrait
      */
     protected $sourceIdentifier = '';
 
+    /**
+     * The unique identifier for the result set.
+     *
+     * This property stores a UUID or similar identifier that uniquely identifies
+     * the result set. It is typically set by calling the `setResultSetIdentifier` method.
+     *
+     * @var string|null
+     */
+    protected $resultSetIdentifier;
+
     /**
      * Used for identifying the search backend used to find the record
      *
@@ -110,6 +120,33 @@ public function getSearchBackendIdentifier()
         return $this->searchBackendIdentifier;
     }
 
+    /**
+     * Sets the unique result set identifier.
+     *
+     * This method assigns a UUID or similar identifier to the result set.
+     *
+     * @param string $uuid A valid UUID or identifier to assign to the result set.
+     *
+     * @return void
+     */
+    public function setResultSetIdentifier(string $uuid)
+    {
+        $this->resultSetIdentifier = $uuid;
+    }
+
+    /**
+     * Retrieves the unique result set identifier.
+     *
+     * This method returns the UUID or similar identifier associated with the result set.
+     * If no identifier has been set, it will return null.
+     *
+     * @return string|null The UUID of the result set, or null if not set.
+     */
+    public function getResultSetIdentifier(): ?string
+    {
+        return $this->resultSetIdentifier;
+    }
+
     /**
      * Add a label for the record
      *

themes/bootstrap3/templates/record/checkbox.phtml

@@ -1,5 +1,5 @@
 <label class="record-checkbox hidden-print">
-  <input class="checkbox-select-item" type="checkbox" name="ids[]" value="<?=$this->escapeHtmlAttr($this->id) ?>"<?php if (isset($this->formAttr)): ?> form="<?=$this->formAttr ?>"<?php endif; ?> aria-label="<?=$this->transEscAttr('select_item')?>">
+  <input class="checkbox-select-item" type="checkbox" name="ids[]" value="<?=$this->escapeHtmlAttr($this->id) ?>"<?php if (isset($this->formAttr)): ?> form="<?=$this->formAttr ?>"<?php endif; ?><?php if (isset($this->checkboxElementId)): ?> aria-describedby="<?=$this->escapeHtmlAttr($this->checkboxElementId) ?>"<?php endif; ?> aria-label="<?=$this->transEscAttr('select_item')?>">
   <span class="checkbox-icon"></span>
   <?php if (strlen($this->number ?? '') > 0): ?><span class="sr-only"><?=$this->transEsc('result_checkbox_label', ['%%number%%' => $this->number]) ?></span><?php endif; ?>
 </label>

themes/bootstrap5/templates/record/checkbox.phtml

@@ -1,5 +1,5 @@
 <label class="record-checkbox hidden-print">
-  <input class="checkbox-select-item" type="checkbox" name="ids[]" value="<?=$this->escapeHtmlAttr($this->id) ?>"<?php if (isset($this->formAttr)): ?> form="<?=$this->formAttr ?>"<?php endif; ?> aria-label="<?=$this->transEscAttr('select_item')?>">
+  <input class="checkbox-select-item" type="checkbox" name="ids[]" value="<?=$this->escapeHtmlAttr($this->id) ?>"<?php if (isset($this->formAttr)): ?> form="<?=$this->formAttr ?>"<?php endif; ?><?php if (isset($this->checkboxElementId)): ?> aria-describedby="<?=$this->escapeHtmlAttr($this->checkboxElementId) ?>"<?php endif; ?> aria-label="<?=$this->transEscAttr('select_item')?>">
   <span class="checkbox-icon"></span>
   <?php if (strlen($this->number ?? '') > 0): ?><span class="sr-only"><?=$this->transEsc('result_checkbox_label', ['%%number%%' => $this->number]) ?></span><?php endif; ?>
 </label>