IRunner
in
Interface IRunner
The indexing process can be long and heavy, and because errors can be encountered the process is wrapped using this interface. It allows the any extension of FullTextSearch to communicate with the process.
The IRunner is coming with some methods so the Search Platform can returns important information and errors to be displayed to the admin.
Tags
Table of Contents
Constants
- RESULT_TYPE_FAIL = 9
- RESULT_TYPE_SUCCESS = 1
- RESULT_TYPE_WARNING = 4
Methods
- newIndexError() : mixed
- Call this method in a Search Platform or Content Provider if there is an issue while generating a document or while indexing the current document.
- newIndexResult() : mixed
- Call this method only in a Search Platform after an index of a document.
- setInfo() : mixed
- Info are displayed in the user interface when an admin execute the ./occ fulltextsearch:index command.
- setInfoArray() : mixed
- This method should be used when editing multiple info to avoid too many refresh of the interface.
- updateAction() : string
- Method used to update the current Action when an index is running.
Constants
RESULT_TYPE_FAIL
public
mixed
RESULT_TYPE_FAIL
= 9
Tags
RESULT_TYPE_SUCCESS
public
mixed
RESULT_TYPE_SUCCESS
= 1
Tags
RESULT_TYPE_WARNING
public
mixed
RESULT_TYPE_WARNING
= 4
Tags
Methods
newIndexError()
Call this method in a Search Platform or Content Provider if there is an issue while generating a document or while indexing the current document.
public
newIndexError(IIndex $index, string $message[, string $class = '' ][, int $sev = 3 ]) : mixed
This is used to store and display errors in the UI during an index to help admin to keep track of errors.
Parameters
- $index : IIndex
- $message : string
- $class : string = ''
- $sev : int = 3
Tags
newIndexResult()
Call this method only in a Search Platform after an index of a document.
public
newIndexResult(IIndex $index, string $message, string $status, int $type) : mixed
This is used to store and display results (good or bad) in the UI during an index to help admin to keep track of fail and successful indexes.
Parameters
- $index : IIndex
- $message : string
- $status : string
- $type : int
Tags
setInfo()
Info are displayed in the user interface when an admin execute the ./occ fulltextsearch:index command.
public
setInfo(string $info, string $value) : mixed
quick list of info that can be edited: 'documentId', 'info', 'title', 'resultIndex', 'resultStatus', 'content', 'documentCurrent', 'documentTotal', 'progressStatus', 'errorCurrent', 'errorException', 'errorIndex'.
List of all editable info can be find in the Command\Index.php of the FullTextSearch app. (look for a comment 'full list of info that can be edited')
Parameters
- $info : string
- $value : string
Tags
setInfoArray()
This method should be used when editing multiple info to avoid too many refresh of the interface.
public
setInfoArray(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Tags
updateAction()
Method used to update the current Action when an index is running.
public
updateAction([string $action = '' ][, bool $force = false ]) : string
This method should be used instead of manually update the 'action' using setInfo()/setInfoArray() as it is also used to keep the process alive, manage the input, and some statistics of the load of the process.
$action is a string with no space $force should be set to true if the action is heavy while being executed multiple times
Parameters
- $action : string = ''
- $force : bool = false