blob: 3f893c516d98a1a36151b0a8e26827d3b4722ff1 (
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
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
|
<?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;
/**
* @since 16.0.0
*
* Interface ISearchOption
*
* @package OCP\FullTextSearch\Model
*/
interface ISearchOption {
/**
* @since 16.0.0
*/
const CHECKBOX = 'checkbox';
/**
* @since 16.0.0
*/
const INPUT = 'input';
/**
* @since 16.0.0
*/
const INPUT_SMALL = 'small';
/**
* Set the name/key of the option.
* The string should only contains alphanumerical chars and underscore.
* The key can be retrieve when using ISearchRequest::getOption
*
* @see ISearchRequest::getOption
*
* @since 16.0.0
*
* @param string $name
*
* @return ISearchOption
*/
public function setName(string $name): ISearchOption;
/**
* Get the name/key of the option.
*
* @since 16.0.0
*
* @return string
*/
public function getName(): string;
/**
* Set the title/display name of the option.
*
* @since 16.0.0
*
* @param string $title
*
* @return ISearchOption
*/
public function setTitle(string $title): ISearchOption;
/**
* Get the title of the option.
*
* @since 16.0.0
*
* @return string
*/
public function getTitle(): string;
/**
* Set the type of the option.
* $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
*
* @since 16.0.0
*
* @param string $type
*
* @return ISearchOption
*/
public function setType(string $type): ISearchOption;
/**
* Get the type of the option.
*
* @since 16.0.0
*
* @return string
*/
public function getType(): string;
/**
* In case of Type is INPUT, set the size of the input field.
* Value can be ISearchOption::INPUT_SMALL or not defined.
*
* @since 16.0.0
*
* @param string $size
*
* @return ISearchOption
*/
public function setSize(string $size): ISearchOption;
/**
* Get the size of the INPUT.
*
* @since 16.0.0
*
* @return string
*/
public function getSize(): string;
/**
* In case of Type is , set the placeholder to be displayed in the input
* field.
*
* @since 16.0.0
*
* @param string $placeholder
*
* @return ISearchOption
*/
public function setPlaceholder(string $placeholder): ISearchOption;
/**
* Get the placeholder.
*
* @since 16.0.0
*
* @return string
*/
public function getPlaceholder(): string;
}
|
