Merge pull request #136 from itk-dev/feature/apply-coding-standards

cableman · web-flow · commit f72c8b40d88f · 2024-10-16T09:57:14.000+02:00
Apply coding standards
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,8 +12,9 @@ before starting to add changes. Use example [placed in the end of the page](#exa
 ## [Unreleased]
 
 - [OS-119] Keeping value of CPR clean, not adding address protection text
+- Applied coding standards
 
-## [3.16.0] 2024-08-27
+## [3.16.0-beta1] 2024-08-27
 
 [#110](https://github.com/OS2Forms/os2forms/pull/110)
 
@@ -280,7 +281,8 @@ before starting to add changes. Use example [placed in the end of the page](#exa
 - Security in case of vulnerabilities.
 ```
 
-[Unreleased]: https://github.com/OS2Forms/os2forms/compare/3.15.8...HEAD
+[Unreleased]: https://github.com/OS2Forms/os2forms/compare/3.16.0-beta1...HEAD
+[3.16.0-beta1]: https://github.com/OS2Forms/os2forms/compare/3.15.8...3.16.0-beta1
 [3.15.8]: https://github.com/OS2Forms/os2forms/compare/3.15.7...3.15.8
 [3.15.7]: https://github.com/OS2Forms/os2forms/compare/3.15.6...3.15.7
 [3.15.6]: https://github.com/OS2Forms/os2forms/compare/3.15.5...3.15.6
diff --git a/composer.json b/composer.json
@@ -149,7 +149,8 @@
             "phpstan/extension-installer": true,
             "simplesamlphp/composer-module-installer": true,
             "vaimo/composer-patches": true,
-            "zaporylie/composer-drupal-optimizations": true
+            "zaporylie/composer-drupal-optimizations": true,
+            "mglaman/composer-drupal-lenient": true
         }
     }
 }
diff --git a/modules/os2forms_autocomplete/src/Plugin/WebformElement/AutocompleteElement.php b/modules/os2forms_autocomplete/src/Plugin/WebformElement/AutocompleteElement.php
@@ -38,7 +38,7 @@ protected function defineDefaultProperties() {
   /**
    * {@inheritdoc}
    */
-  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  public function prepare(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     parent::prepare($element, $webform_submission);
 
     if (isset($element['#webform_key'])) {
diff --git a/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementAddress.php b/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementAddress.php
@@ -31,7 +31,7 @@ public function getDefaultProperties() {
   /**
    * {@inheritdoc}
    */
-  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  public function prepare(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     parent::prepare($element, $webform_submission);
 
     $element['#autocomplete_route_parameters']['remove_place_name'] = $element['#remove_place_name'] ?? FALSE;
diff --git a/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementAddressMatrikula.php b/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementAddressMatrikula.php
@@ -36,7 +36,7 @@ public function getDefaultProperties() {
   /**
    * {@inheritdoc}
    */
-  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  public function prepare(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     parent::prepare($element, $webform_submission);
 
     $element['#webform_composite_elements']['address']['#remove_place_name'] = TRUE;
diff --git a/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementBase.php b/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementBase.php
@@ -25,7 +25,7 @@ public function getDefaultProperties() {
   /**
    * {@inheritdoc}
    */
-  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  public function prepare(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     parent::prepare($element, $webform_submission);
 
     $element['#autocomplete_route_name'] = 'os2forms_dawa.element.autocomplete';
diff --git a/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementBlock.php b/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementBlock.php
@@ -30,7 +30,7 @@ public function getDefaultProperties() {
   /**
    * {@inheritdoc}
    */
-  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  public function prepare(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     parent::prepare($element, $webform_submission);
 
     $element['#autocomplete_route_parameters']['remove_code'] = $element['#remove_code'] ?? FALSE;
diff --git a/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementMatrikula.php b/modules/os2forms_dawa/src/Plugin/WebformElement/DawaElementMatrikula.php
@@ -31,7 +31,7 @@ public function getDefaultProperties() {
   /**
    * {@inheritdoc}
    */
-  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  public function prepare(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     parent::prepare($element, $webform_submission);
 
     $element['#autocomplete_route_parameters']['remove_code'] = $element['#remove_code'] ?? FALSE;
diff --git a/modules/os2forms_digital_post/src/Helper/DigitalPostHelper.php b/modules/os2forms_digital_post/src/Helper/DigitalPostHelper.php
@@ -11,8 +11,8 @@
 use Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupInterfaceCompany;
 use Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupInterfaceCpr;
 use Drupal\webform\WebformSubmissionInterface;
-use ItkDev\Serviceplatformen\Service\SF1601\Serializer;
 use ItkDev\Serviceplatformen\Service\SF1601\SF1601;
+use ItkDev\Serviceplatformen\Service\SF1601\Serializer;
 use Oio\Fjernprint\ForsendelseI;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LoggerTrait;
@@ -55,7 +55,7 @@ public function __construct(
    *
    * @phpstan-return array<int, mixed>
    */
-  public function sendDigitalPost(string $type, Message $message, ?ForsendelseI $forsendelse, WebformSubmissionInterface $submission = NULL): array {
+  public function sendDigitalPost(string $type, Message $message, ?ForsendelseI $forsendelse, ?WebformSubmissionInterface $submission = NULL): array {
     $senderSettings = $this->settings->getSender();
     $options = [
       'test_mode' => (bool) $this->settings->getTestMode(),
@@ -76,6 +76,15 @@ public function sendDigitalPost(string $type, Message $message, ?ForsendelseI $f
 
   /**
    * {@inheritdoc}
+   *
+   * @param mixed $level
+   *   The level.
+   * @param string $message
+   *   The message.
+   * @param array $context
+   *   The context.
+   *
+   * @phpstan-param array<string, mixed> $context
    */
   public function log($level, $message, array $context = []): void {
     $this->logger->log($level, $message, $context);
diff --git a/modules/os2forms_digital_post/src/Helper/MeMoHelper.php b/modules/os2forms_digital_post/src/Helper/MeMoHelper.php
@@ -19,8 +19,8 @@
 use Drupal\os2web_datalookup\LookupResult\CompanyLookupResult;
 use Drupal\os2web_datalookup\LookupResult\CprLookupResult;
 use Drupal\webform\WebformSubmissionInterface;
-use ItkDev\Serviceplatformen\Service\SF1601\Serializer;
 use ItkDev\Serviceplatformen\Service\SF1601\SF1601;
+use ItkDev\Serviceplatformen\Service\SF1601\Serializer;
 
 /**
  * MeMo helper.
diff --git a/modules/os2forms_digital_post/src/Helper/SF1461Helper.php b/modules/os2forms_digital_post/src/Helper/SF1461Helper.php
@@ -15,7 +15,7 @@ class SF1461Helper {
    * See "BeskedFåTilsendt" on
    * https://digitaliseringskataloget.dk/integration/sf1461.
    */
-  public function buildResponseDocument(int $statusCode, string $errorMessage = NULL): \DOMDocument {
+  public function buildResponseDocument(int $statusCode, ?string $errorMessage = NULL): \DOMDocument {
     $xml = <<<'XML'
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <ns2:ModtagBeskedOutputType xmlns="urn:oio:sag-dok:3.0.0" xmlns:ns2="urn:oio:sts:1.0.0">
diff --git a/modules/os2forms_digital_post/src/Helper/WebformHelperSF1601.php b/modules/os2forms_digital_post/src/Helper/WebformHelperSF1601.php
@@ -2,12 +2,12 @@
 
 namespace Drupal\os2forms_digital_post\Helper;
 
-use Drupal\advancedqueue\Entity\QueueInterface;
-use Drupal\advancedqueue\Job;
-use Drupal\advancedqueue\JobResult;
 use Drupal\Core\Entity\EntityStorageInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Logger\LoggerChannelInterface;
+use Drupal\advancedqueue\Entity\QueueInterface;
+use Drupal\advancedqueue\Job;
+use Drupal\advancedqueue\JobResult;
 use Drupal\os2forms_digital_post\Exception\InvalidRecipientIdentifierElementException;
 use Drupal\os2forms_digital_post\Exception\RuntimeException;
 use Drupal\os2forms_digital_post\Exception\SubmissionNotFoundException;
@@ -199,6 +199,15 @@ private function loadQueue(): QueueInterface {
 
   /**
    * {@inheritdoc}
+   *
+   * @param mixed $level
+   *   The level.
+   * @param string $message
+   *   The message.
+   * @param array $context
+   *   The context.
+   *
+   * @phpstan-param array<string, mixed> $context
    */
   public function log($level, $message, array $context = []): void {
     $this->logger->log($level, $message, $context);
diff --git a/modules/os2forms_digital_post/src/Plugin/AdvancedQueue/JobType/SendDigitalPostSF1601.php b/modules/os2forms_digital_post/src/Plugin/AdvancedQueue/JobType/SendDigitalPostSF1601.php
@@ -2,10 +2,10 @@
 
 namespace Drupal\os2forms_digital_post\Plugin\AdvancedQueue\JobType;
 
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\advancedqueue\Job;
 use Drupal\advancedqueue\JobResult;
 use Drupal\advancedqueue\Plugin\AdvancedQueue\JobType\JobTypeBase;
-use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\os2forms_digital_post\Helper\WebformHelperSF1601;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
diff --git a/modules/os2forms_encrypt/src/WebformOs2FormsEncryptSubmissionStorage.php b/modules/os2forms_encrypt/src/WebformOs2FormsEncryptSubmissionStorage.php
@@ -35,7 +35,7 @@ class WebformOs2FormsEncryptSubmissionStorage extends WebformEncryptSubmissionSt
    *
    * @see Drupal\webform\WebformSubmissionStorage::getColumns
    */
-  public function getColumns(WebformInterface $webform = NULL, EntityInterface $source_entity = NULL, AccountInterface $account = NULL, $include_elements = TRUE) {
+  public function getColumns(?WebformInterface $webform = NULL, ?EntityInterface $source_entity = NULL, ?AccountInterface $account = NULL, $include_elements = TRUE) {
     if (!\Drupal::moduleHandler()->moduleExists('webform_revisions')) {
       return parent::getColumns($webform, $source_entity, $account, $include_elements);
     }
diff --git a/modules/os2forms_fbs_handler/src/Plugin/AdvancedQueue/JobType/FbsCreateUser.php b/modules/os2forms_fbs_handler/src/Plugin/AdvancedQueue/JobType/FbsCreateUser.php
@@ -2,12 +2,12 @@
 
 namespace Drupal\os2forms_fbs_handler\Plugin\AdvancedQueue\JobType;
 
-use Drupal\advancedqueue\Job;
-use Drupal\advancedqueue\JobResult;
-use Drupal\advancedqueue\Plugin\AdvancedQueue\JobType\JobTypeBase;
 use Drupal\Core\Logger\LoggerChannelFactoryInterface;
 use Drupal\Core\Logger\LoggerChannelInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\advancedqueue\Job;
+use Drupal\advancedqueue\JobResult;
+use Drupal\advancedqueue\Plugin\AdvancedQueue\JobType\JobTypeBase;
 use Drupal\os2forms_fbs_handler\Client\FBS;
 use Drupal\os2forms_fbs_handler\Client\Model\Guardian;
 use Drupal\os2forms_fbs_handler\Client\Model\Patron;
diff --git a/modules/os2forms_fbs_handler/src/Plugin/WebformHandler/FbsWebformHandler.php b/modules/os2forms_fbs_handler/src/Plugin/WebformHandler/FbsWebformHandler.php
@@ -2,14 +2,14 @@
 
 namespace Drupal\os2forms_fbs_handler\Plugin\WebformHandler;
 
-use Drupal\advancedqueue\Entity\Queue;
-use Drupal\advancedqueue\Job;
 use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Logger\LoggerChannelFactoryInterface;
 use Drupal\Core\Logger\LoggerChannelInterface;
 use Drupal\Core\Render\RendererInterface;
+use Drupal\advancedqueue\Entity\Queue;
+use Drupal\advancedqueue\Job;
 use Drupal\os2forms_fbs_handler\Plugin\AdvancedQueue\JobType\FbsCreateUser;
 use Drupal\webform\Plugin\WebformHandlerBase;
 use Drupal\webform\WebformSubmissionConditionsValidatorInterface;
diff --git a/modules/os2forms_forloeb/src/MaestroHelper.php b/modules/os2forms_forloeb/src/MaestroHelper.php
@@ -4,9 +4,6 @@
 
 use DigitalPost\MeMo\Action;
 use DigitalPost\MeMo\EntryPoint;
-use Drupal\advancedqueue\Entity\QueueInterface;
-use Drupal\advancedqueue\Job;
-use Drupal\advancedqueue\JobResult;
 use Drupal\Component\Render\MarkupInterface;
 use Drupal\Component\Utility\NestedArray;
 use Drupal\Core\Config\ConfigFactoryInterface;
@@ -19,6 +16,9 @@
 use Drupal\Core\Render\Markup;
 use Drupal\Core\Site\Settings;
 use Drupal\Core\Url;
+use Drupal\advancedqueue\Entity\QueueInterface;
+use Drupal\advancedqueue\Job;
+use Drupal\advancedqueue\JobResult;
 use Drupal\entity_print\Plugin\EntityPrintPluginManagerInterface;
 use Drupal\maestro\Engine\MaestroEngine;
 use Drupal\maestro\Utility\TaskHandler;
@@ -456,7 +456,7 @@ private function sendNotificationDigitalPost(
    *
    * @see self::renderHtml()
    */
-  public function renderNotification(WebformSubmissionInterface $submission, string $handlerId, string $notificationType, array $templateTask, int $maestroQueueID, string $contentType = NULL): array {
+  public function renderNotification(WebformSubmissionInterface $submission, string $handlerId, string $notificationType, array $templateTask, int $maestroQueueID, ?string $contentType = NULL): array {
     $handler = $submission->getWebform()->getHandler($handlerId);
     $settings = $handler->getSettings();
 
diff --git a/modules/os2forms_forloeb/src/Plugin/AdvancedQueue/JobType/SendMeastroNotification.php b/modules/os2forms_forloeb/src/Plugin/AdvancedQueue/JobType/SendMeastroNotification.php
@@ -2,10 +2,10 @@
 
 namespace Drupal\os2forms_forloeb\Plugin\AdvancedQueue\JobType;
 
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\advancedqueue\Job;
 use Drupal\advancedqueue\JobResult;
 use Drupal\advancedqueue\Plugin\AdvancedQueue\JobType\JobTypeBase;
-use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\os2forms_forloeb\MaestroHelper;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
diff --git a/modules/os2forms_forloeb/src/Plugin/EngineTasks/MaestroWebformInheritTask.php b/modules/os2forms_forloeb/src/Plugin/EngineTasks/MaestroWebformInheritTask.php
@@ -30,7 +30,7 @@ class MaestroWebformInheritTask extends MaestroWebformTask {
    *   [1] - is the queue ID
    *   The processID and queueID properties are defined in the MaestroTaskTrait.
    */
-  public function __construct(array $configuration = NULL) {
+  public function __construct(?array $configuration = NULL) {
     if (is_array($configuration)) {
       $this->processID = $configuration[0];
       $this->queueID = $configuration[1];
diff --git a/modules/os2forms_forloeb/src/Plugin/EngineTasks/MaestroWebformMultipleTask.php b/modules/os2forms_forloeb/src/Plugin/EngineTasks/MaestroWebformMultipleTask.php
@@ -27,7 +27,7 @@ class MaestroWebformMultipleTask extends MaestroWebformTask {
    *   [1] - is the queue ID
    *   The processID and queueID properties are defined in the MaestroTaskTrait.
    */
-  public function __construct(array $configuration = NULL) {
+  public function __construct(?array $configuration = NULL) {
     if (is_array($configuration)) {
       $this->processID = $configuration[0];
       $this->queueID = $configuration[1];
diff --git a/modules/os2forms_nemid/src/Plugin/WebformElement/NemidChildrenRadios.php b/modules/os2forms_nemid/src/Plugin/WebformElement/NemidChildrenRadios.php
@@ -61,7 +61,7 @@ public function getElementSelectorSourceValues(array $element) {
   /**
    * {@inheritdoc}
    */
-  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  public function prepare(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     // Setting empty options to avoid errors during load.
     $element['#options'] = [];
     parent::prepare($element, $webform_submission);
diff --git a/modules/os2forms_nemid/src/Plugin/WebformElement/NemidChildrenSelect.php b/modules/os2forms_nemid/src/Plugin/WebformElement/NemidChildrenSelect.php
@@ -61,7 +61,7 @@ public function getElementSelectorSourceValues(array $element) {
   /**
    * {@inheritdoc}
    */
-  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  public function prepare(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     // Setting empty options to avoid errors during load.
     $element['#options'] = [];
     parent::prepare($element, $webform_submission);
diff --git a/modules/os2forms_nemid/src/Plugin/WebformElement/NemidNemloginLink.php b/modules/os2forms_nemid/src/Plugin/WebformElement/NemidNemloginLink.php
@@ -42,7 +42,7 @@ public function getTranslatableProperties() {
   /**
    * {@inheritdoc}
    */
-  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  public function prepare(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     parent::prepare($element, $webform_submission);
 
     $element['#attributes']['class'][] = 'nemlogin-button-link';
diff --git a/modules/os2forms_permissions_by_term/src/Helper/Helper.php b/modules/os2forms_permissions_by_term/src/Helper/Helper.php
@@ -264,7 +264,7 @@ public function fieldWidgetWebformEntityReferenceFormAlter(array &$elements) {
    * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
    * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
    */
-  private function filterWebformSelectOptions(array $options, array &$result = [], string $parent = NULL) {
+  private function filterWebformSelectOptions(array $options, array &$result = [], ?string $parent = NULL) {
     foreach ($options as $key => $option) {
       if ($option instanceof FieldFilteredMarkup) {
         $webform = $this->entityTypeManager->getStorage('webform')->load($key);
diff --git a/src/Plugin/WebformElement/Os2formsPersonLookup.php b/src/Plugin/WebformElement/Os2formsPersonLookup.php
@@ -46,7 +46,7 @@ protected function defineDefaultProperties() {
   /**
    * {@inheritdoc}
    */
-  protected function prepareElementValidateCallbacks(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
+  protected function prepareElementValidateCallbacks(array &$element, ?WebformSubmissionInterface $webform_submission = NULL) {
     parent::prepareElementValidateCallbacks($element, $webform_submission);
 
     $element['#element_validate'][] = [get_class($this), 'validatePerson'];

Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,8 @@`
`149`	`149`	`"phpstan/extension-installer": true,`
`150`	`150`	`"simplesamlphp/composer-module-installer": true,`
`151`	`151`	`"vaimo/composer-patches": true,`
`152`		`- "zaporylie/composer-drupal-optimizations": true`
	`152`	`+ "zaporylie/composer-drupal-optimizations": true,`
	`153`	`+ "mglaman/composer-drupal-lenient": true`
`153`	`154`	`}`
`154`	`155`	`}`
`155`	`156`	`}`