OS2FORMS-359 SF1520 integration, Datalookup groups added

Author: stankut

README.md

@@ -36,7 +36,20 @@ See [OS2Web git name convention](https://github.com/OS2Web/docs#git-guideline)
 ### Using services in other modules
 
 ```
+// CVR lookup.
 \Drupal::service('plugin.manager.os2web_datalookup')->createInstance('serviceplatformen_cvr')->getLegalUnit('[CVR number]')
+
+// CPR lookup.
+/** @var \Drupal\os2web_datalookup\Plugin\DataLookupManager $pluginManager */
+$pluginManager = \Drupal::service('plugin.manager.os2web_datalookup');
+/** @var \Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupCPRInterface $cprPlugin */
+$cprPlugin = $pluginManager->createDefaultInstanceByGroup('cpr_lookup');
+
+if ($cprPlugin->isReady()) {
+  $cprResult = $cprPlugin->lookup($cpr);
+}
+
+// CPP lookup - DEPRECATED.
 \Drupal::service('plugin.manager.os2web_datalookup')->createInstance('serviceplatformen_cpr')->cprBasicInformation('[CPR number]'))
 ```
 

os2web_datalookup.links.task.yml

@@ -0,0 +1,7 @@
+os2web_datalookup.group_settings.all:
+  title: 'All'
+  route_name: os2web_datalookup.status_list
+  base_route: os2web_datalookup.status_list
+os2web_datalookup.group_settings:
+  deriver: 'Drupal\os2web_datalookup\Plugin\Derivative\GroupSettingsLocalTasks'
+  weight: 100

src/Annotation/DataLookup.php

@@ -44,4 +44,11 @@ class DataLookup extends Plugin {
    */
   public $description = '';
 
+  /**
+   * Group of the plugin lookup plugin.
+   *
+   * @var string
+   */
+  public $group = '';
+
 }

src/Controller/DatalookupController.php

@@ -5,6 +5,7 @@
 use Drupal\Component\Plugin\PluginManagerInterface;
 use Drupal\Core\Controller\ControllerBase;
 use Drupal\Core\Link;
+use Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -46,17 +47,21 @@ public function statusList() {
         ->t('Title'),
       'status' => $this
         ->t('Status'),
+      'group' => $this
+        ->t('Group'),
       'action' => $this
         ->t('Actions'),
     ];
 
     $rows = [];
     foreach ($this->manager->getDefinitions() as $id => $plugin_definition) {
+      /** @var DataLookupInterface $plugin */
       $plugin = $this->manager->createInstance($id);
       $status = $plugin->getStatus();
       $rows[$id] = [
         'title' => $plugin_definition['label'],
         'status' => ($plugin->isReady() ? $this->t('READY') : $this->t('ERROR')) . ': ' . $status,
+        'group' => $plugin_definition['group'],
         'action' => Link::createFromRoute($this->t('Settings'), "os2web_datalookup.$id"),
       ];
     }

src/Form/DataLookupPluginGroupSettingsForm.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace Drupal\os2web_datalookup\Form;
+
+use Drupal\Component\Plugin\PluginManagerInterface;
+use Drupal\Core\Form\ConfigFormBase;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Link;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Form or configuring AuthProvider plugin.
+ */
+class DataLookupPluginGroupSettingsForm extends ConfigFormBase {
+
+  /**
+   * Name of the config.
+   *
+   * @var string
+   */
+  public static $configName = 'os2web_datalookup.groups.settings';
+
+  /** @var \Drupal\os2web_datalookup\Plugin\DataLookupManager */
+  protected $dataLookupManager;
+
+  /**
+   * Constructs a new DataLookupPluginGroupSettingsForm object.
+   *
+   * @param \Drupal\os2web_datalookup\Plugin\DataLookupManager
+   *   Datalookup manager.
+   */
+  public function __construct(PluginManagerInterface $dataLookupManager) {
+    $this->dataLookupManager = $dataLookupManager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('plugin.manager.os2web_datalookup')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId() {
+    return 'os2web_datalookop_group_settings_form_' . $this->getGroupIdFromRequest();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getEditableConfigNames() {
+    return [DataLookupPluginGroupSettingsForm::$configName];
+  }
+
+  /**
+   * Returns the value of the param _plugin_id for the current request.
+   *
+   * @see \Drupal\os2web_nemlogin\Routing\AuthProviderRoutes
+   */
+  protected function getGroupIdFromRequest() {
+    $request = $this->getRequest();
+    return $request->get('_group_id');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state) {
+    $group_id = $this->getGroupIdFromRequest();
+
+    $plugin_definitions = $this->dataLookupManager->getDefinitionsByGroup($group_id);
+
+    $header = [
+      'title' => $this
+        ->t('Title'),
+      'status' => $this
+        ->t('Status'),
+      'action' => $this
+        ->t('Actions'),
+    ];
+
+    $options = [];
+    foreach ($plugin_definitions as $id => $plugin_definition) {
+      /** @var \Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupInterface $plugin */
+      $plugin = $this->dataLookupManager->createInstance($id);
+
+      $status = $plugin->getStatus();
+
+      $options[$plugin_definition['id']] = [
+        'title' => $plugin_definition['label'],
+        'status' => ($plugin->isReady() ? $this->t('READY') : $this->t('ERROR')) . ': ' . $status,
+        'group' => $plugin_definition['group'],
+        'action' => Link::createFromRoute($this->t('Settings'), "os2web_datalookup.$id"),
+      ];
+    }
+
+    $form['default_plugin'] = [
+      '#type' => 'tableselect',
+      '#header' => $header,
+      '#options' => $options,
+      '#multiple' => FALSE,
+      '#default_value' => $this->dataLookupManager->getGroupDefaultPlugin($group_id) ?? NULL,
+      '#empty' => $this
+        ->t('No plugins found'),
+    ];
+
+    return parent::buildForm($form, $form_state);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    $group_id = $this->getGroupIdFromRequest();
+
+    $config = $this->config(DataLookupPluginGroupSettingsForm::$configName);
+
+    $config->set("$group_id.default_plugin", $form_state->getValue('default_plugin'));
+    $config->save();
+
+    parent::submitForm($form, $form_state);
+  }
+
+}