Skip to content

Improve static analysis in SearchService #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion src/SearchService.php
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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;
}
12 changes: 12 additions & 0 deletions src/Services/MeilisearchService.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down