Merge pull request #162 from City-of-Helsinki/UHF-9213

UHF-9213: Run phpstan

.github/workflows/ci.yml

@@ -65,8 +65,11 @@ jobs:
 
       - name: Run PHPCS
         working-directory: ${{ env.DRUPAL_ROOT }}
-        run: |
-          vendor/bin/phpcs $MODULE_FOLDER --standard=Drupal --extensions=php,module,inc,install,test,info
+        run: vendor/bin/phpcs $MODULE_FOLDER --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,info
+
+      - name: Run phpstan
+        working-directory: ${{ env.DRUPAL_ROOT }}
+        run: vendor/bin/phpstan analyze -c $MODULE_FOLDER/phpstan.neon $MODULE_FOLDER
 
       - name: Start services
         working-directory: ${{ env.DRUPAL_ROOT }}

helfi_tpr.module

@@ -10,6 +10,7 @@ declare(strict_types = 1);
 use Drupal\Core\Access\AccessResult;
 use Drupal\Core\Database\Query\AlterableInterface;
 use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\EntityPublishedInterface;
 use Drupal\Core\Render\Element;
 use Drupal\Core\Session\AccountInterface;
 
@@ -226,6 +227,7 @@ function template_preprocess_tpr_ontology_word_details(array &$variables) : void
  * Implements hook_ENTITY_TYPE_access().
  */
 function helfi_tpr_tpr_unit_access(EntityInterface $entity, $operation, AccountInterface $account) : AccessResult {
+  assert($entity instanceof EntityPublishedInterface);
   // Allow user to view unpublished Units based on permission.
   if ($operation === 'view' && !$entity->isPublished()) {
     return AccessResult::allowedIfHasPermission($account, 'view unpublished tpr_unit');
@@ -238,6 +240,7 @@ function helfi_tpr_tpr_unit_access(EntityInterface $entity, $operation, AccountI
  * Implements hook_ENTITY_TYPE_access().
  */
 function helfi_tpr_tpr_service_access(EntityInterface $entity, $operation, AccountInterface $account) : AccessResult {
+  assert($entity instanceof EntityPublishedInterface);
   // Allow user to view unpublished Services based on permission.
   if ($operation === 'view' && !$entity->isPublished()) {
     return AccessResult::allowedIfHasPermission($account, 'view unpublished tpr_service');
@@ -250,6 +253,7 @@ function helfi_tpr_tpr_service_access(EntityInterface $entity, $operation, Accou
  * Implements hook_ENTITY_TYPE_access().
  */
 function helfi_tpr_tpr_service_channel_access(EntityInterface $entity, $operation, AccountInterface $account) : AccessResult {
+  assert($entity instanceof EntityPublishedInterface);
   // Allow user to view unpublished Service channels based on permission.
   if ($operation === 'view' && !$entity->isPublished()) {
     return AccessResult::allowedIfHasPermission($account, 'view unpublished tpr_service_channel');
@@ -262,6 +266,7 @@ function helfi_tpr_tpr_service_channel_access(EntityInterface $entity, $operatio
  * Implements hook_ENTITY_TYPE_access().
  */
 function helfi_tpr_tpr_errand_service_access(EntityInterface $entity, $operation, AccountInterface $account) : AccessResult {
+  assert($entity instanceof EntityPublishedInterface);
   // Allow user to view unpublished Errand services based on permission.
   if ($operation === 'view' && !$entity->isPublished()) {
     return AccessResult::allowedIfHasPermission($account, 'view unpublished tpr_errand_service');
@@ -274,6 +279,7 @@ function helfi_tpr_tpr_errand_service_access(EntityInterface $entity, $operation
  * Implements hook_query_TAG_alter().
  */
 function helfi_tpr_query_owd_relationship_alter(AlterableInterface $query) : void {
+  /** @var \Drupal\Core\Entity\Query\QueryAggregateInterface $query */
   $query->groupBy('id');
 }
 

helfi_tpr.views_execution.inc

@@ -14,6 +14,7 @@ use Drupal\views\ViewExecutable;
  */
 function helfi_tpr_views_query_alter(ViewExecutable $view, QueryPluginBase $query) {
   if ($view->id() == 'unit_search' || $view->id() == 'service_units') {
+    assert(isset($query->orderby));
     // Use the CASE function from helfi_tpr_views_pre_execute() for sorting.
     $query->orderby[0]['field'] = 'name_sort';
     $query->orderby[0]['direction'] = 'ASC';

modules/helfi_address_search/src/Plugin/Field/FieldFormatter/KiloFormatter.php

@@ -45,12 +45,12 @@ public function settingsForm(array $form, FormStateInterface $form_state): array
 
     $elements['minimum_value'] = [
       '#type' => 'number',
-      '#title' => t('Minimum value', [], ['context' => 'decimal places']),
+      '#title' => $this->t('Minimum value', [], ['context' => 'decimal places']),
       '#step' => '.01',
       '#min' => 0,
       '#max' => 1000,
       '#default_value' => $this->getSetting('minimum_value'),
-      '#description' => t('If the number is smaller than minimum value, minimum value is shown.'),
+      '#description' => $this->t('If the number is smaller than minimum value, minimum value is shown.'),
       '#weight' => 7,
     ];
 

modules/helfi_address_search/src/Plugin/views/filter/AddressSearch.php

@@ -6,6 +6,7 @@
 
 use Drupal\Component\Serialization\Json;
 use Drupal\Component\Utility\Xss;
+use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Language\LanguageInterface;
 use Drupal\views\Plugin\views\filter\FilterPluginBase;
@@ -79,6 +80,7 @@ public static function sortByAddress(ViewExecutable $view): ViewExecutable {
     $results = $view->result;
     $distances = [];
     foreach ($results as $result) {
+      assert($result->_entity instanceof ContentEntityInterface);
       if (empty($result->_entity->get('latitude')) || empty($result->_entity->get('longitude'))) {
         continue;
       }
@@ -94,6 +96,7 @@ public static function sortByAddress(ViewExecutable $view): ViewExecutable {
 
     // Sort results array by distances: nearest first.
     uasort($results, function ($left, $right) use ($distances) {
+      assert($left->_entity instanceof ContentEntityInterface && $right->_entity instanceof ContentEntityInterface);
       return match ($distances[$left->_entity->get('id')->getString()] >= $distances[$right->_entity->get('id')->getString()]) {
         FALSE => (-1),
         TRUE => 1,

phpstan.neon

@@ -0,0 +1,27 @@
+parameters:
+  fileExtensions:
+      - php
+      - module
+      - install
+  paths:
+    - ./
+  excludePaths:
+    - vendor
+  level: 3
+  checkMissingIterableValueType: false
+  treatPhpDocTypesAsCertain: false
+  ignoreErrors:
+    -
+      message: '#^Access to an undefined property#'
+      paths:
+        - tests/src/Kernel/UnitMigrationTest.php
+        - tests/src/Kernel/ServiceMigrationTest.php
+        - tests/src/Kernel/ServiceChannelMigrationTest.php
+        - tests/src/Kernel/Plugin/Field/FieldType/ConnectionItemTest.php
+        - tests/src/Kernel/Plugin/Field/FieldType/AccessibilitySentenceItemTest.php
+        - tests/src/Functional/UnitListTest.php
+        - tests/src/Functional/ServiceListTest.php
+    -
+      message: '#^\\Drupal calls should be avoided in classes, use dependency injection instead#'
+      path: src/Entity/TranslationHandler.php
+      count: 1

src/Entity/ErrandService.php

@@ -148,6 +148,7 @@ public function getChannels() : array {
   public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
     $fields = parent::baseFieldDefinitions($entity_type);
 
+    assert($fields['name'] instanceof BaseFieldDefinition);
     static::$overrideFields['name'] = $fields['name'];
 
     $fields['type'] = static::createStringField('Type');

src/Entity/Form/ContentEntityForm.php

@@ -126,16 +126,18 @@ public function form(array $form, FormStateInterface $form_state) {
   /**
    * {@inheritdoc}
    */
-  public function save(array $form, FormStateInterface $form_state) {
+  public function save(array $form, FormStateInterface $form_state) : int {
     $entity_type = $this->entity->getEntityTypeId();
 
-    parent::save($form, $form_state);
+    $status = parent::save($form, $form_state);
 
     $this->messenger()->addStatus($this->t('%title saved.', ['%title' => $this->entity->label()]));
 
     $form_state->setRedirect('entity.' . $entity_type . '.canonical', [
       $entity_type => $this->entity->id(),
     ]);
+
+    return $status;
   }
 
 }

src/Entity/Listing/ListBuilder.php

@@ -15,7 +15,7 @@
 /**
  * Provides a list controller for the tpr entity types.
  */
-class ListBuilder extends EntityListBuilder {
+final class ListBuilder extends EntityListBuilder {
 
   /**
    * The date formatter service.
@@ -45,8 +45,8 @@ public function __construct(EntityTypeInterface $entity_type, EntityStorageInter
   /**
    * {@inheritdoc}
    */
-  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
-    return new static(
+  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) : self {
+    return new self(
       $entity_type,
       $container->get('entity_type.manager')->getStorage($entity_type->id()),
       $container->get('date.formatter'),

src/Entity/OntologyWordDetails.php

@@ -133,10 +133,10 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type): a
    * @param string $langcode
    *   The langcode.
    *
-   * @return string[]|null
+   * @return string[]
    *   Array containing the details.
    */
-  public function getDetailByAnother(string $fieldName, string $detail, string $filterName, string $filterValue, string $langcode): ?array {
+  public function getDetailByAnother(string $fieldName, string $detail, string $filterName, string $filterValue, string $langcode): array {
     $data = [];
     if (!$this->getTranslation($langcode)->get($fieldName)->isEmpty()) {
       foreach ($this->getTranslation($langcode)->get($fieldName)->getValue() as $item) {
@@ -145,7 +145,7 @@ public function getDetailByAnother(string $fieldName, string $detail, string $fi
         }
       }
     }
-    return $data ?? NULL;
+    return $data;
   }
 
 }

src/Entity/Unit.php

@@ -161,8 +161,8 @@ public function getPictureUrl() : ? string {
       return $this->get('picture_url')->value;
     }
 
-    /** @var \Drupal\file\FileInterface $file */
     if ($file = $picture_url->get('field_media_image')->entity) {
+      /** @var \Drupal\file\FileInterface $file */
       try {
         return $file->createFileUrl(FALSE) ?: NULL;
       }

src/Plugin/Field/FieldFormatter/ErrandServicesChannelFormatter.php

@@ -8,9 +8,12 @@
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\FormatterBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\Core\Render\RendererInterface;
 use Drupal\helfi_tpr\Entity\ChannelType;
 use Drupal\helfi_tpr\Entity\ChannelTypeCollection;
 use Drupal\helfi_tpr\Entity\Service;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Field formatter to render errand service maps.
@@ -23,7 +26,29 @@
  *   }
  * )
  */
-class ErrandServicesChannelFormatter extends FormatterBase {
+final class ErrandServicesChannelFormatter extends FormatterBase implements ContainerFactoryPluginInterface {
+
+  /**
+   * The renderer service.
+   *
+   * @var \Drupal\Core\Render\RendererInterface
+   */
+  private RendererInterface $renderer;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(
+    ContainerInterface $container,
+    array $configuration,
+    $plugin_id,
+    $plugin_definition
+  ) : self {
+    $instance = parent::create($container, $configuration, $plugin_id,
+      $plugin_definition);
+    $instance->renderer = $container->get('renderer');
+    return $instance;
+  }
 
   /**
    * {@inheritdoc}
@@ -48,10 +73,9 @@ public function settingsSummary() : array {
     }
 
     return [
-      $this->t('Showing @list', [
+      (string) $this->t('Showing @list', [
         '@list' => implode(', ', $selected_channels),
-      ],
-      ),
+      ]),
     ];
   }
 
@@ -132,18 +156,15 @@ public function viewElements(FieldItemListInterface $items, $langcode) : array {
     }
     $channelTypes = $this->getChannelTypes();
 
-    /** @var \Drupal\Core\Render\Renderer $renderer */
-    $renderer = \Drupal::service('renderer');
-
     $channel_list = [];
+    /** @var \Drupal\helfi_tpr\Entity\ErrandService[] $errand_services */
     $errand_services = $items->referencedEntities();
     $item_list = [
       '#theme' => 'item_list',
       '#items' => [],
     ];
 
     foreach ($errand_services as $errand_service) {
-      /** @var \Drupal\helfi_tpr\Entity\ErrandService $errand_service */
       foreach ($errand_service->getChannels() as $channel) {
         if (isset($channel_list[$channel->getType()])
         || empty($this->getSetting('sort_order')[$channel->getType()]['show'])) {
@@ -154,7 +175,7 @@ public function viewElements(FieldItemListInterface $items, $langcode) : array {
           '#name' => $this->getSetting('sort_order')[$channel->getType()]['label'],
           '#weight' => $channelTypes[$channel->getType()]->weight,
         ];
-        $renderer->addCacheableDependency($item_list, $channel);
+        $this->renderer->addCacheableDependency($item_list, $channel);
       }
     }
 

src/Plugin/migrate/source/ServiceMap.php

@@ -35,7 +35,7 @@ public function __toString() : string {
   /**
    * {@inheritdoc}
    */
-  public function count($refresh = FALSE) {
+  public function count($refresh = FALSE) : int {
     return $this->count;
   }
 

src/Plugin/views/argument/ServiceIdArgument.php

@@ -3,6 +3,7 @@
 namespace Drupal\helfi_tpr\Plugin\views\argument;
 
 use Drupal\views\Plugin\views\argument\ArgumentPluginBase;
+use Drupal\views\Plugin\views\query\Sql;
 
 /**
  * Argument for service_id column.
@@ -30,6 +31,9 @@ public function query($group_by = FALSE) : void {
     }
 
     $group = $this->query->setWhereGroup('OR');
+
+    assert($this->query instanceof Sql);
+
     if (!empty($ids)) {
       $this->query->addWhere($group, 'id', $ids, 'IN');
     }

src/Plugin/views/filter/ProvidedLanguages.php

@@ -22,7 +22,7 @@ class ProvidedLanguages extends InOperator {
    */
   public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL): void {
     parent::init($view, $display, $options);
-    $this->valueTitle = t('Allowed languages');
+    $this->valueTitle = (string) $this->t('Allowed languages');
     $this->definition['options callback'] = [$this, 'generateOptions'];
   }
 
@@ -34,9 +34,9 @@ public function init(ViewExecutable $view, DisplayPluginBase $display, array &$o
    */
   public function generateOptions(): array {
     return [
-      'fi' => t('Finnish'),
-      'sv' => t('Swedish'),
-      'se' => t('North Sami'),
+      'fi' => (string) $this->t('Finnish'),
+      'sv' => (string) $this->t('Swedish'),
+      'se' => (string) $this->t('North Sami'),
     ];
   }
 

src/Plugin/views/filter/Status.php

@@ -5,6 +5,7 @@
 namespace Drupal\helfi_tpr\Plugin\views\filter;
 
 use Drupal\views\Plugin\views\filter\FilterPluginBase;
+use Drupal\views\Plugin\views\query\Sql;
 
 /**
  * Filter by published status.
@@ -28,6 +29,7 @@ public function canExpose() {
   public function query() {
     $table = $this->ensureMyTable();
     $snippet = "$table.content_translation_status = 1 OR ***VIEW_UNPUBLISHED_TPR_ENTITIES*** = 1";
+    assert($this->query instanceof Sql);
     $this->query->addWhereExpression($this->options['group'], $snippet);
   }
 

src/Plugin/views/relationship/TagOwdRelationship.php

@@ -4,6 +4,7 @@
 
 namespace Drupal\helfi_tpr\Plugin\views\relationship;
 
+use Drupal\views\Plugin\views\query\Sql;
 use Drupal\views\Plugin\views\relationship\RelationshipPluginBase;
 
 /**
@@ -20,6 +21,7 @@ class TagOwdRelationship extends RelationshipPluginBase {
    */
   public function query() {
     parent::query();
+    assert($this->query instanceof Sql);
     $this->query->addTag('owd_relationship');
   }