diff options
Diffstat (limited to 'lib/IFullTextSearchProvider.php')
-rw-r--r-- | lib/IFullTextSearchProvider.php | 169 |
1 files changed, 0 insertions, 169 deletions
diff --git a/lib/IFullTextSearchProvider.php b/lib/IFullTextSearchProvider.php deleted file mode 100644 index 57089ba..0000000 --- a/lib/IFullTextSearchProvider.php +++ /dev/null @@ -1,169 +0,0 @@ -<?php -/** - * 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 OCA\FullTextSearch; - -use OC\User\NoUserException; -use OCA\FullTextSearch\Model\Index; -use OCA\FullTextSearch\Model\IndexDocument; -use OCA\FullTextSearch\Model\IndexOptions; -use OCA\FullTextSearch\Model\Runner; -use OCA\FullTextSearch\Model\SearchRequest; -use OCA\FullTextSearch\Model\SearchResult; - -interface IFullTextSearchProvider { - - - /** - * return a unique Id of the Provider - * - * @return string - */ - public function getId(); - - - /** - * return a display name of the Provider - * - * @return string - */ - public function getName(); - - - /** - * @return array - */ - public function getConfiguration(); - - - /** - * @return array|string - */ - public function getOptionsTemplate(); - - - /** - * Called when loading the provider - */ - public function loadProvider(); - - - /** - * @param Runner $runner - */ - public function setRunner(Runner $runner); - - -// /** -// * @param IndexOptions $options -// */ -// public function setIndexOptions($options); - - - /** - * returns all indexable document for a user. - * There is no need to fill the document with content at this point. - * - * @param string $userId - * - * @return IndexDocument[] - */ - public function generateIndexableDocuments($userId); - - - /** - * fill a chunk of documents with more content, prior to index. - * - * @deprecated - * - * @param IndexDocument[] $chunk - * - * @return IndexDocument[] - */ - public function fillIndexDocuments($chunk); - - - /** - * fill document with more content, prior to index. - * - * @param IndexDocument $document - */ -// public function fillIndexDocument($document); - - - /** - * @param IndexDocument $document - * - * @return bool - */ - public function isDocumentUpToDate($document); - - - /** - * update a document regarding the current Index' status - * - * @param Index $index - * - * @return IndexDocument - * @throws NoUserException - */ - public function updateDocument(Index $index); - - - /** - * @param IFullTextSearchPlatform $platform - */ - public function onInitializingIndex(IFullTextSearchPlatform $platform); - - - /** - * @param IFullTextSearchPlatform $platform - */ - public function onResettingIndex(IFullTextSearchPlatform $platform); - - - /** - * before a search, improve the request - * - * @param SearchRequest $searchRequest - */ - public function improveSearchRequest(SearchRequest $searchRequest); - - - /** - * after a search, improve the result - * - * @param SearchResult $searchResult - */ - public function improveSearchResult(SearchResult $searchResult); - - - /** - * not used yet. - */ - public function unloadProvider(); - -} |