blob: ca11b0c9317bbe27a8e7763c7f6b9a40e403149e (
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
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
|
<?php
declare(strict_types=1);
/**
* @copyright 2018
*
* @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\Model;
/**
* Interface ISearchRequestSimpleQuery
*
* Add a Query during a Search Request...
* - on a specific field,
* - using a specific value,
* - with a specific comparison
*
* @since 17.0.0
*
* @package OCP\FullTextSearch\Model
*/
interface ISearchRequestSimpleQuery {
const COMPARE_TYPE_TEXT = 1;
const COMPARE_TYPE_KEYWORD = 2;
const COMPARE_TYPE_INT_EQ = 3;
const COMPARE_TYPE_INT_GTE = 4;
const COMPARE_TYPE_INT_GT = 5;
const COMPARE_TYPE_INT_LTE = 6;
const COMPARE_TYPE_INT_LT = 7;
const COMPARE_TYPE_BOOL = 8;
const COMPARE_TYPE_ARRAY = 9;
const COMPARE_TYPE_REGEX = 10;
const COMPARE_TYPE_WILDCARD = 11;
/**
* Get the compare type of the query
*
* @return int
* @since 17.0.0
*/
public function getType(): int;
/**
* Get the field to apply query
*
* @return string
* @since 17.0.0
*/
public function getField(): string;
/**
* Set the field to apply query
*
* @param string $field
*
* @return ISearchRequestSimpleQuery
* @since 17.0.0
*/
public function setField(string $field): ISearchRequestSimpleQuery;
/**
* Get the all values to compare
*
* @return array
* @since 17.0.0
*/
public function getValues(): array;
/**
* Add value to compare (string)
*
* @param string $value
*
* @return ISearchRequestSimpleQuery
* @since 17.0.0
*/
public function addValue(string $value): ISearchRequestSimpleQuery;
/**
* Add value to compare (int)
*
* @param int $value
*
* @return ISearchRequestSimpleQuery
* @since 17.0.0
*/
public function addValueInt(int $value): ISearchRequestSimpleQuery;
/**
* Add value to compare (array)
*
* @param array $value
*
* @return ISearchRequestSimpleQuery
* @since 17.0.0
*/
public function addValueArray(array $value): ISearchRequestSimpleQuery;
/**
* Add value to compare (bool)
*
* @param bool $value
*
* @return ISearchRequestSimpleQuery
* @since 17.0.0
*/
public function addValueBool(bool $value): ISearchRequestSimpleQuery;
}
|
