Merge #257

257: Improve static analysis in SearchService r=brunoocasali a=norkunas

# Pull Request

## Related issue
Fixes #<issue_number>

## What does this PR do?
- Improves static analysis

## PR checklist
Please check if your PR fulfills the following requirements:
- [ ] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?


Co-authored-by: Tomas <[email protected]>

Author: meili-bors[bot]

src/SearchService.php

@@ -15,29 +15,47 @@ interface SearchService
     public const RESULT_KEY_OBJECTID = 'objectID';
 
     /**
-     * @param string|object $className
+     * @param class-string|object $className
      */
     public function isSearchable($className): bool;
 
+    /**
+     * @return list<class-string>
+     */
     public function getSearchable(): array;
 
     public function getConfiguration(): Collection;
 
     /**
      * Get the index name for the given `$className`.
+     *
+     * @param class-string $className
      */
     public function searchableAs(string $className): string;
 
     public function index(ObjectManager $objectManager, $searchable): array;
 
     public function remove(ObjectManager $objectManager, $searchable): array;
 
+    /**
+     * @param class-string $className
+     */
     public function clear(string $className): array;
 
+    /**
+     * @param class-string $className
+     */
     public function delete(string $className): ?array;
 
     public function deleteByIndexName(string $indexName): ?array;
 
+    /**
+     * @template T of object
+     *
+     * @param class-string<T> $className
+     *
+     * @return list<T>
+     */
     public function search(
         ObjectManager $objectManager,
         string $className,
@@ -49,12 +67,19 @@ public function search(
      * Get the raw search result.
      *
      * @see https://docs.meilisearch.com/reference/api/search.html#response
+     *
+     * @param class-string $className
      */
     public function rawSearch(
         string $className,
         string $query = '',
         array $searchParams = []
     ): array;
 
+    /**
+     * @param class-string $className
+     *
+     * @return int<0, max>
+     */
     public function count(string $className, string $query = '', array $searchParams = []): int;
 }

src/Services/MeilisearchService.php

@@ -27,9 +27,21 @@ final class MeilisearchService implements SearchService
     private Engine $engine;
     private Collection $configuration;
     private PropertyAccessor $propertyAccessor;
+    /**
+     * @var list<class-string>
+     */
     private array $searchableEntities;
+    /**
+     * @var array<class-string, list<class-string>>
+     */
     private array $entitiesAggregators;
+    /**
+     * @var list<class-string<Aggregator>>
+     */
     private array $aggregators;
+    /**
+     * @var array<class-string, array<string>>
+     */
     private array $classToSerializerGroup;
     private array $indexIfMapping;