OS-244 #246 Adding Datafordeler address lookup (#327)

Author: stankut

CHANGELOG.md

@@ -30,6 +30,8 @@ before starting to add changes. Use example [placed in the end of the page](#exa
 - git actions check
 - [PR-289](https://github.com/OS2Forms/os2forms/pull/289)
   Added required "Zoom control position" to map element
+- [#246](https://github.com/OS2Forms/os2forms/issues/246)
+  Adding Datafordeler address lookup
 - [#251](https://github.com/OS2Forms/os2forms/issues/251)
   Updated Webform encrypt uninstall problem fix
 

modules/os2forms_dawa/js/dawa_address_autocomplete.js

@@ -0,0 +1,17 @@
+(function ($, Drupal) {
+    // Overrides splitValues() function found in core/misc/autocomplete.js for
+    // DAWA elements. Danish addresses contain commas. Original splitValues()
+    // method splits upon commas. Combined with default extractLastTerm this
+    // results in unexpected behavior when using autocomplete with respect to
+    // danish addresses. Inspired by
+    // https://www.drupal.org/project/drupal/issues/2821181#comment-12012538.
+    Drupal.autocomplete.splitValues = function (value) {
+        // Check if the current autocomplete is for a focused DAWA address field
+        if ($('.ui-autocomplete-input:focus').closest('.os2forms-dawa-address').length) {
+            // For DAWA address fields, return the entire value as a single value
+            return [ value.trim() ];
+        }
+        // For other fields, use the original behavior
+        return Drupal.autocomplete.splitValues(value);
+    };
+})(jQuery, Drupal);

modules/os2forms_dawa/os2forms_dawa.libraries.yml

@@ -0,0 +1,7 @@
+dawa_address_autocomplete:
+  version: 1.x
+  js:
+    js/dawa_address_autocomplete.js: {}
+  dependencies:
+    - core/jquery
+    - core/drupal

modules/os2forms_dawa/os2forms_dawa.module

@@ -5,6 +5,8 @@
  * OS2Forms Address autocomplete functionality module.
  */
 
+use Drupal\Core\Form\FormStateInterface;
+
 /**
  * Implements hook_webform_migrate_d7_webform_element_ELEMENT_TYPE_alter().
  *
@@ -26,3 +28,12 @@ function os2forms_dawa_webform_migrate_d7_webform_element_address_autocomp_alter
 function os2forms_dawa_webform_migrate_d7_webform_element_addrs_autocomp_l_alter(&$markup, $indent, array $element) {
   $markup .= "$indent  '#type': os2forms_dawa_address_matrikula\n";
 }
+
+/**
+ * Implements hook_webform_element_alter().
+ */
+function os2forms_dawa_webform_element_alter(array &$element, FormStateInterface $form_state, array $context) {
+  if ('os2forms_dawa_address' === $element['#type']) {
+    $element['#attached']['library'][] = 'os2forms_dawa/dawa_address_autocomplete';
+  }
+}

modules/os2forms_dawa/os2forms_dawa.services.yml

@@ -3,7 +3,7 @@
 namespace Drupal\os2forms_dawa\Controller;
 
 use Drupal\Core\Controller\ControllerBase;
-use Drupal\os2forms_dawa\Service\DawaService;
+use Drupal\os2web_datalookup\Plugin\DataLookupManager;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -14,28 +14,28 @@
 class DawaElementController extends ControllerBase {
 
   /**
-   * The DAWA service object.
+   * Datafordeler address lookup.
    *
-   * @var \Drupal\os2forms_dawa\Service\DawaService
+   * @var \Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DatafordelerAddressLookupInterface
    */
-  protected $dawaService;
+  protected $datafordelerAddressLookup;
 
   /**
    * Constructs a DawaElementController object.
    *
-   * @param \Drupal\os2forms_dawa\Service\DawaService $os2forms_dawa_service
-   *   The DAWA service object.
+   * @param \Drupal\os2web_datalookup\Plugin\DataLookupManager $dataLookupManager
+   *   Datalookup manager.
    */
-  public function __construct(DawaService $os2forms_dawa_service) {
-    $this->dawaService = $os2forms_dawa_service;
+  public function __construct(DataLookupManager $dataLookupManager) {
+    $this->datafordelerAddressLookup = $dataLookupManager->createInstance('datafordeler_address_lookup');
   }
 
   /**
    * {@inheritdoc}
    */
   public static function create(ContainerInterface $container) {
     return new static(
-      $container->get('os2forms_dawa.service')
+      $container->get('plugin.manager.os2web_datalookup')
     );
   }
 
@@ -61,18 +61,8 @@ public function autocomplete(Request $request, $element_type) {
     $matches = [];
 
     // Get the matches based on the element type.
-    switch ($element_type) {
-      case 'os2forms_dawa_address':
-        $matches = $this->dawaService->getAddressMatches($query);
-        break;
-
-      case 'os2forms_dawa_block':
-        $matches = $this->dawaService->getBlockMatches($query);
-        break;
-
-      case 'os2forms_dawa_matrikula':
-        $matches = $this->dawaService->getMatrikulaMatches($query);
-        break;
+    if ($element_type == 'os2forms_dawa_address') {
+      $matches = $this->datafordelerAddressLookup->getAddressMatches($query);
     }
 
     return new JsonResponse($matches);

modules/os2forms_dawa/src/Controller/DawaElementController.php

@@ -96,29 +96,32 @@ public static function getCompositeElements(array $element) {
   private static function getMatrikulaOptions($addressValue, array $element) {
     $options = [];
 
-    /** @var \Drupal\os2forms_dawa\Service\DawaService $dawaService */
-    $dawaService = \Drupal::service('os2forms_dawa.service');
+    /** @var \Drupal\os2web_datalookup\Plugin\DataLookupManager $datalookupManager */
+    $datalookupManager = \Drupal::service('plugin.manager.os2web_datalookup');
 
-    /** @var \Drupal\os2forms_dawa\Plugin\os2web\DataLookup\DatafordelerDataLookupInterface $datafordelerLookup */
-    $datafordelerLookup = \Drupal::service('plugin.manager.os2web_datalookup')->createInstance('datafordeler_data_lookup');
+    /** @var \Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DatafordelerAddressLookupInterface $addressLookup */
+    $addressLookup = $datalookupManager->createInstance('datafordeler_address_lookup');
+
+    /** @var \Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DatafordelerMatrikulaLookupInterface $matrikulaLookup */
+    $matrikulaLookup = $datalookupManager->createInstance('datafordeler_matrikula_lookup');
 
     // Getting address.
     $addressParams = new ParameterBag();
     $addressParams->set('q', $addressValue);
     if (isset($element['#limit_by_municipality'])) {
       $addressParams->set('limit_by_municipality', $element['#limit_by_municipality']);
     }
-    $address = $dawaService->getSingleAddress($addressParams);
+    $address = $addressLookup->getSingleAddress($addressParams);
 
     if ($address) {
-      $addressAccessId = $address->getAccessAddressId();
+      $addressHouseId = $address->getHouseId();
 
       // Find matrikula list from the houseid (husnummer):
-      $matrikulaId = $datafordelerLookup->getMatrikulaId($addressAccessId);
+      $matrikulaId = $matrikulaLookup->getMatrikulaId($addressHouseId);
 
       // Find Matrikula entries from matrikulas ID.
       if ($matrikulaId) {
-        $matrikulaEnties = $datafordelerLookup->getMatrikulaEntries($matrikulaId);
+        $matrikulaEnties = $matrikulaLookup->getMatrikulaEntries($matrikulaId);
         foreach ($matrikulaEnties as $matrikula) {
           $matrikulaOption = $matrikula->getMatrikulaNumber() . ' ' . $matrikula->getOwnershipName();
 

modules/os2forms_dawa/src/Element/DawaElementAddressMatrikula.php

@@ -34,26 +34,15 @@ public static function validateDawaElementBase(&$element, FormStateInterface $fo
     }
 
     if (!empty($value)) {
-      /** @var \Drupal\os2forms_dawa\Service\DawaService $dawaService*/
-      $dawaService = \Drupal::service('os2forms_dawa.service');
+      $matches = [];
 
-      $element_type = $element['#type'];
+      if ($element['#type'] == 'os2forms_dawa_address') {
+        /** @var \Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DatafordelerAddressLookupInterface $datafordelerAddressLookup */
+        $datafordelerAddressLookup = \Drupal::service('plugin.manager.os2web_datalookup')->createInstance('datafordeler_address_lookup');
 
-      $parameters = new ParameterBag($element['#autocomplete_route_parameters']);
-      $parameters->set('q', $value);
-
-      switch ($element_type) {
-        case 'os2forms_dawa_address':
-          $matches = $dawaService->getAddressMatches($parameters);
-          break;
-
-        case 'os2forms_dawa_block':
-          $matches = $dawaService->getBlockMatches($parameters);
-          break;
-
-        case 'os2forms_dawa_matrikula':
-          $matches = $dawaService->getMatrikulaMatches($parameters);
-          break;
+        $parameters = new ParameterBag($element['#autocomplete_route_parameters']);
+        $parameters->set('q', $value);
+        $matches = $datafordelerAddressLookup->getAddressMatches($parameters);
       }
 
       // Checking if the current value is within the list of the values from an