PHPStan fixes

Author: qzminski

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+    excludePaths:
+        - src/Widget/*
+        - tests/*

src/DependencyInjection/CodefogTagsExtension.php

@@ -13,6 +13,9 @@
 
 class CodefogTagsExtension extends ConfigurableExtension
 {
+    /**
+     * @param array<string, mixed> $mergedConfig
+     */
     protected function loadInternal(array $mergedConfig, ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
@@ -24,6 +27,9 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         }
     }
 
+    /**
+     * @param array<string, mixed> $config
+     */
     private function createManager(string $name, array $config, ContainerBuilder $container): void
     {
         $id = \sprintf('codefog_tags.manager.%s', $name);

src/Driver.php

@@ -11,6 +11,9 @@
  */
 class Driver extends DC_Table
 {
+    /**
+     * @param array<string> $orderBy
+     */
     public function setOrderBy(array $orderBy): void
     {
         $this->orderBy = $orderBy;

src/EventListener/DataContainer/TagListener.php

@@ -134,6 +134,12 @@ public function onPanelCallback(DataContainer $dc): string
 </div>';
     }
 
+    /**
+     * @param array<string, mixed> $row
+     * @param array<int, mixed>    $args
+     *
+     * @return array<int, mixed>
+     */
     #[AsCallback('tl_cfg_tag', 'list.label.label')]
     public function onLabelCallback(array $row, string $label, DataContainer $dc, array $args): array
     {
@@ -148,6 +154,11 @@ public function onLabelCallback(array $row, string $label, DataContainer $dc, ar
         return $args;
     }
 
+    /**
+     * @param array<string, string> $buttons
+     *
+     * @return array<string, string>
+     */
     #[AsCallback('tl_cfg_tag', 'select.buttons')]
     public function onButtonsCallback(array $buttons, DataContainer $dc): array
     {
@@ -201,6 +212,9 @@ public function onButtonsCallback(array $buttons, DataContainer $dc): array
         return $buttons;
     }
 
+    /**
+     * @return array<string>
+     */
     #[AsCallback('tl_cfg_tag', 'fields.source.options')]
     public function onSourceOptionsCallback(): array
     {

src/EventListener/TagManagerListener.php

@@ -63,6 +63,9 @@ public function onFieldSaveCallback(string $value, DataContainer $dc): string
         return $value;
     }
 
+    /**
+     * @return array<string, string>
+     */
     public function onOptionsCallback(DataContainer $dc): array
     {
         $value = [];

src/Finder/SourceCriteria.php

@@ -8,13 +8,19 @@
 
 class SourceCriteria
 {
+    /**
+     * @var array<int>
+     */
     protected array $ids = [];
 
     /**
      * @var array<Tag>
      */
     protected array $tags = [];
 
+    /**
+     * @var array<string>
+     */
     protected array $tagValues = [];
 
     public function __construct(
@@ -43,11 +49,17 @@ public function getSourceField(): string
         return explode('.', $this->source, 2)[1];
     }
 
+    /**
+     * @return array<int>
+     */
     public function getIds(): array
     {
         return $this->ids;
     }
 
+    /**
+     * @param array<int> $ids
+     */
     public function setIds(array $ids): self
     {
         $this->ids = $ids;
@@ -80,11 +92,17 @@ public function setTag(Tag $tag): self
         return $this;
     }
 
+    /**
+     * @return array<string>
+     */
     public function getTagValues(): array
     {
         return $this->tagValues;
     }
 
+    /**
+     * @param array<string> $tagValues
+     */
     public function setTagValues(array $tagValues): self
     {
         $this->tagValues = $tagValues;

src/Finder/SourceFinder.php

@@ -34,6 +34,8 @@ public function count(SourceCriteria $criteria): int
 
     /**
      * Find multiple source record IDs by criteria.
+     *
+     * @return array<int>
      */
     public function findMultiple(SourceCriteria $criteria): array
     {
@@ -53,6 +55,8 @@ public function findMultiple(SourceCriteria $criteria): array
     /**
      * Find the related source records.
      *
+     * @return array<string, mixed>
+     *
      * @throws \RuntimeException
      */
     public function findRelatedSourceRecords(SourceCriteria $criteria, int|null $limit = null): array
@@ -61,7 +65,7 @@ public function findRelatedSourceRecords(SourceCriteria $criteria, int|null $lim
             throw new \RuntimeException('No IDs have been provided');
         }
 
-        if (false === ($relation = $this->dcaRelationsManager->getRelation($criteria->getSourceTable(), $criteria->getSourceField()))) {
+        if (null === ($relation = $this->dcaRelationsManager->getRelation($criteria->getSourceTable(), $criteria->getSourceField()))) {
             throw new \RuntimeException(\sprintf('The field %s.%s is not related', $criteria->getSourceTable(), $criteria->getSourceField()));
         }
 

src/Finder/TagCriteria.php

@@ -6,12 +6,21 @@
 
 class TagCriteria
 {
+    /**
+     * @var array<string>
+     */
     protected array $aliases = [];
 
+    /**
+     * @var array<int>
+     */
     protected array $sourceIds = [];
 
     protected bool $usedOnly = false;
 
+    /**
+     * @var array<int|string>
+     */
     protected array $values = [];
 
     protected string $order = 'name';
@@ -42,11 +51,17 @@ public function getSourceField(): string
         return explode('.', $this->source, 2)[1];
     }
 
+    /**
+     * @return array<string>
+     */
     public function getAliases(): array
     {
         return $this->aliases;
     }
 
+    /**
+     * @param array<string> $aliases
+     */
     public function setAliases(array $aliases): self
     {
         $this->aliases = array_values(array_unique($aliases));
@@ -61,11 +76,17 @@ public function setAlias(string $alias): self
         return $this;
     }
 
+    /**
+     * @return array<int>
+     */
     public function getSourceIds(): array
     {
         return $this->sourceIds;
     }
 
+    /**
+     * @param array<int> $sourceIds
+     */
     public function setSourceIds(array $sourceIds): self
     {
         $this->sourceIds = array_values(array_unique($sourceIds));
@@ -85,11 +106,17 @@ public function setUsedOnly(bool $usedOnly): self
         return $this;
     }
 
+    /**
+     * @return array<int|string>
+     */
     public function getValues(): array
     {
         return $this->values;
     }
 
+    /**
+     * @param array<int|string> $values
+     */
     public function setValues(array $values): self
     {
         $this->values = array_values(array_unique($values));

src/Finder/TagFinder.php

@@ -19,9 +19,6 @@
 
 readonly class TagFinder
 {
-    /**
-     * Count tags by criteria.
-     */
     public function count(TagCriteria $criteria): int
     {
         try {
@@ -37,9 +34,6 @@ public function count(TagCriteria $criteria): int
         return TagModel::countBy($columns, $values, $options);
     }
 
-    /**
-     * Find a single tag by criteria.
-     */
     public function findSingle(TagCriteria $criteria): Tag|null
     {
         try {
@@ -56,7 +50,7 @@ public function findSingle(TagCriteria $criteria): Tag|null
     }
 
     /**
-     * Find multiple tags by criteria.
+     * @return array<Tag>
      */
     public function findMultiple(TagCriteria $criteria): array
     {
@@ -88,6 +82,8 @@ public function findMultiple(TagCriteria $criteria): array
 
     /**
      * Get the top tags. The tag count will be part of tag's data ($tag->getData()['count']).
+     *
+     * @return array<Tag>
      */
     public function getTopTags(TagCriteria $criteria, int|null $limit = null, bool $withCount = false): array
     {
@@ -110,6 +106,8 @@ public function getTopTags(TagCriteria $criteria, int|null $limit = null, bool $
 
     /**
      * Get the top tag IDs.
+     *
+     * @return array<int, int>
      */
     public function getTopTagIds(TagCriteria $criteria, int|null $limit = null, bool $withCount = false): array
     {
@@ -143,16 +141,17 @@ public function getTopTagIds(TagCriteria $criteria, int|null $limit = null, bool
         return \array_slice($helper, 0, $limit, $withCount);
     }
 
-    /**
-     * Create tag from model.
-     */
     public function createTagFromModel(TagModel $model): Tag
     {
         return new Tag((string) $model->id, (string) $model->name, $model->row());
     }
 
     /**
-     * Parse the criteria to object.
+     * @return array{
+     *     array<string>,
+     *     array<string>,
+     *     array<string, string>,
+     * }
      *
      * @throws NoTagsException
      */

src/InsertTag/TagResolver.php

@@ -33,7 +33,7 @@ public function __invoke(ResolvedInsertTag $insertTag): InsertTagResult
         $manager = $this->registry->get($source);
 
         if ($manager instanceof InsertTagsAwareInterface) {
-            return $manager->getInsertTagValue($value, $property, $parameters->all());
+            return new InsertTagResult($manager->getInsertTagValue($value, $property, $parameters->all()));
         }
 
         return new InsertTagResult('');