Code analysis

Author: rimi-itk

phpstan.neon

@@ -8,3 +8,7 @@ parameters:
       - rector.php
       # Ignore any vendor folder (https://phpstan.org/user-guide/ignoring-errors#excluding-whole-files)
       - vendor (?)
+
+  ignoreErrors:
+      - '#Call to method Drupal\\Core\\Entity\\Query\\QueryInterface::accessCheck\(\) will always evaluate to true.#'
+      - '#Call to method PHPUnit\\Framework\\Assert::assertTrue\(\) with true will always evaluate to true.#'

scripts/base

@@ -81,15 +81,13 @@ setup() {
   # @todo Do this in a dockerfile.
   compose exec drupal sh -c 'apt update && apt --yes install git'
 
-  COMPOSER=composer.lenient.json composer init --no-interaction
-  COMPOSER=composer.lenient.json composer config --no-plugins allow-plugins.mglaman/composer-drupal-lenient true
-  COMPOSER=composer.lenient.json composer require mglaman/composer-drupal-lenient
-  # COMPOSER=composer.lenient.json rm composer.lenient.*
-
   # Allow all plugins to run.
   composer --no-plugins config allow-plugins true
+  composer --no-plugins config minimum-stability dev
 
-  composer config minimum-stability dev
+  composer --no-plugins config extra.drupal-lenient.allow-all --json true
+  # composer --no-plugins config extra.drupal-lenient.allowed-list --json '[                "drupal/coc_forms_auto_export",                "drupal/webform_node_element"            ]'
+  composer require mglaman/composer-drupal-lenient --with-all-dependencies
 
   # --------------------------------------------------------------------------------------------------------------------
   # We need to install dev requirements from our module, so we use
@@ -103,21 +101,23 @@ setup() {
   # Install wikimedia/composer-merge-plugin without any configuration
   composer require wikimedia/composer-merge-plugin --with-all-dependencies
   # Patch to make COMPOSER_IGNORE_PLATFORM_REQS=1 have effect
+  # https://github.com/wikimedia/composer-merge-plugin/pull/253
   shell sh -c 'cd vendor/wikimedia/composer-merge-plugin/ && curl https://patch-diff.githubusercontent.com/raw/wikimedia/composer-merge-plugin/pull/253.diff | patch --strip=1'
 
   # Configure wikimedia/composer-merge-plugin
   composer --no-plugins config extra.merge-plugin.include "$module_path/composer.json"
   # Use --json to actually set a boolean value (rather that a string value, e.g. "true")
   composer --no-plugins config extra.merge-plugin.merge-extra --json true
   composer --no-plugins config extra.merge-plugin.merge-extra-deep --json true
+
   composer update
   # Our module and its dev requirements are now installed.
   # --------------------------------------------------------------------------------------------------------------------
 
   # Reset Drupal installation
   compose exec drupal sh -c 'find . -name .ht.sqlite -ls -delete; rm web/sites/default/settings.php' || true
   # Install a minimal Drupal site.
-  drush --yes site:install --db-url='sqlite://sites/default/files/.ht.sqlite?module=sqlite' minimal
+  drush --yes site:install --db-url='sqlite://sites/default/files/.ht.sqlite?module=sqlite' minimal -vvv
 
   # Uncomment this line if you need to debug
   # shell bash

src/Controller/Os2formsFordelingskomponentDistributionObjectPreviewController.php

@@ -13,7 +13,6 @@
 use Drupal\webform\WebformInterface;
 use Drupal\webform\WebformSubmissionStorageInterface;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
@@ -24,7 +23,7 @@ final class Os2formsFordelingskomponentDistributionObjectPreviewController exten
   /**
    * The webform submission storage.
    */
-  private WebformSubmissionStorageInterface $submissionStorage;
+  private readonly WebformSubmissionStorageInterface $submissionStorage;
 
   public function __construct(
     private readonly Settings $settings,
@@ -36,7 +35,7 @@ public function __construct(
   /**
    * Builds the response.
    */
-  public function __invoke(Request $request, WebformInterface $webform, string $webform_handler): array|Response {
+  public function __invoke(Request $request, WebformInterface $webform, string $webform_handler): array {
     try {
       $handler = $webform->getHandler($webform_handler);
     }
@@ -93,7 +92,6 @@ public function __invoke(Request $request, WebformInterface $webform, string $we
       '#render_url' => $renderUrl,
       '#preview_urls' => $previewUrls,
     ];
-
   }
 
 }

src/Helper/WebformHelperSF2900.php

@@ -130,7 +130,7 @@ protected function getAttachment(WebformSubmissionInterface $submission, Handler
     $instance = $this->elementInfoManager->createInstance($type);
 
     if (!$instance instanceof WebformAttachmentBase) {
-      throw new InvalidAttachmentElementException(sprintf('Attachment element must be an instance of %s. Found %s.', WebformAttachmentBase::class, get_class($instance)));
+      throw new InvalidAttachmentElementException(sprintf('Attachment element must be an instance of %s. Found %s.', WebformAttachmentBase::class, $instance::class));
     }
 
     $fileName = $instance::getFileName($element, $submission);
@@ -217,6 +217,7 @@ public function createJob(WebformSubmissionInterface $webformSubmission, Webform
     catch (\Exception $exception) {
       $this->error('Error creating job for afsend.', $context + [
         'operation' => 'Fordelingskomponent afsend failed',
+        'exception' => $exception,
       ]);
       return NULL;
     }

src/Hook/ThemeHooks.php

@@ -6,9 +6,9 @@
  * Theme hook implementations.
  */
 final class ThemeHooks {
-  const ROUTING_INFO = 'os2forms_fordelingskomponent_routing_info';
-  const DISTRIBUTION_OBJECT_PREVIEW = 'os2forms_fordelingskomponent_distribution_object_preview';
-  const DISTRIBUTION_OBJECT_PREVIEW_RENDER = 'os2forms_fordelingskomponent_distribution_object_preview_render';
+  const string ROUTING_INFO = 'os2forms_fordelingskomponent_routing_info';
+  const string DISTRIBUTION_OBJECT_PREVIEW = 'os2forms_fordelingskomponent_distribution_object_preview';
+  const string DISTRIBUTION_OBJECT_PREVIEW_RENDER = 'os2forms_fordelingskomponent_distribution_object_preview_render';
 
   /**
    * Implements hook_theme().

src/Plugin/WebformHandler/WebformHandlerSF2900.php

@@ -54,6 +54,7 @@ final class WebformHandlerSF2900 extends WebformHandlerBase {
   /**
    * {@inheritdoc}
    */
+  #[\Override]
   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
     $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
     $instance->settingsService = $container->get(Settings::class);
@@ -66,6 +67,7 @@ public static function create(ContainerInterface $container, array $configuratio
   /**
    * {@inheritdoc}
    */
+  #[\Override]
   public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
     $form[DistributionContextSettings::NAME] = [
       '#type' => 'fieldset',
@@ -327,6 +329,7 @@ public function postPurge(array $webform_submissions) {
   /**
    * {@inheritdoc}
    */
+  #[\Override]
   public function getSummary() {
     $settings = $this->settingsService->getHandlerSettings($this);
 

src/Settings.php

@@ -20,7 +20,7 @@ class Settings {
   /**
    * The config.
    */
-  private ImmutableConfig $config;
+  private readonly ImmutableConfig $config;
 
   public function __construct(
     ConfigFactoryInterface $configFactory,

src/Settings/AbstractSettings.php

@@ -135,7 +135,7 @@ public static function kebab2camel(string $value): string {
    * @see https://stackoverflow.com/a/40514305/2502647
    */
   public static function camel2kebab(string $value): string {
-    return strtolower(preg_replace('/(?<=\d)(?=[A-Za-z])|(?<=[A-Za-z])(?=\d)|(?<=[a-z])(?=[A-Z])/', '_', $value));
+    return strtolower((string) preg_replace('/(?<=\d)(?=[A-Za-z])|(?<=[A-Za-z])(?=\d)|(?<=[a-z])(?=[A-Z])/', '_', $value));
   }
 
 }

src/Settings/DistributionContextSettings.php

@@ -26,7 +26,7 @@ final class DistributionContextSettings extends AbstractSettings {
   public ?string $brugervendtNoegle = NULL;
 
   // @todo Use this?
-  public const ROUTING_MODTAGER_AKTOER = 'routing_modtager_aktoer';
+  public const string ROUTING_MODTAGER_AKTOER = 'routing_modtager_aktoer';
   public ?string $routingModtagerAktoer = NULL;
 
   public const string TITEL = 'titel';