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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
<?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;
use OCP\FullTextSearch\Model\IIndex;
use OCP\FullTextSearch\Model\ISearchResult;
use OCP\FullTextSearch\Service\IIndexService;
use OCP\FullTextSearch\Service\IProviderService;
use OCP\FullTextSearch\Service\ISearchService;
/**
* Interface IFullTextSearchManager
*
* Should be used to manage FullTextSearch from the app that contains your
* Content Provider/Search Platform.
*
* @since 15.0.0
*
* @package OCP\FullTextSearch
*/
interface IFullTextSearchManager {
/**
* Register a IProviderService.
*
* @since 15.0.0
*
* @param IProviderService $providerService
*/
public function registerProviderService(IProviderService $providerService);
/**
* Register a IIndexService.
*
* @since 15.0.0
*
* @param IIndexService $indexService
*/
public function registerIndexService(IIndexService $indexService);
/**
* Register a ISearchService.
*
* @since 15.0.0
*
* @param ISearchService $searchService
*/
public function registerSearchService(ISearchService $searchService);
/**
* returns true is Full Text Search is available (app is present and Service
* are registered)
*
* @since 16.0.0
*
* @return bool
*/
public function isAvailable(): bool;
/**
* Add the Javascript API in the navigation page of an app.
* Needed to replace the default search.
*
* @since 15.0.0
*/
public function addJavascriptAPI();
/**
* Check if the provider $providerId is already indexed.
*
* @since 15.0.0
*
* @param string $providerId
*
* @return bool
*/
public function isProviderIndexed(string $providerId): bool;
/**
* Retrieve an Index from the database, based on the Id of the Provider
* and the Id of the Document
*
* @since 15.0.0
*
* @param string $providerId
* @param string $documentId
*
* @return IIndex
*/
public function getIndex(string $providerId, string $documentId): IIndex;
/**
* Create a new Index.
*
* This method must be called when a new document is created.
*
* @since 15.0.0
*
* @param string $providerId
* @param string $documentId
* @param string $userId
* @param int $status
*
* @return IIndex
*/
public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex;
/**
* Update the status of an Index. status is a bitflag, setting $reset to
* true will reset the status to the value defined in the parameter.
*
* @since 15.0.0
*
* @param string $providerId
* @param string $documentId
* @param int $status
* @param bool $reset
*/
public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false);
/**
* Update the status of an array of Index. status is a bit flag, setting $reset to
* true will reset the status to the value defined in the parameter.
*
* @since 15.0.0
*
* @param string $providerId
* @param array $documentIds
* @param int $status
* @param bool $reset
*/
public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false);
/**
* Update an array of Index.
*
* @since 15.0.0
*
* @param IIndex[] $indexes
*/
public function updateIndexes(array $indexes);
/**
* Search using an array as request. If $userId is empty, will use the
* current session.
*
* @see ISearchService::generateSearchRequest
*
* @since 15.0.0
*
* @param array $request
* @param string $userId
* @return ISearchResult[]
*/
public function search(array $request, string $userId = ''): array;
}
|
