Skip to content

Commit e3496cd

Browse files
committed
Improve static analysis in SearchService
1 parent e4411ca commit e3496cd

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

src/SearchService.php

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ interface SearchService
1515
public const RESULT_KEY_OBJECTID = 'objectID';
1616

1717
/**
18-
* @param string|object $className
18+
* @param class-string|object $className
1919
*/
2020
public function isSearchable($className): bool;
2121

@@ -25,19 +25,34 @@ public function getConfiguration(): Collection;
2525

2626
/**
2727
* Get the index name for the given `$className`.
28+
*
29+
* @param class-string $className
2830
*/
2931
public function searchableAs(string $className): string;
3032

3133
public function index(ObjectManager $objectManager, $searchable): array;
3234

3335
public function remove(ObjectManager $objectManager, $searchable): array;
3436

37+
/**
38+
* @param class-string $className
39+
*/
3540
public function clear(string $className): array;
3641

42+
/**
43+
* @param class-string $className
44+
*/
3745
public function delete(string $className): ?array;
3846

3947
public function deleteByIndexName(string $indexName): ?array;
4048

49+
/**
50+
* @template T of object
51+
*
52+
* @param class-string<T> $className
53+
*
54+
* @return list<T>
55+
*/
4156
public function search(
4257
ObjectManager $objectManager,
4358
string $className,
@@ -49,12 +64,19 @@ public function search(
4964
* Get the raw search result.
5065
*
5166
* @see https://docs.meilisearch.com/reference/api/search.html#response
67+
*
68+
* @param class-string $className
5269
*/
5370
public function rawSearch(
5471
string $className,
5572
string $query = '',
5673
array $searchParams = []
5774
): array;
5875

76+
/**
77+
* @param class-string $className
78+
*
79+
* @return int<0, max>
80+
*/
5981
public function count(string $className, string $query = '', array $searchParams = []): int;
6082
}

0 commit comments

Comments
 (0)