IRunner

interface OCP\FullTextSearch\Model\IRunner
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.
Source:lib/public/FullTextSearch/Model/IRunner.php#43

Constants

RESULT_TYPE_SUCCESS = 1
Source:lib/public/FullTextSearch/Model/IRunner.php#44
RESULT_TYPE_WARNING = 4
Source:lib/public/FullTextSearch/Model/IRunner.php#45
RESULT_TYPE_FAIL = 9
Source:lib/public/FullTextSearch/Model/IRunner.php#46

Methods

public OCP\FullTextSearch\Model\IRunner::setInfo($info, $value)
Info are displayed in the user interface when an admin execute the
./occ fulltextsearch:index command.

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’)
Source:

lib/public/FullTextSearch/Model/IRunner.php#67
Parameters:
  • $info (string)
  • $value (string)
Since:

15.0.0
public OCP\FullTextSearch\Model\IRunner::setInfoArray($data)
This method should be used when editing multiple info to avoid too many
refresh of the interface.
Source:

lib/public/FullTextSearch/Model/IRunner.php#78
Parameters:
  • $data (array)
Since:

15.0.0
public OCP\FullTextSearch\Model\IRunner::updateAction($action="", $force=false)
Method used to update the current Action when an index is running.
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
Source:

lib/public/FullTextSearch/Model/IRunner.php#100
Parameters:
  • $action (string)
  • $force (bool)
Since:

15.0.0
Returns:

string
Throws:

\Exception
public OCP\FullTextSearch\Model\IRunner::newIndexError($index, $message, $class="", $sev=3)
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.
This is used to store and display errors in the UI during an index to help
admin to keep track of errors.
Source:

lib/public/FullTextSearch/Model/IRunner.php#116
Parameters:
Since:

15.0.0
public OCP\FullTextSearch\Model\IRunner::newIndexResult($index, $message, $status, $type)
Call this method only in a Search Platform after an index of a document.
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.
Source:

lib/public/FullTextSearch/Model/IRunner.php#131
Parameters:
Since:

15.0.0