Add the ability the sort holdings in search results statuses

Author: rominail

config/vufind/config.ini

@@ -2275,6 +2275,14 @@ includeSchemaOrgMetadata = true
 ; If set to "numerical", it will sort numerically by MARC tag.
 ;marcSubjectHeadingsSort = "numerical"
 
+; Sorting for holdings when getting record statuses in the search results page (default: "false").
+; Available values are holdings array keys
+; Unless reversed is specified, elements will be sorted by php defaults for operator <=> (a < b, false < true, 1 < 2)
+; The keys at the top have priority over the following keys
+;getStatusesSorting = "false"
+;getStatusesSorting['availability'] = "reversed"
+;getStatusesSorting['location'] = "reversed"
+
 ; The following two sections control the Alphabetic Browse module.
 [AlphaBrowse]
 ; This setting controls how many headings are displayed on each page of results:

module/VuFind/src/VuFind/AjaxHandler/GetItemStatuses.php

@@ -470,6 +470,31 @@ protected function renderFullStatus($record, $simpleStatus, array $values = [])
         return $this->renderer->render('ajax/status-full.phtml', $values);
     }
 
+    /**
+     * Sort statuses according to given config (by default it come from config.ini)
+     *
+     * @param array[] $holdings The holdings to sort
+     * @param array[] $sortingFields Config on how to sort the fields (first values are prioritized for sorting)
+     *
+     * @return void
+     */
+    protected function sortStatuses(array &$holdings, array $sortingFields): void
+    {
+        usort($holdings, function ($a, $b) use ($sortingFields) {
+            foreach ($sortingFields as $field => $order) {
+                if (!isset($a[$field], $b[$field])) {
+                    continue;
+                }
+                $result = $a[$field] <=> $b[$field];
+                if ($result === 0) {
+                    continue;
+                }
+                return $order !== "reversed" ? $result : -$result;
+            }
+            return 0;
+        });
+    }
+
     /**
      * Handle a request.
      *
@@ -524,6 +549,9 @@ public function handleRequest(Params $params)
 
             // Skip empty records:
             if (count($record)) {
+                if (($this->config->Record->getStatusesSorting ?? "false") !== "false") {
+                    $this->sortStatuses($record, current($this->config->Record->getStatusesSorting));
+                }
                 // Check for errors
                 if (!empty($record[0]['error'])) {
                     $unknownStatus = $this->availabilityStatusManager->createAvailabilityStatus(