nextcloud/lib/public/FullTextSearch/Model/IRunner.php

141 lines
4.0 KiB
PHP

<?php
declare(strict_types=1);
/**
* FullTextSearch - Full text search framework for Nextcloud
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2018
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\FullTextSearch\Model;
/**
* 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.
*
* @since 15.0.0
*
* @package OCP\FullTextSearch\Model
*/
interface IRunner {
const RESULT_TYPE_SUCCESS = 1;
const RESULT_TYPE_WARNING = 4;
const RESULT_TYPE_FAIL = 9;
/**
* 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')
*
* @since 15.0.0
*
* @param string $info
* @param string $value
*/
public function setInfo(string $info, string $value);
/**
* This method should be used when editing multiple info to avoid too many
* refresh of the interface.
*
* @since 15.0.0
*
* @param array $data
*/
public function setInfoArray(array $data);
/**
* 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
*
* @since 15.0.0
*
* @param string $action
* @param bool $force
*
* @return string
* @throws \Exception
*/
public function updateAction(string $action = '', bool $force = false): string;
/**
* 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.
*
* @since 15.0.0
*
* @param IIndex $index
* @param string $message
* @param string $class
* @param int $sev
*/
public function newIndexError(IIndex $index, string $message, string $class = '', int $sev = 3);
/**
* 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.
*
* @since 15.0.0
*
* @param IIndex $index
* @param string $message
* @param string $status
* @param int $type
*/
public function newIndexResult(IIndex $index, string $message, string $status, int $type);
}