OS2FORMS-359 adding deprecated warning, hook update for CPR lookup default

Author: stankut

os2web_datalookup.install

@@ -0,0 +1,12 @@
+<?php
+
+use Drupal\os2web_datalookup\Form\DataLookupPluginGroupSettingsForm;
+
+/**
+ * Setting "serviceplatformen_cpr_extended" as default CPR lookup plugin.
+ */
+function os2web_datalookup_update_9001() {
+  $config = \Drupal::service('config.factory')->getEditable(DataLookupPluginGroupSettingsForm::$configName);
+  $config->set("cpr_lookup.default_plugin", 'serviceplatformen_cpr_extended');
+  $config->save();
+}

src/Plugin/DataLookupManager.php

@@ -100,7 +100,7 @@ public function getDefinitionsByGroup($group_id) {
   }
 
   /**
-   * Returns groups of all existing Datalookup plugins.s
+   * Returns groups of all existing Datalookup plugins.
    *
    * @return array
    *   Array of groups, keyed by group_id.

src/Plugin/os2web/DataLookup/ServiceplatformenCPR.php

@@ -95,6 +95,8 @@ public function submitConfigurationForm(array &$form, FormStateInterface $form_s
    *   [error] => Descriptive text shown when CPR doesn't validate
    */
   public function cprBasicInformation($cpr) {
+    \Drupal::logger('os2web_datalookup')->warning('"Serviceplatformen CPR (SF6008)" is obsolete and will be phased out. Please switch to "Serviceplatformen CPR - extended (SF1520)" as soon as possible');
+
     $request = $this->prepareRequest();
     $request['PNR'] = str_replace('-', '', $cpr);
     return $this->query('callCPRBasicInformationService', $request);
@@ -128,6 +130,8 @@ public function validateCpr($cpr) {
    *   [error] => Descriptive text if something goes wrong
    */
   public function getAddress($cpr) {
+    \Drupal::logger('os2web_datalookup')->notice('Calling \'getAddress()\' directly is deprecated, use DataLookupCPRInterface::lookup() method.');
+
     $result = $this->cprBasicInformation($cpr);
 
     // If all goes well we return address array.

src/Plugin/os2web/DataLookup/ServiceplatformenCPRExtended.php

@@ -16,13 +16,34 @@
  *   group = "cpr_lookup"
  * )
  */
-class ServiceplatformenCPRExtended extends ServiceplatformenBase implements DataLookupCPRInterface{
+class ServiceplatformenCPRExtended extends ServiceplatformenBase implements DataLookupCPRInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return array_merge(parent::defaultConfiguration(), [
+      'test_mode_fixed_cpr' => '',
+    ]);
+  }
 
   /**
    * {@inheritdoc}
    */
   public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
     $form = parent::buildConfigurationForm($form, $form_state);
+    $form['mode_fieldset']['test_mode_fixed_cpr'] = [
+      '#type' => 'textfield',
+      '#title' => $this->t('Fixed test CPR'),
+      '#default_value' => $this->configuration['test_mode_fixed_cpr'],
+      '#description' => $this->t('Fixed CPR that will be used for all requests to the serviceplatformen instead of the provided CPR.'),
+      '#states' => [
+        // Hide the settings when the cancel notify checkbox is disabled.
+        'visible' => [
+          'input[name="mode_selector"]' => ['value' => 1],
+        ],
+      ],
+    ];
     $form['test_cpr'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Test CPR nr.'),
@@ -39,6 +60,7 @@ public function submitConfigurationForm(array &$form, FormStateInterface $form_s
     if (!empty($form_state->getValue('test_cpr'))) {
       $cpr = $form_state->getValue('test_cpr');
     }
+
     if (!empty($cpr)) {
       $cprResult = $this->lookup($cpr);
       $response = (array) $cprResult;
@@ -54,6 +76,14 @@ public function submitConfigurationForm(array &$form, FormStateInterface $form_s
    * @inheritDoc
    */
   public function lookup($cpr) {
+    if ($this->configuration['mode_selector'] == 1 && $this->configuration['test_mode_fixed_cpr']) {
+      $cpr = $this->configuration['test_mode_fixed_cpr'];
+      \Drupal::messenger()->addMessage(
+        $this->t("Test mode enabled, all CPR lookup requests are made against CPR: %cpr", ['%cpr' => $cpr]),
+        MessengerInterface::TYPE_STATUS
+      );
+    }
+
     $request = $this->prepareRequest();
     $request['PNR'] = str_replace('-', '', $cpr);
 
@@ -63,6 +93,7 @@ public function lookup($cpr) {
     // If all goes well we return address array.
     if ($result['status']) {
       $cprResult->setSuccessful();
+      $cprResult->setCpr($cpr);
       $persondata = $result['persondata'];
 
       if ($persondata->navn) {