blob: 86b2bb655fff6e32a47f9a530df079a143a03f0c (
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
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Search;
use InvalidArgumentException;
/**
* Filter definition
*
* Describe filter attributes
*
* @since 28.0.0
*/
class FilterDefinition {
/**
* @since 28.0.0
*/
public const TYPE_BOOL = 'bool';
/**
* @since 28.0.0
*/
public const TYPE_INT = 'int';
/**
* @since 28.0.0
*/
public const TYPE_FLOAT = 'float';
/**
* @since 28.0.0
*/
public const TYPE_STRING = 'string';
/**
* @since 28.0.0
*/
public const TYPE_STRINGS = 'strings';
/**
* @since 28.0.0
*/
public const TYPE_DATETIME = 'datetime';
/**
* @since 28.0.0
*/
public const TYPE_PERSON = 'person';
/**
* @since 28.0.0
*/
public const TYPE_NC_USER = 'nc-user';
/**
* @since 28.0.0
*/
public const TYPE_NC_GROUP = 'nc-group';
/**
* Build filter definition
*
* @param self::TYPE_* $type
* @param bool $exclusive If true, all providers not supporting this filter will be ignored when this filter is provided
* @throws InvalidArgumentException in case of invalid name. Allowed characters are -, 0-9, a-z.
* @since 28.0.0
*/
public function __construct(
private string $name,
private string $type = self::TYPE_STRING,
private bool $exclusive = true,
) {
if (!preg_match('/[-0-9a-z]+/Au', $name)) {
throw new InvalidArgumentException('Invalid filter name. Allowed characters are [-0-9a-z]');
}
}
/**
* Filter name
*
* Name is used in query string and for advanced syntax `name: <value>`
*
* @since 28.0.0
*/
public function name(): string {
return $this->name;
}
/**
* Filter type
*
* Expected type of value for the filter
*
* @return self::TYPE_*
* @since 28.0.0
*/
public function type(): string {
return $this->type;
}
/**
* Is filter exclusive?
*
* If exclusive, only provider with support for this filter will receive the query.
* Example: if an exclusive filter `mimetype` is declared, a search with this term will not
* be send to providers like `settings` that doesn't support it.
*
* @since 28.0.0
*/
public function exclusive(): bool {
return $this->exclusive;
}
}
|
