Code analysis fixes

Author: jekuaitk

composer.json

@@ -11,12 +11,47 @@
     ],
     "minimum-stability": "dev",
     "prefer-stable": true,
+    "repositories": [
+        {
+            "type": "composer",
+            "url": "https://packages.drupal.org/8"
+        }
+    ],
+    "require": {
+        "os2forms/os2forms": "^3.13"
+    },
     "require-dev": {
+        "dealerdirect/phpcodesniffer-composer-installer": "^0.7.2",
         "drupal/coder": "^8.3",
-        "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1"
+        "mglaman/drupal-check": "^1.4"
+    },
+    "config": {
+        "sort-packages": true,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "zaporylie/composer-drupal-optimizations": true,
+            "cweagans/composer-patches": true,
+            "simplesamlphp/composer-module-installer": true
+        }
     },
     "scripts": {
-        "coding-standards-check": "phpcs --standard=phpcs.xml.dist",
-        "coding-standards-apply": "phpcbf --standard=phpcs.xml.dist"
+        "code-analysis/drupal-check": [
+            "vendor/bin/drupal-check --deprecations --analysis --exclude-dir=vendor *.* src"
+        ],
+        "code-analysis": [
+            "@code-analysis/drupal-check"
+        ],
+        "coding-standards-check/phpcs": [
+            "vendor/bin/phpcs --standard=phpcs.xml.dist"
+        ],
+        "coding-standards-check": [
+            "@coding-standards-check/phpcs"
+        ],
+        "coding-standards-apply/phpcs": [
+            "vendor/bin/phpcbf --standard=phpcs.xml.dist"
+        ],
+        "coding-standards-apply": [
+            "@coding-standards-apply/phpcs"
+        ]
     }
 }

os2forms_user_field_lookup.module

@@ -12,25 +12,33 @@ use Drupal\os2forms_user_field_lookup\WebformElementHelper;
  * Implements hook_webform_element_default_properties_alter().
  *
  * @see WebformElementHelper::alterDefaultProperties()
+ *
+ * @phpstan-param array<string, mixed> $properties
+ * @phpstan-param array<string, mixed> $definition
  */
-function os2forms_user_field_lookup_webform_element_default_properties_alter(array &$properties, array &$definition) {
+function os2forms_user_field_lookup_webform_element_default_properties_alter(array &$properties, array &$definition): void {
   Drupal::service(WebformElementHelper::class)->alterDefaultProperties($properties, $definition);
 }
 
 /**
  * Implements hook_webform_element_translatable_properties_alter().
  *
  * @see WebformElementHelper::alterTranslatableProperties()
+ *
+ * @phpstan-param array<string, mixed> $properties
+ * @phpstan-param array<string, mixed> $definition
  */
-function os2forms_user_field_lookup_webform_element_translatable_properties_alter(array &$properties, array &$definition) {
+function os2forms_user_field_lookup_webform_element_translatable_properties_alter(array &$properties, array &$definition): void {
   Drupal::service(WebformElementHelper::class)->alterTranslatableProperties($properties, $definition);
 }
 
 /**
  * Implements hook_webform_element_configuration_form_alter().
  *
  * @see WebformElementHelper::alterConfigurationForm()
+ *
+ * @phpstan-param array<string, mixed> $form
  */
-function os2forms_user_field_lookup_webform_element_configuration_form_alter(&$form, FormStateInterface $form_state) {
+function os2forms_user_field_lookup_webform_element_configuration_form_alter(&$form, FormStateInterface $form_state): void {
   Drupal::service(WebformElementHelper::class)->alterConfigurationForm($form, $form_state);
 }

src/Element/UserFieldElement.php

@@ -13,8 +13,11 @@ class UserFieldElement extends Textfield {
 
   /**
    * {@inheritDoc}
+   *
+   * @phpstan-param array<string, mixed> $element
+   * @phpstan-return array<string, mixed>
    */
-  public static function preRenderTextfield($element) {
+  public static function preRenderTextfield($element): array {
     $element = parent::preRenderTextfield($element);
     static::setAttributes($element, ['os2forms-user-field-lookup']);
 

src/Element/UserFieldElementCheckbox.php

@@ -13,8 +13,11 @@ class UserFieldElementCheckbox extends Checkbox {
 
   /**
    * {@inheritDoc}
+   *
+   * @phpstan-param array<string, mixed> $element
+   * @phpstan-return array<string, mixed>
    */
-  public static function preRenderCheckbox($element) {
+  public static function preRenderCheckbox($element): array {
     $element = parent::preRenderCheckbox($element);
     // @see https://stackoverflow.com/a/6905050
     $element['#attributes']['onclick'] = 'return false';

src/Plugin/WebformElement/UserFieldElement.php

@@ -3,8 +3,8 @@
 namespace Drupal\os2forms_user_field_lookup\Plugin\WebformElement;
 
 use Drupal\Component\Utility\NestedArray;
-use Drupal\webform\Plugin\WebformElement\TextField;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\webform\Plugin\WebformElement\TextField;
 
 /**
  * User field element.
@@ -20,6 +20,8 @@ class UserFieldElement extends TextField {
 
   /**
    * {@inheritdoc}
+   *
+   * @phpstan-return array<string, mixed>
    */
   protected function defineDefaultProperties() {
     return [
@@ -29,8 +31,11 @@ protected function defineDefaultProperties() {
 
   /**
    * {@inheritdoc}
+   *
+   * @phpstan-param array<string, mixed> $element
+   * @phpstan-param array<string, mixed> $form
    */
-  public function alterForm(array &$element, array &$form, FormStateInterface $form_state) {
+  public function alterForm(array &$element, array &$form, FormStateInterface $form_state): void {
     if ($fieldName = $element['#os2forms_user_field_lookup_field_name'] ?? NULL) {
       if ($this->currentUser->isAuthenticated()) {
         /** @var \Drupal\user\Entity\User $user */

src/Plugin/WebformElement/UserFieldElementCheckbox.php

@@ -20,6 +20,8 @@ class UserFieldElementCheckbox extends Checkbox {
 
   /**
    * {@inheritdoc}
+   *
+   * @phpstan-return array<string, mixed>
    */
   protected function defineDefaultProperties() {
     return [
@@ -29,8 +31,11 @@ protected function defineDefaultProperties() {
 
   /**
    * {@inheritdoc}
+   *
+   * @phpstan-param array<string, mixed> $element
+   * @phpstan-param array<string, mixed> $form
    */
-  public function alterForm(array &$element, array &$form, FormStateInterface $form_state) {
+  public function alterForm(array &$element, array &$form, FormStateInterface $form_state): void {
     if ($fieldName = $element['#os2forms_user_field_lookup_field_name'] ?? NULL) {
       if ($this->currentUser->isAuthenticated()) {
         /** @var \Drupal\user\Entity\User $user */

src/WebformElementHelper.php

@@ -32,26 +32,34 @@ public function __construct(EntityFieldManagerInterface $entityFieldManager) {
 
   /**
    * Implements hook_webform_element_default_properties_alter().
+   *
+   * @phpstan-param array<string, mixed> $properties
+   * @phpstan-param array<string, mixed> $definition
    */
-  public function alterDefaultProperties(array &$properties, array &$definition) {
+  public function alterDefaultProperties(array &$properties, array &$definition): void {
     if ('os2forms_user_field_lookup' === ($definition['provider'] ?? NULL)) {
       $properties['os2forms_user_field_lookup_field_name'] = '';
     }
   }
 
   /**
    * Implements hook_webform_element_translatable_properties_alter().
+   *
+   * @phpstan-param array<string, mixed> $properties
+   * @phpstan-param array<string, mixed> $definition
    */
-  public function alterTranslatableProperties(array &$properties, array &$definition) {
+  public function alterTranslatableProperties(array &$properties, array &$definition): void {
     // Make the custom data property translatable.
     $properties[] = 'os2forms_user_field_lookup_field_name';
   }
 
   /**
    * Implements hook_webform_element_configuration_form_alter().
+   *
+   * @phpstan-param array<string, mixed> $form
    */
-  public function alterConfigurationForm(&$form, FormStateInterface $form_state) {
-    /** @var Drupal\webform_ui\Form\WebformUiElementEditForm $formObject */
+  public function alterConfigurationForm(&$form, FormStateInterface $form_state): void {
+    /** @var \Drupal\webform_ui\Form\WebformUiElementEditForm $formObject */
     $formObject = $form_state->getFormObject();
     $elementPlugin = $formObject->getWebformElementPlugin();
     $pluginDefinition = $elementPlugin->getPluginDefinition();
@@ -77,8 +85,10 @@ public function alterConfigurationForm(&$form, FormStateInterface $form_state) {
 
   /**
    * Get filter for user field definitions.
+   *
+   * @phpstan-param array<string, mixed> $pluginDefinition
    */
-  private function getUserFieldDefinitionFilter(array $pluginDefinition) {
+  private function getUserFieldDefinitionFilter(array $pluginDefinition): mixed {
     switch ($pluginDefinition['class']) {
       case UserFieldElementCheckbox::class:
         // Get all custom boolean fields.