+generateChunks()

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
This commit is contained in:
Maxence Lange 2019-01-29 16:53:49 -01:00
parent 050b9135d5
commit adde9a685c
1 changed files with 21 additions and 2 deletions

View File

@ -163,6 +163,24 @@ interface IFullTextSearchProvider {
public function setIndexOptions(IIndexOptions $options); public function setIndexOptions(IIndexOptions $options);
/**
* Allow the provider to generate a list of chunk to split a huge list of
* indexable documents
*
* During the indexing the generateIndexableDocuments method will be called
* for each entry of the returned array.
* If the returned array is empty, the generateIndexableDocuments() will be
* called only once (per user).
*
* @since 16.0.0
*
* @param string $userId
*
* @return array
*/
public function generateChunks(string $userId): array;
/** /**
* Returns all indexable document for a user as an array of IndexDocument. * Returns all indexable document for a user as an array of IndexDocument.
* *
@ -178,13 +196,14 @@ interface IFullTextSearchProvider {
* *
* @see IndexDocument * @see IndexDocument
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $userId * @param string $userId
* @param string $chunk
* *
* @return IndexDocument[] * @return IndexDocument[]
*/ */
public function generateIndexableDocuments(string $userId): array; public function generateIndexableDocuments(string $userId, string $chunk = ''): array;
/** /**