You are here

public function EntityDatasourceInterface::getPartialItemIds in Search API 8

Retrieves all item IDs of entities of the specified bundles.

Parameters

int|null $page: The zero-based page of IDs to retrieve, for the paging mechanism implemented by this datasource; or NULL to retrieve all items at once.

string[]|null $bundles: (optional) The bundles for which all item IDs should be returned; or NULL to retrieve IDs from all enabled bundles in this datasource.

string[]|null $languages: (optional) The languages for which all item IDs should be returned; or NULL to retrieve IDs from all enabled languages in this datasource.

Return value

string[]|null An array of all item IDs matching these conditions; or NULL if a page was specified and there are no more items for that and all following pages. In case both bundles and languages are specified, they are combined with OR.

File

src/Plugin/search_api/datasource/EntityDatasourceInterface.php, line 51

Class

EntityDatasourceInterface
Describes an interface for entity datasources.

Namespace

Drupal\search_api\Plugin\search_api\datasource

Code

public function getPartialItemIds($page = NULL, array $bundles = NULL, array $languages = NULL);