blob: 951da3b9a76f1078e27808f3a0145b08a8974175 (
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
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
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
*
*/
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;
}
|
