blob: 89fa1a444e21a59035eb5d616724b2a8616ac15a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
<?php
declare(strict_types=1);
/**
* @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
*
* @author Maxence Lange <maxence@artificial-owl.com>
*
* @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\Service;
use OCP\FullTextSearch\Model\ISearchRequest;
use OCP\FullTextSearch\Model\ISearchResult;
/**
* Interface ISearchService
*
* @since 15.0.0
*
* @package OCP\FullTextSearch\Service
*/
interface ISearchService {
/**
* generate a search request, based on an array:
*
* $request =
* [
* 'providers' => (string/array) 'all'
* 'author' => (string) owner of the document.
* 'search' => (string) search string,
* 'size' => (int) number of items to be return
* 'page' => (int) page
* 'parts' => (array) parts of document to search within,
* 'options' = (array) search options,
* 'tags' => (array) tags,
* 'metatags' => (array) metatags,
* 'subtags' => (array) subtags
* ]
*
* 'providers' can be an array of providerIds
*
* @since 15.0.0
*
* @param array $request
*
* @return ISearchRequest
*/
public function generateSearchRequest(array $request): ISearchRequest;
/**
* Search documents
*
* @since 15.0.0
*
* @param string $userId
* @param ISearchRequest $searchRequest
*
* @return ISearchResult[]
*/
public function search(string $userId, ISearchRequest $searchRequest): array;
}
|
