blob: 81087101544d240aec4cabc13a85eda689b24961 (
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
|
<?php
declare(strict_types=1);
/**
* FullTextSearch - Full text search framework for Nextcloud
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2018
* @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 IIndexOptions
*
* IndexOptions are created in FullTextSearch when an admin initiate an index
* from the command line:
*
* ./occ fulltextsearch:index "{\"option1\": \"value\", \"option2\": true}"
*
* @since 15.0.0
*
* @package OCP\FullTextSearch\Model
*/
interface IIndexOptions {
/**
* Get the value (as a string) for an option.
*
* @since 15.0.0
*
* @param string $option
* @param string $default
*
* @return string
*/
public function getOption(string $option, string $default = ''): string;
/**
* Get the value (as an array) for an option.
*
* @since 15.0.0
*
* @param string $option
* @param array $default
*
* @return array
*/
public function getOptionArray(string $option, array $default = []): array;
/**
* Get the value (as an boolean) for an option.
*
* @since 15.0.0
*
* @param string $option
* @param bool $default
*
* @return bool
*/
public function getOptionBool(string $option, bool $default): bool;
}
|
