blob: 01b69f5d24cc25553532770c268542bd4e84cfd3 (
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
|
<?php
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Files\Search;
/**
* @since 12.0.0
*
* @psalm-type ParamSingleValue = \DateTime|int|string|bool
* @psalm-type ParamValue = ParamSingleValue|list<ParamSingleValue>
*/
interface ISearchComparison extends ISearchOperator {
/**
* @since 12.0.0
*/
public const COMPARE_EQUAL = 'eq';
/**
* @since 12.0.0
*/
public const COMPARE_GREATER_THAN = 'gt';
/**
* @since 12.0.0
*/
public const COMPARE_GREATER_THAN_EQUAL = 'gte';
/**
* @since 12.0.0
*/
public const COMPARE_LESS_THAN = 'lt';
/**
* @since 12.0.0
*/
public const COMPARE_LESS_THAN_EQUAL = 'lte';
/**
* @since 12.0.0
*/
public const COMPARE_LIKE = 'like';
/**
* @since 23.0.0
*/
public const COMPARE_LIKE_CASE_SENSITIVE = 'clike';
/**
* @since 28.0.0
*/
public const COMPARE_DEFINED = 'is-defined';
/**
* @since 29.0.0
*/
public const COMPARE_IN = 'in';
/**
* @since 23.0.0
*/
public const HINT_PATH_EQ_HASH = 'path_eq_hash'; // transform `path = "$path"` into `path_hash = md5("$path")`, on by default
/**
* Get the type of comparison, one of the ISearchComparison::COMPARE_* constants
*
* @return string
* @since 12.0.0
*/
public function getType(): string;
/**
* Get the name of the field to compare with
*
* i.e. 'size', 'name' or 'mimetype'
*
* @return string
* @since 12.0.0
*/
public function getField(): string;
/**
* extra means data are not related to the main files table
*
* @return string
* @since 28.0.0
*/
public function getExtra(): string;
/**
* Get the value to compare the field with
*
* @return ParamValue
* @since 12.0.0
*/
public function getValue(): string|int|bool|\DateTime|array;
}
|
