Module general implementation

Author: andriyun

.travis.yml

@@ -0,0 +1,37 @@
+language: php
+
+sudo: false
+
+php:
+  - 7.2
+
+install:
+  - composer global require drush/drush:8.x-dev drupal/coder mglaman/drupal-check friendsoftwig/twigcs
+  - export PATH="$HOME/.config/composer/vendor/bin:$PATH"
+  - phpcs --config-set installed_paths ../../drupal/coder/coder_sniffer
+  - phpenv rehash
+  - nvm install node
+  - nvm use node
+  - npm install --global yarn
+  - cd ../ && drush dl drupal-8 --drupal-project-rename=drupal
+  - cd drupal
+  - DRUPAL_ROOT=$(pwd)
+  - export REPOSITORIES='"repositories":\ \['
+  - export REPOSITORIES_REPLACE='"repositories":\[\{"type":"path","url":"..\/os2web_datalookup","options":\{"symlink":false\}\},'
+  - export REQUIRE='"require":\ {'
+  - export REQUIRE_REPLACE='"require":{"os2web\/os2web_datalookup":"\*",'
+  - sed -i "s/$REPOSITORIES/$REPOSITORIES_REPLACE/g" composer.json
+  - sed -i "s/$REQUIRE/$REQUIRE_REPLACE/g" composer.json
+  - composer update
+  - PROJECT_PATH=$DRUPAL_ROOT/modules/contrib/os2web_datalookup
+  - cd $DRUPAL_ROOT/core
+  - yarn install
+  - npm install --global eslint-config-drupal-bundle stylelint
+
+script:
+  - phpcs --standard=Drupal --ignore=*.md $PROJECT_PATH
+  - twigcs $PROJECT_PATH
+  - cd $DRUPAL_ROOT/core
+  - eslint $PROJECT_PATH
+  - stylelint --aei $PROJECT_PATH/**/*.css
+  - drupal-check $PROJECT_PATH

composer.json

@@ -0,0 +1,18 @@
+{
+    "name": "os2web/os2web_datalookup",
+    "type": "drupal-module",
+    "description": "Drupal 8 OS2Form module provides advanced webform functionality for Danish Municipalities",
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "license": "EUPL-1.2",
+    "repositories": {
+        "drupal": {
+            "type": "composer",
+            "url": "https://packages.drupal.org/8"
+        },
+        "assets": {
+            "type": "composer",
+            "url": "https://asset-packagist.org"
+        }
+    }
+}

os2web_datalookup.info.yml

@@ -0,0 +1,5 @@
+name: 'OS2Web datalookup'
+type: module
+description: 'Provides integration with Danish data lookup services such as Service platformen or Datafordeler.'
+package: OS2
+core: 8.x

os2web_datalookup.routing.yml

@@ -0,0 +1,10 @@
+os2web_datalookup.status:
+  path: '/admin/config/system/os2web-datalookup'
+  defaults:
+    _controller: '\Drupal\system\Controller\SystemController::systemAdminMenuBlockPage'
+    _title: 'OS2Web Datalookup'
+  requirements:
+    _permission: 'administer os2web datalookup configuration'
+
+route_callbacks:
+  - '\Drupal\os2web_datalookup\Routing\DataLookupRoutes::routes'

os2web_datalookup.services.yml

@@ -0,0 +1,4 @@
+services:
+  plugin.manager.os2web_datalookup:
+    class: Drupal\os2web_datalookup\Plugin\DataLookupManager
+    parent: default_plugin_manager

src/Annotation/DataLookup.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Drupal\os2web_datalookup\Annotation;
+
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Defines a AuthProvider annotation object.
+ *
+ * Plugin Namespace: Plugin/os2web/DataLookup.
+ *
+ * @see hook_os2web_nemlogin_auth_provider_info_alter()
+ * @see \Drupal\os2web_datalookup\Plugin\DataLookupManager
+ * @see plugin_api
+ *
+ * @Annotation
+ */
+class DataLookup extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * The human-readable name of the consent storage.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $label;
+
+  /**
+   * A brief description of the consent storage.
+   *
+   * This will be shown when adding or configuring this consent storage.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $description = '';
+
+}

src/Form/DataLookupPluginSettingsForm.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Drupal\os2web_datalookup\Form;
+
+use Drupal\Component\Plugin\PluginManagerInterface;
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Form or configuring DataLookup plugins.
+ */
+class DataLookupPluginSettingsForm extends PluginSettingsFormBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function __construct(ConfigFactoryInterface $config_factory, PluginManagerInterface $manager) {
+    parent::__construct($config_factory);
+    $this->manager = $manager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('config.factory'),
+      $container->get('plugin.manager.os2web_datalookup')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getConfigName() {
+    return 'os2web_datalookup.settings';
+  }
+
+}

src/Form/PluginSettingsFormBase.php

@@ -0,0 +1,110 @@
+<?php
+
+namespace Drupal\os2web_datalookup\Form;
+
+/**
+ * @file
+ * Abstract class for PluginSettingsForm implementation.
+ */
+
+use Drupal\Core\Form\ConfigFormBase;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Abstract class for PluginSettingsForm implementation.
+ */
+abstract class PluginSettingsFormBase extends ConfigFormBase implements PluginSettingsFormInterface {
+
+  /**
+   * The manager to be used for instantiating plugins.
+   *
+   * @var \Drupal\Component\Plugin\PluginManagerInterface
+   */
+  protected $manager;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getEditableConfigNames() {
+    return [$this->getConfigId()];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId() {
+    return $this->getConfigName() . '_settings_form_' . $this->getPluginIdFromRequest();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state) {
+    $plugin_id = $this->getPluginIdFromRequest();
+    $instance = $this->getPluginInstance($plugin_id);
+    $form = $instance->buildConfigurationForm($form, $form_state);
+    return parent::buildForm($form, $form_state);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validateForm(array &$form, FormStateInterface $form_state) {
+    $plugin_id = $this->getPluginIdFromRequest();
+    $instance = $this->getPluginInstance($plugin_id);
+    $instance->validateConfigurationForm($form, $form_state);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    $plugin_id = $this->getPluginIdFromRequest();
+    $instance = $this->getPluginInstance($plugin_id);
+    $instance->submitConfigurationForm($form, $form_state);
+
+    $config = $this->config($this->getConfigId());
+    foreach ($instance->getConfiguration() as $key => $value) {
+      $config->set($key, $value);
+    }
+    $config->save();
+
+    parent::submitForm($form, $form_state);
+  }
+
+  /**
+   * Returns the value of the param _plugin_id for the current request.
+   */
+  protected function getPluginIdFromRequest() {
+    $request = $this->getRequest();
+    return $request->get('_plugin_id');
+  }
+
+  /**
+   * Returns plugin instance for a given plugin id.
+   *
+   * @param string $plugin_id
+   *   The plugin_id for the plugin instance.
+   *
+   * @return object
+   *   Plugin instance.
+   *
+   * @throws PluginException
+   */
+  public function getPluginInstance($plugin_id) {
+    $configuration = $this->config($this->getConfigId())->get();
+    $instance = $this->manager->createInstance($plugin_id, $configuration);
+    return $instance;
+  }
+
+  /**
+   * Defines name of the configuration object.
+   *
+   * @return string
+   *   Configuration object name.
+   */
+  protected function getConfigId() {
+    return $this->getConfigName() . '.' . $this->getPluginIdFromRequest();
+  }
+
+}

src/Form/PluginSettingsFormInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Drupal\os2web_datalookup\Form;
+
+/**
+ * Provides an interface for a Plugin Settings Form.
+ *
+ * @ingroup form_api
+ */
+interface PluginSettingsFormInterface {
+
+  /**
+   * Name of the configuration.
+   *
+   * @return string
+   *   Configuration name for plugins.
+   */
+  public static function getConfigName();
+
+}

src/Plugin/DataLookupManager.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Drupal\os2web_datalookup\Plugin;
+
+use Drupal\Core\Plugin\DefaultPluginManager;
+use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+
+/**
+ * DataLookupManager plugin manager.
+ *
+ * @see \Drupal\os2web_datalookup\Annotation\DataLookup
+ * @see \Drupal\os2web_datalookup\Plugin\DataLookupInterface
+ * @see plugin_api
+ */
+class DataLookupManager extends DefaultPluginManager {
+
+  /**
+   * Constructs an DataLookupManager object.
+   *
+   * @param \Traversable $namespaces
+   *   An object that implements \Traversable which contains the root paths
+   *   keyed by the corresponding namespace to look for plugin implementations.
+   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
+   *   Cache backend instance to use.
+   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+   *   The module handler to invoke the alter hook with.
+   */
+  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
+    parent::__construct(
+      'Plugin/os2web/DataLookup',
+      $namespaces,
+      $module_handler,
+      'Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupInterface',
+      'Drupal\os2web_datalookup\Annotation\DataLookup');
+
+    $this->alterInfo('os2web_datalookup_info');
+    $this->setCacheBackend($cache_backend, 'os2web_datalookup');
+  }
+
+}