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
|
<?php
/**
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
*
* @author Robin Appelman <robin@icewind.nl>
*
* @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\DB\QueryBuilder;
/**
* This class provides a builder for sql some functions
*
* @since 12.0.0
*/
interface IFunctionBuilder {
/**
* Calculates the MD5 hash of a given input
*
* @param mixed $input The input to be hashed
*
* @return IQueryFunction
* @since 12.0.0
*/
public function md5($input);
/**
* Combines two input strings
*
* @param mixed $x The first input string
* @param mixed $y The seccond input string
*
* @return IQueryFunction
* @since 12.0.0
*/
public function concat($x, $y);
/**
* Takes a substring from the input string
*
* @param mixed $input The input string
* @param mixed $start The start of the substring, note that counting starts at 1
* @param mixed $length The length of the substring
*
* @return IQueryFunction
* @since 12.0.0
*/
public function substring($input, $start, $length = null);
/**
* Takes the sum of all rows in a column
*
* @param mixed $field the column to sum
*
* @return IQueryFunction
* @since 12.0.0
*/
public function sum($field);
/**
* Transforms a string field or value to lower case
*
* @param mixed $field
* @return IQueryFunction
* @since 14.0.0
*/
public function lower($field);
/**
* @param mixed $x The first input field or number
* @param mixed $y The second input field or number
* @return IQueryFunction
* @since 14.0.0
*/
public function add($x, $y);
/**
* @param mixed $x The first input field or number
* @param mixed $y The second input field or number
* @return IQueryFunction
* @since 14.0.0
*/
public function subtract($x, $y);
/**
* @param mixed $count The input to be counted
* @param string $alias Alias for the counter
*
* @return IQueryFunction
* @since 14.0.0
*/
public function count($count = '', $alias = '');
/**
* Takes the maximum of all rows in a column
*
* If you want to get the maximum value of multiple columns in the same row, use `greatest` instead
*
* @param mixed $field the column to maximum
*
* @return IQueryFunction
* @since 18.0.0
*/
public function max($field);
/**
* Takes the minimum of all rows in a column
*
* If you want to get the minimum value of multiple columns in the same row, use `least` instead
*
* @param mixed $field the column to minimum
*
* @return IQueryFunction
* @since 18.0.0
*/
public function min($field);
/**
* Takes the maximum of multiple values
*
* If you want to get the maximum value of all rows in a column, use `max` instead
*
* @param mixed $x the first input field or number
* @param mixed $y the first input field or number
*
* @return IQueryFunction
* @since 18.0.0
*/
public function greatest($x, $y);
/**
* Takes the minimum of multiple values
*
* If you want to get the minimum value of all rows in a column, use `min` instead
*
* @param mixed $x the first input field or number
* @param mixed $y the first input field or number
*
* @return IQueryFunction
* @since 18.0.0
*/
public function least($x, $y);
}
|
