ITKDev: Code style fixes in plugins

Author: cableman

README.md

@@ -1,41 +1,48 @@
 # OS2Web Data lookup  [![Build Status](https://travis-ci.org/OS2web/os2web_datalookup.svg?branch=8.x)](https://travis-ci.org/OS2web/os2web_datalookup)
+
 ## Install
 
-OS2Web Data lookup provides integration with Danish data lookup services such as Service platformen or Datafordeler.
-Module is available to download via composer.
-```
+OS2Web Data lookup provides integration with Danish data lookup services such as
+Service platformen or Datafordeler. Module is available to download via
+composer.
+
+```shell
 composer require os2web/os2web_datalookup
 drush en os2web_datalookup
 ```
 
 ## Update
-Updating process for OS2Web Data lookup module is similar to usual Drupal 8 module.
-Use Composer's built-in command for listing packages that have updates available:
+Updating process for OS2Web Data lookup module is similar to the usual Drupal 8
+module. Use Composer's built-in command for listing packages that have updates
+available:
 
-```
+```shell
 composer outdated os2web/os2web_datalookup
 ```
 
 ## Automated testing and code quality
+
 See [OS2Web testing and CI information](https://github.com/OS2Web/docs#testing-and-ci)
 
 ## Contribution
 
 Project is opened for new features and os course bugfixes.
-If you have any suggestion or you found a bug in project, you are very welcome
-to create an issue in github repository issue tracker.
-For issue description there is expected that you will provide clear and
-sufficient information about your feature request or bug report.
+If you have any suggestion, or you found a bug in project, you are very welcome
+to create an issue in GitHub repository issue tracker. For issue description,
+there is expected that you will provide clear and sufficient information about
+your feature request or bug report.
 
 ### Code review policy
+
 See [OS2Web code review policy](https://github.com/OS2Web/docs#code-review)
 
 ### Git name convention
+
 See [OS2Web git name convention](https://github.com/OS2Web/docs#git-guideline)
 
 ### Using services in other modules
 
-```
+```php
 // CVR lookup
 /** @var \Drupal\os2web_datalookup\Plugin\DataLookupManager $pluginManager */
 $pluginManager = \Drupal::service('plugin.manager.os2web_datalookup');
@@ -68,22 +75,25 @@ if ($cprPlugin->isReady()) {
 
 ### Datafordeler integration (https://datafordeler.dk)
 
-In scope of os2forms project already implemented light integration
-with Danmarks Adresseregister (DAR) via fetching data for form elements
-autocomplete. See [os2forms_dawa submodule](https://github.com/OS2Forms/os2forms)
+In the scope of os2forms project already implemented light integration with
+Danmarks Adresseregister (DAR) via fetching data for form elements autocomplete.
+
+See [os2forms_dawa submodule](https://github.com/OS2Forms/os2forms)
 
 As soon as it is clear how the integration is going to be used, then
-os2forms_dawa will be refactored to OS2Web Data lookup plugin plugin.
+os2forms_dawa will be refactored to OS2Web Data lookup plugin.
 
 ## Important notes
+
 ### Serviceplatformen plugins
-Settings for CPR and CVR serviceplantormen plugins are storing as configuration
-in db and will(could) be exported as `yml` file via Drupal configuration
-management system. And afterwards could be tracked by `git`.
 
-If case you have public access to your git repository all setting from plugins
+Settings for CPR and CVR serviceplatformen plugins are storing as configuration
+in db and will(could) be exported as `yml` file via Drupal's configuration
+management system. And afterward could be tracked by `git`.
+
+If case you have public access to your git repository, all settings from plugins
 will be exposed for third persons.
 
-To avoid/prevent this behavior we recommend use `Config ignore` module, where
-you can add all settings you do not want to export/import via configuration
+To avoid/prevent this behavior, we recommend use `Config ignore` module, where
+you can add all settings you do not want to export/import via the configuration
 management system.

src/Plugin/DataLookupManager.php

@@ -23,10 +23,10 @@ class DataLookupManager extends DefaultPluginManager {
    *
    * @var \Drupal\Core\Config\ConfigFactoryInterface
    */
-  protected $configFactory;
+  protected ConfigFactoryInterface $configFactory;
 
   /**
-   * Constructs an DataLookupManager object.
+   * Constructs a DataLookupManager object.
    *
    * @param \Traversable $namespaces
    *   An object that implements \Traversable which contains the root paths
@@ -54,7 +54,7 @@ public function __construct(\Traversable $namespaces, CacheBackendInterface $cac
   /**
    * {@inheritdoc}
    */
-  public function createInstance($plugin_id, array $configuration = []) {
+  public function createInstance($plugin_id, array $configuration = []): object {
     // Hard switch to another plugin fallback - see
     // https://os2web.atlassian.net/browse/OS2FORMS-359.
     if ($plugin_id == 'serviceplatformen_cpr') {
@@ -81,7 +81,7 @@ public function createInstance($plugin_id, array $configuration = []) {
    * @throws \Drupal\Component\Plugin\Exception\PluginException
    *   If the instance cannot be created, such as if the ID is invalid.
    */
-  public function createDefaultInstanceByGroup($group_id) {
+  public function createDefaultInstanceByGroup(string $group_id): object {
     $plugin_id = $this->getGroupDefaultPlugin($group_id);
     return $this->createInstance($plugin_id);
   }
@@ -92,11 +92,11 @@ public function createDefaultInstanceByGroup($group_id) {
    * @param $group_id
    *   Group id.
    *
-   * @return mixed[]
+   * @return array
    *   An array of plugin definitions (empty array if no definitions were
    *   found). Keys are plugin IDs.
    */
-  public function getDefinitionsByGroup($group_id) {
+  public function getDefinitionsByGroup($group_id): array {
     $definitions = [];
     foreach ($this->getDefinitions() as $id => $plugin_definition) {
       if ($plugin_definition['group'] == $group_id) {
@@ -113,11 +113,11 @@ public function getDefinitionsByGroup($group_id) {
    * @return array
    *   Array of groups, keyed by group_id.
    */
-  public function getDatalookupGroups() {
+  public function getDatalookupGroups(): array {
     $definitions = $this->getDefinitions();
     $groups = [];
     foreach ($definitions as $definition) {
-      if (isset($definition['group']) && !empty($definition['group'])) {
+      if (!empty($definition['group'])) {
         $groups[$definition['group']] = $definition['group'];
       }
     }
@@ -134,8 +134,9 @@ public function getDatalookupGroups() {
    * @return string|null
    *   Plugin ID or NULL is not set.
    */
-  public function getGroupDefaultPlugin($group_id) {
+  public function getGroupDefaultPlugin($group_id): ?string {
     $config = \Drupal::config(DataLookupPluginGroupSettingsForm::$configName);
+
     return $config->get("$group_id.default_plugin");
   }
 

src/Plugin/os2web/DataLookup/DataLookupBase.php

@@ -42,22 +42,23 @@ public function label() {
   /**
    * {@inheritdoc}
    */
-  public function getConfiguration() {
+  public function getConfiguration(): array {
     return $this->configuration;
   }
 
   /**
    * {@inheritdoc}
    */
-  public function setConfiguration(array $configuration) {
+  public function setConfiguration(array $configuration): static {
     $this->configuration = $configuration + $this->defaultConfiguration();
+
     return $this;
   }
 
   /**
    * {@inheritdoc}
    */
-  public function defaultConfiguration() {
+  public function defaultConfiguration(): array {
     return [];
   }
 
@@ -71,7 +72,7 @@ public function validateConfigurationForm(array &$form, FormStateInterface $form
   /**
    * {@inheritdoc}
    */
-  public function getStatus() {
+  public function getStatus(): string {
     return 'N/A';
   }
 
@@ -85,7 +86,7 @@ public function getGroup() {
   /**
    * {@inheritdoc}
    */
-  public function isReady() {
+  public function isReady(): bool {
     return $this->isReady;
   }
 

src/Plugin/os2web/DataLookup/DataLookupInterface.php

@@ -22,7 +22,7 @@ interface DataLookupInterface extends PluginInspectionInterface, PluginFormInter
   public function getStatus();
 
   /**
-   * Get plugin group.
+   * Get a plugin group.
    */
   public function getGroup();
 

src/Plugin/os2web/DataLookup/DataLookupInterfaceCompany.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\os2web_datalookup\Plugin\os2web\DataLookup;
 
+use Drupal\os2web_datalookup\LookupResult\CompanyLookupResult;
+
 interface DataLookupInterfaceCompany extends DataLookupInterface {
 
   /**
@@ -13,6 +15,6 @@ interface DataLookupInterfaceCompany extends DataLookupInterface {
    * @return \Drupal\os2web_datalookup\LookupResult\CompanyLookupResult
    *   The company lookup Result.
    */
-  public function lookup($param);
+  public function lookup(string $param): CompanyLookupResult;
 
 }

src/Plugin/os2web/DataLookup/DataLookupInterfaceCpr.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\os2web_datalookup\Plugin\os2web\DataLookup;
 
+use Drupal\os2web_datalookup\LookupResult\CprLookupResult;
+
 interface DataLookupInterfaceCpr extends DataLookupInterface {
 
   /**
@@ -13,6 +15,6 @@ interface DataLookupInterfaceCpr extends DataLookupInterface {
    * @return \Drupal\os2web_datalookup\LookupResult\CprLookupResult
    *   The CPR lookup Result.
    */
-  public function lookup($cpr);
+  public function lookup(string $cpr): CprLookupResult;
 
 }

src/Plugin/os2web/DataLookup/DatafordelerBase.php

@@ -3,6 +3,7 @@
 namespace Drupal\os2web_datalookup\Plugin\os2web\DataLookup;
 
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use GuzzleHttp\Client;
 
 /**
@@ -13,9 +14,9 @@ abstract class DatafordelerBase extends DataLookupBase {
   /**
    * Plugin readiness flag.
    *
-   * @var bool
+   * @var Client
    */
-  protected $httpClient;
+  protected Client $httpClient;
 
   /**
    * {@inheritdoc}
@@ -28,7 +29,7 @@ public function __construct(array $configuration, $plugin_id, $plugin_definition
   /**
    * Plugin init method.
    */
-  private function init() {
+  private function init(): void {
     $this->isReady = FALSE;
 
     $configuration = $this->getConfiguration();
@@ -51,8 +52,8 @@ private function init() {
   /**
    * {@inheritdoc}
    */
-  public function getStatus() {
-    if ($this->httpClient) {
+  public function getStatus(): string|TranslatableMarkup {
+    if (isset($this->httpClient)) {
       return $this->t('Plugin is ready to work');
     }
     else {
@@ -63,7 +64,7 @@ public function getStatus() {
   /**
    * {@inheritdoc}
    */
-  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
+  public function buildConfigurationForm(array $form, FormStateInterface $form_state): array {
     $form['webserviceurl_live'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Webservice URL (LIVE)'),
@@ -91,7 +92,7 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta
   /**
    * {@inheritdoc}
    */
-  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
+  public function submitConfigurationForm(array &$form, FormStateInterface $form_state): void {
     if ($form_state->getValue('cert_passphrase_live') == '') {
       $form_state->unsetValue('cert_passphrase_live');
     }

src/Plugin/os2web/DataLookup/DatafordelerCVR.php

@@ -22,7 +22,7 @@ class DatafordelerCVR extends DatafordelerBase implements DataLookupInterfaceCom
   /**
    * {@inheritdoc}
    */
-  public function defaultConfiguration() {
+  public function defaultConfiguration(): array {
     return [
       'webserviceurl_live' => 'https://s5-certservices.datafordeler.dk/CVR/HentCVRData/1/REST/',
       'cert_path_live' => '',
@@ -33,7 +33,7 @@ public function defaultConfiguration() {
   /**
    * {@inheritdoc}
    */
-  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
+  public function buildConfigurationForm(array $form, FormStateInterface $form_state): array {
     $form = parent::buildConfigurationForm($form, $form_state);
 
     $form['test_cvr'] = [
@@ -47,7 +47,7 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta
   /**
    * {@inheritdoc}
    */
-  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
+  public function submitConfigurationForm(array &$form, FormStateInterface $form_state): void {
     parent::submitConfigurationForm($form, $form_state);
 
     if (!empty($form_state->getValue('test_cvr'))) {
@@ -64,9 +64,9 @@ public function submitConfigurationForm(array &$form, FormStateInterface $form_s
   /**
    * {@inheritdoc}
    */
-  public function lookup($cvr) {
+  public function lookup(string $param): CompanyLookupResult {
     try {
-      $response = $this->httpClient->get('hentVirksomhedMedCVRNummer', ['query' => ['pCVRNummer' => $cvr]]);
+      $response = $this->httpClient->get('hentVirksomhedMedCVRNummer', ['query' => ['pCVRNummer' => $param]]);
       $result = json_decode((string) $response->getBody());
     }
     catch (ClientException $e) {
@@ -76,7 +76,7 @@ public function lookup($cvr) {
     $cvrResult = new CompanyLookupResult();
     if ($result && isset($result->virksomhed) && !empty((array) $result->virksomhed)) {
       $cvrResult->setSuccessful();
-      $cvrResult->setCvr($cvr);
+      $cvrResult->setCvr($param);
 
       if ($result->virksomhedsnavn) {
         $cvrResult->setName($result->virksomhedsnavn->vaerdi);

src/Plugin/os2web/DataLookup/DatafordelerPNumber.php

@@ -22,7 +22,7 @@ class DatafordelerPNumber extends DatafordelerBase implements DataLookupInterfac
   /**
    * {@inheritdoc}
    */
-  public function defaultConfiguration() {
+  public function defaultConfiguration(): array {
     return [
       'webserviceurl_live' => 'https://s5-certservices.datafordeler.dk/CVR/HentCVRData/1/REST/',
       'cert_path_live' => '',
@@ -33,7 +33,7 @@ public function defaultConfiguration() {
   /**
    * {@inheritdoc}
    */
-  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
+  public function buildConfigurationForm(array $form, FormStateInterface $form_state): array {
     $form = parent::buildConfigurationForm($form, $form_state);
 
     $form['test_pnumber'] = [
@@ -47,7 +47,7 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta
   /**
    * {@inheritdoc}
    */
-  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
+  public function submitConfigurationForm(array &$form, FormStateInterface $form_state): void {
     parent::submitConfigurationForm($form, $form_state);
 
     if (!empty($form_state->getValue('test_pnumber'))) {
@@ -64,7 +64,7 @@ public function submitConfigurationForm(array &$form, FormStateInterface $form_s
   /**
    * {@inheritdoc}
    */
-  public function lookup($param) {
+  public function lookup(string $param): CompanyLookupResult {
     try {
       $response = $this->httpClient->get('hentProduktionsenhedMedPNummer', ['query' => ['ppNummer' => $param]]);
       $result = json_decode((string) $response->getBody());