IIndexService
Interface IIndexService
Tags
Table of Contents
- createIndex() : IIndex
- Create an Index
- getIndex() : IIndex
- Retrieve an Index from the database, based on the Id of the Provider and the Id of the Document
- updateIndexes() : mixed
- Update an array of Index.
- updateIndexesStatus() : mixed
- Update the status of an array of Index. status is a bit flag, setting $reset to true will reset the status to the value defined in the parameter.
- updateIndexStatus() : mixed
- Update the status of an Index. status is a bit flag, setting $reset to true will reset the status to the value defined in the parameter.
Methods
createIndex()
Create an Index
public
createIndex(string $providerId, string $documentId, string $userId, int $status) : IIndex
Parameters
- $providerId : string
- $documentId : string
- $userId : string
- $status : int
Tags
Return values
IIndex —getIndex()
Retrieve an Index from the database, based on the Id of the Provider and the Id of the Document
public
getIndex(string $providerId, string $documentId) : IIndex
Parameters
- $providerId : string
- $documentId : string
Tags
Return values
IIndex —updateIndexes()
Update an array of Index.
public
updateIndexes(array $indexes) : mixed
Parameters
- $indexes : array
Tags
Return values
mixed —updateIndexesStatus()
Update the status of an array of Index. status is a bit flag, setting $reset to true will reset the status to the value defined in the parameter.
public
updateIndexesStatus(string $providerId, array $documentIds, int $status[, bool $reset = false ]) : mixed
Parameters
- $providerId : string
- $documentIds : array
- $status : int
- $reset : bool = false
Tags
Return values
mixed —updateIndexStatus()
Update the status of an Index. status is a bit flag, setting $reset to true will reset the status to the value defined in the parameter.
public
updateIndexStatus(string $providerId, string $documentId, int $status[, bool $reset = false ]) : mixed
Parameters
- $providerId : string
- $documentId : string
- $status : int
- $reset : bool = false