|
4 | 4 | * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors |
5 | 5 | * SPDX-License-Identifier: AGPL-3.0-or-later |
6 | 6 | */ |
| 7 | + |
7 | 8 | namespace OCP\Files\Search; |
8 | 9 |
|
9 | 10 | use OCP\IUser; |
10 | 11 |
|
11 | 12 | /** |
12 | 13 | * @since 12.0.0 |
13 | 14 | */ |
14 | | -interface ISearchQuery { |
15 | | - /** |
16 | | - * @return ISearchOperator |
17 | | - * @since 12.0.0 |
18 | | - */ |
19 | | - public function getSearchOperation(); |
| 15 | +interface ISearchQuery |
| 16 | +{ |
| 17 | + /** |
| 18 | + * @return ISearchOperator |
| 19 | + * @since 12.0.0 |
| 20 | + */ |
| 21 | + public function getSearchOperation(); |
20 | 22 |
|
21 | | - /** |
22 | | - * Get the maximum number of results to return |
23 | | - * |
24 | | - * @return integer |
25 | | - * @since 12.0.0 |
26 | | - */ |
27 | | - public function getLimit(); |
| 23 | + /** |
| 24 | + * Get the maximum number of results to return |
| 25 | + * |
| 26 | + * @return integer |
| 27 | + * @since 12.0.0 |
| 28 | + */ |
| 29 | + public function getLimit(); |
28 | 30 |
|
29 | | - /** |
30 | | - * Get the offset for returned results |
31 | | - * |
32 | | - * @return integer |
33 | | - * @since 12.0.0 |
34 | | - */ |
35 | | - public function getOffset(); |
| 31 | + /** |
| 32 | + * Get the offset for returned results |
| 33 | + * |
| 34 | + * @return integer |
| 35 | + * @since 12.0.0 |
| 36 | + */ |
| 37 | + public function getOffset(); |
36 | 38 |
|
37 | | - /** |
38 | | - * The fields and directions to order by |
39 | | - * |
40 | | - * @return ISearchOrder[] |
41 | | - * @since 12.0.0 |
42 | | - */ |
43 | | - public function getOrder(); |
| 39 | + /** |
| 40 | + * The fields and directions to order by |
| 41 | + * |
| 42 | + * @return ISearchOrder[] |
| 43 | + * @since 12.0.0 |
| 44 | + */ |
| 45 | + public function getOrder(); |
44 | 46 |
|
45 | | - /** |
46 | | - * The user that issued the search |
47 | | - * |
48 | | - * @return ?IUser |
49 | | - * @since 12.0.0 |
50 | | - */ |
51 | | - public function getUser(); |
| 47 | + /** |
| 48 | + * The user that issued the search |
| 49 | + * |
| 50 | + * @return ?IUser |
| 51 | + * @since 12.0.0 |
| 52 | + */ |
| 53 | + public function getUser(); |
52 | 54 |
|
53 | | - /** |
54 | | - * Whether or not the search should be limited to the users home storage |
55 | | - * |
56 | | - * @return bool |
57 | | - * @since 18.0.0 |
58 | | - */ |
59 | | - public function limitToHome(): bool; |
| 55 | + /** |
| 56 | + * Whether or not the search should be limited to the users home storage |
| 57 | + * |
| 58 | + * @return bool |
| 59 | + * @since 18.0.0 |
| 60 | + */ |
| 61 | + public function limitToHome(): bool; |
60 | 62 |
|
61 | | - /** |
62 | | - * The fields to include in the search results |
63 | | - * |
64 | | - * @return list<string> |
65 | | - * @since 33.0.6 |
66 | | - */ |
67 | | - public function getSelectFields(): array; |
| 63 | + /** |
| 64 | + * The fields to include in the search results |
| 65 | + * |
| 66 | + * @return array |
| 67 | + * @since 33.0.6 |
| 68 | + */ |
| 69 | + public function getSelectFields(): array; |
68 | 70 | } |
0 commit comments