blob: 3f0d9ede64542942dd8b859b667c80958a0be2b5 (
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
83
84
85
86
87
88
89
90
91
92
93
|
<?php
declare(strict_types=1);
/**
* @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Joas Schilling <coding@schilljs.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\Search;
/**
* The query objected passed into \OCP\Search\IProvider::search
*
* This mainly wraps the search term, but will ensure that Nextcloud can add new
* optional properties to a search request without having break the interface of
* \OCP\Search\IProvider::search.
*
* @see \OCP\Search\IProvider::search
*
* @since 20.0.0
*/
interface ISearchQuery {
/**
* @since 20.0.0
*/
public const SORT_DATE_DESC = 1;
/**
* Get the user-entered search term to find matches for
*
* @return string the search term
* @since 20.0.0
*/
public function getTerm(): string;
/**
* Get the sort order of results as defined as SORT_* constants on this interface
*
* @return int
* @since 20.0.0
*/
public function getSortOrder(): int;
/**
* Get the number of items to return for a paginated result
*
* @return int
* @see \OCP\Search\IProvider for details
* @since 20.0.0
*/
public function getLimit(): int;
/**
* Get the app-specific cursor of the tail of the previous result entries
*
* @return int|string|null
* @see \OCP\Search\IProvider for details
* @since 20.0.0
*/
public function getCursor();
/**
* @return string
* @since 20.0.0
*/
public function getRoute(): string;
/**
* @return array
* @since 20.0.0
*/
public function getRouteParameters(): array;
}
|
