[FINNA-2767] Initial implementation of disec support for reservation lists

local/config/finna/ReservationList.yaml.sample

@@ -79,7 +79,7 @@ PlaceOrder:
       post: ReservationList::request_post_info_html
 
     fields:
-      - name: record_ids
+      - name: record_ids_text
         type: textarea
         label: ReservationList::Reservation Resources
         settings:

module/Finna/src/Finna/AjaxHandler/ReservationList.php

@@ -92,20 +92,17 @@ public function handleRequest(Params $params)
             );
         }
         $result = [];
-        switch ($params->fromQuery('type')) {
-            case 'status':
-                $listProperties = $this->reservationListService->getListProperties(
-                    $list->getInstitution(),
-                    $list->getListConfigIdentifier()
-                );
-                $connectionType = $list->getConnection();
-                $handler = $this->connectionHandler->get($connectionType);
-                $handler->init($listProperties['properties']);
-                $response = $handler->getListStatus($list, $this->user);
-                $result['status'] = $this->translate($response);
-                break;
-            default:
-                break;
+        $type = $params->fromQuery('type');
+        if ('status' === $type) {
+            $listProperties = $this->reservationListService->getListProperties(
+                $list->getInstitution(),
+                $list->getListConfigIdentifier()
+            )['properties'];
+            $handler = $this->connectionHandler->getWithConfig($listProperties);
+            $response = $handler->getListStatus($list, $this->user);
+            $result['status'] = $this->translate($response);
+        } else {
+            return $this->formatResponse('Bad request', self::STATUS_HTTP_BAD_REQUEST);
         }
         return $this->formatResponse($result);
     }

module/Finna/src/Finna/Controller/ReservationListController.php

@@ -141,7 +141,7 @@ public function addItemToListAction()
             $view->source ?: DEFAULT_SEARCH_BACKEND,
             false
         );
-        $listProperties = ($this->reservationListHelper)($user)->getListProperties(
+        $listProperties = $this->reservationListService->getListProperties(
             $view->institution,
             $view->listIdentifier
         )['properties'];
@@ -208,7 +208,7 @@ public function createListAction(): \Laminas\View\Model\ViewModel
                 'listIdentifier' => $this->getParam('listIdentifier'),
             ]
         );
-        $listProperties = ($this->reservationListHelper)($user)->getListProperties(
+        $listProperties = $this->reservationListService->getListProperties(
             $view->institution,
             $view->listIdentifier
         )['properties'];
@@ -295,31 +295,18 @@ public function placeOrderAction()
         if ($list->getOrdered()) {
             throw new \VuFind\Exception\Forbidden('List already ordered');
         }
-        $listProperties = $this->reservationListHelper->getListProperties(
+        $listProperties = $this->reservationListService->getListProperties(
             $list->getInstitution(),
             $list->getListConfigIdentifier()
         )['properties'];
         if (!($listProperties['Enabled'] ?? true)) {
             throw new \VuFind\Exception\Forbidden('ReservationList: No list properties found.');
         }
 
-        $postValues = $request->getPost()->toArray();
-        $listSpecificValues = [
-            'rl_list_id' => $listId,
-            'rl_institution' => $list->getInstitution(),
-            'rl_list_identifier' => $list->getListConfigIdentifier(),
-            'record_ids' => '',
-            'resourceIDs' => [],
-        ];
-        foreach ($this->reservationListService->getResourcesForList($list, $user) as $resource) {
-            $listSpecificValues['record_ids'] .= $resource->getRecordId() . '||' . $resource->getTitle() . PHP_EOL;
-            $listSpecificValues['resourceIDs'][] = $resource->getSource() . '|' . $resource->getRecordId();
-        }
-        $gatheredValues = array_merge($postValues, $listSpecificValues);
-
         $handler = $this->getService(\Finna\ReservationList\Handler\PluginManager::class)
             ->getWithConfig($listProperties);
-        $form = $handler->getPlaceOrderForm($gatheredValues);
+        $orderSpecificValues = $handler->getValuesForPlaceOrderForm($list, $user, $request->getPost()->toArray());
+        $form = $handler->getPlaceOrderForm($orderSpecificValues);
 
         $formId = ConnectionAbstractBase::FORM_ID;
         $view = $this->createViewModel(compact('form', 'formId', 'user'));
@@ -340,7 +327,7 @@ public function placeOrderAction()
         if (!$form->isValid()) {
             return $view;
         }
-        $result = $handler->placeOrder($gatheredValues, $user);
+        $result = $handler->placeOrder($orderSpecificValues, $user);
         if ($result['success']) {
             $this->reservationListService->setListOrdered($user, $list, $result);
             $this->flashMessenger()->addSuccessMessage($form->getSubmitResponse());

module/Finna/src/Finna/ReservationList/Handler/AbstractBase.php

@@ -64,6 +64,20 @@ abstract class AbstractBase implements HandlerInterface, \Laminas\Log\LoggerAwar
      */
     public const FORM_ID = 'ReservationListRequest';
 
+    /**
+     * Keys to look for in an array to be returned when searching for requested params.
+     *
+     * @var array
+     */
+    public const PLACE_ORDER_REQUEST_KEYS = [
+        'firstName' => '',
+        'lastName' => '',
+        'phone' => '',
+        'email' => '',
+        'pickup_date' => '',
+        'message' => '',
+    ];
+
     /**
      * Order form configuration defined.
      *
@@ -81,6 +95,38 @@ public function __construct(ContainerInterface $serviceLocator)
         $this->serviceLocator = $serviceLocator;
     }
 
+    /**
+     * Get values required for placing the order.
+     *
+     * @param FinnaResourceListEntityInterface $list          List being ordered
+     * @param UserEntityInterface              $user          User who owns the list
+     * @param array                            $requestValues Values obtained i.e from post request as array
+     *
+     * @return array
+     */
+    public function getValuesForPlaceOrderForm(
+        FinnaResourceListEntityInterface $list,
+        UserEntityInterface $user,
+        array $requestValues
+    ): array {
+        $result = [
+            'rl_list_id' => $list->getId(),
+            'rl_institution' => $list->getInstitution(),
+            'rl_list_identifier' => $list->getListConfigIdentifier(),
+            'record_ids_text' => '',
+            'record_source_and_ids' => [],
+        ];
+        $reservationListService = $this->getService(\Finna\ReservationList\ReservationListService::class);
+        foreach ($reservationListService->getResourcesForList($list, $user) as $resource) {
+            $result['record_ids_text'] .= $resource->getRecordId() . '||' . $resource->getTitle() . PHP_EOL;
+            $result['record_source_and_ids'][] = $resource->getSource() . '|' . $resource->getRecordId();
+        }
+        foreach (array_intersect_key($requestValues, self::PLACE_ORDER_REQUEST_KEYS) as $foundKey => $value) {
+            $result[$foundKey] = $requestValues[$foundKey];
+        }
+        return $result;
+    }
+
     /**
      * Build form with configuration obtained from ReservationList.yaml <Action>Forms section.
      *

module/Finna/src/Finna/ReservationList/Handler/Disec.php

@@ -96,7 +96,7 @@ public function placeOrder(array $formValues, UserEntityInterface $user): array
 
         $resources = [];
         $recordLoader = $this->getService(\VuFind\Record\Loader::class);
-        foreach ($recordLoader->loadBatch($formValues['resourceIDs']) as $record) {
+        foreach ($recordLoader->loadBatch($formValues['record_source_and_ids']) as $record) {
             if ($identifiers = $record->tryMethod('getIdentifier', [])) {
                 $resources[] = array_shift($identifiers);
             }

module/Finna/src/Finna/ReservationList/Handler/HandlerInterface.php

@@ -68,6 +68,21 @@ public function placeOrder(array $formValues, UserEntityInterface $user): array;
      */
     public function getListStatus(FinnaResourceListEntityInterface $list): string;
 
+    /**
+     * Get values required for placing the order.
+     *
+     * @param FinnaResourceListEntityInterface $list          List being ordered
+     * @param UserEntityInterface              $user          User who owns the list
+     * @param array                            $requestValues Values obtained i.e from post request as array
+     *
+     * @return array
+     */
+    public function getValuesForPlaceOrderForm(
+        FinnaResourceListEntityInterface $list,
+        UserEntityInterface $user,
+        array $requestValues
+    ): array;
+
     /**
      * Get form used for placing orders.
      *

module/Finna/src/Finna/ReservationList/ReservationListService.php

@@ -117,7 +117,7 @@ class ReservationListService implements TranslatorAwareInterface, DbServiceAware
      * @param ?RecordCache                              $recordCache                 Record cache (optional)
      * @param ?Container                                $session                     Session container for remembering
      *                                                                               state (optional)
-     * @param ?array                                    $yamlConfig                  Reservation list yaml config
+     * @param ?array                                    $reservationListConfig       ReservationList.yaml as array
      */
     public function __construct(
         protected FinnaResourceListServiceInterface $resourceListService,
@@ -128,7 +128,7 @@ public function __construct(
         protected RecordLoader $recordLoader,
         protected ?RecordCache $recordCache = null,
         protected ?Container $session = null,
-        protected ?array $yamlConfig = []
+        protected ?array $reservationListConfig = []
     ) {
     }
 
@@ -554,12 +554,13 @@ public function getListProperties(
         string $institution,
         string $listIdentifier
     ): array {
-        foreach ($this->yamlConfig['Institutions'][$institution]['Lists'] ?? [] as $list) {
+        foreach ($this->reservationListConfig['Institutions'][$institution]['Lists'] ?? [] as $list) {
             $list = $this->ensureListKeys($list);
             if ($list['Identifier'] === $listIdentifier) {
                 return [
                     'properties' => $list,
-                    'institution_information' => $this->yamlConfig['Institutions'][$institution]['Information'] ?? [],
+                    'institution_information'
+                        => $this->reservationListConfig['Institutions'][$institution]['Information'] ?? [],
                     'translation_keys' => [
                         'title' => "ReservationList::list_title_{$institution}_{$listIdentifier}",
                         'description' => "ReservationList::list_description_{$institution}_{$listIdentifier}",