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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
<?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 OC\FullTextSearch\Model;
use JsonSerializable;
use OCP\FullTextSearch\IFullTextSearchProvider;
use OCP\FullTextSearch\Model\ISearchOption;
use OCP\FullTextSearch\Model\ISearchTemplate;
/**
* Class ISearchTemplate
*
* This is a data transfer object that should be created by Content Provider
* when the getSearchTemplate() method is called.
*
* The object will contain templates to be displayed, and the list of the different
* options to be available to the user when he start a new search.
*
* The display of the Options is generated by the FullTextSearch app and Options
* can be displayed in 2 places:
*
* - the navigation page of the app that generate the indexed content.
* (files, bookmarks, deck, mails, ...)
* - the navigation page of the FullTextSearch app.
*
* Both pages will have different Options, and only the first one can integrate
* a specific template.
*
* @see IFullTextSearchProvider::getSearchTemplate
*
* @since 15.0.0
*
* @package OC\FullTextSearch\Model
*/
final class SearchTemplate implements ISearchTemplate, JsonSerializable {
/** @var string */
private $icon = '';
/** @var string */
private $css = '';
/** @var string */
private $template = '';
/** @var SearchOption[] */
private $panelOptions = [];
/** @var SearchOption[] */
private $navigationOptions = [];
/**
* ISearchTemplate constructor.
*
* the class of the icon and the css file to be loaded can be set during the
* creation of the object.
*
* @since 15.0.0
*
* @param string $icon
* @param string $css
*/
public function __construct(string $icon = '', string $css = '') {
$this->icon = $icon;
$this->css = $css;
}
/**
* Set the class of the icon to be displayed in the left panel of the
* FullTextSearch navigation page, in front of the related Content Provider.
*
* @since 15.0.0
*
* @param string $class
*
* @return ISearchTemplate
*/
public function setIcon(string $class): ISearchTemplate {
$this->icon = $class;
return $this;
}
/**
* Get the class of the icon.
*
* @since 15.0.0
*
* @return string
*/
public function getIcon(): string {
return $this->icon;
}
/**
* Set the path of a CSS file that will be loaded when needed.
*
* @since 15.0.0
*
* @param string $css
*
* @return ISearchTemplate
*/
public function setCss(string $css): ISearchTemplate {
$this->css = $css;
return $this;
}
/**
* Get the path of the CSS file.
*
* @since 15.0.0
*
* @return string
*/
public function getCss(): string {
return $this->css;
}
/**
* Set the path of the file of a template that the HTML will be displayed
* below the Options.
* This should only be used if your Content Provider needs to set options in
* a way not generated by FullTextSearch
*
* @since 15.0.0
*
* @param string $template
*
* @return ISearchTemplate
*/
public function setTemplate(string $template): ISearchTemplate {
$this->template = $template;
return $this;
}
/**
* Get the path of the template file.
*
* @since 15.0.0
*
* @return string
*/
public function getTemplate(): string {
return $this->template;
}
/**
* Add an option in the Panel that is displayed when the user start a search
* within the app that generate the content.
*
* @see ISearchOption
*
* @since 15.0.0
*
* @param ISearchOption $option
*
* @return ISearchTemplate
*/
public function addPanelOption(ISearchOption $option): ISearchTemplate {
$this->panelOptions[] = $option;
return $this;
}
/**
* Get all options to be displayed in the Panel.
*
* @since 15.0.0
*
* @return SearchOption[]
*/
public function getPanelOptions(): array {
return $this->panelOptions;
}
/**
* Add an option in the left panel of the FullTextSearch navigation page.
*
* @see ISearchOption
*
* @since 15.0.0
*
* @param ISearchOption $option
*
* @return ISearchTemplate
*/
public function addNavigationOption(ISearchOption $option): ISearchTemplate {
$this->navigationOptions[] = $option;
return $this;
}
/**
* Get all options to be displayed in the FullTextSearch navigation page.
*
* @since 15.0.0
*
* @return array
*/
public function getNavigationOptions(): array {
return $this->navigationOptions;
}
/**
* @since 15.0.0
*
* @return array
*/
public function jsonSerialize(): array {
return [
'icon' => $this->getIcon(),
'css' => $this->getCss(),
'template' => $this->getTemplate(),
'panel' => $this->getPanelOptions(),
'navigation' => $this->getNavigationOptions()
];
}
}
|
