FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
database/Expression/WindowExpression.php at 5.x · cakephp/database · GitHub
cakephp
/
database
Public
Notifications
You must be signed in to change notification settings
Fork
13
Star
98
Code
Actions
Security and quality
0
Insights
Additional navigation options
Code
Actions
Security and quality
Insights
Expand file tree
Breadcrumbs
database
/
Expression
/
WindowExpression.php
Copy path
More file actions
More file actions
Latest commit
History
History
History
348 lines (296 loc) · 8.48 KB
Breadcrumbs
database
/
Expression
/
WindowExpression.php
Copy path
File metadata and controls
348 lines (296 loc) · 8.48 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
<?php
declare
(strict_types=
1
);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 4.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace
Cake
\
Database
\
Expression
;
use
Cake
\
Database
\
ExpressionInterface
;
use
Cake
\
Database
\
ValueBinder
;
use
Closure
;
use
function
Cake
\
Core
\
deprecationWarning
;
/**
* This represents a SQL window expression used by aggregate and window functions.
*/
class
WindowExpression
implements
ExpressionInterface, WindowInterface
{
/**
* @var \Cake\Database\Expression\IdentifierExpression
*/
protected
IdentifierExpression
$
name
;
/**
* @var array<\Cake\Database\ExpressionInterface>
*/
protected
array
$
partitions
= [];
/**
* @var \Cake\Database\Expression\OrderByExpression|null
*/
protected
?
OrderByExpression
$
order
=
null
;
/**
* @var array|null
*/
protected
?
array
$
frame
=
null
;
/**
* @var string|null
*/
protected
?
string
$
exclusion
=
null
;
/**
* @param string $name Window name
*/
public
function
__construct
(
string
$
name
=
''
)
{
$
this
->
name
=
new
IdentifierExpression
(
$
name
);
}
/**
* Return whether is only a named window expression.
*
* These window expressions only specify a named window and do not
* specify their own partitions, frame or order.
*
* @return bool
*/
public
function
isNamedOnly
():
bool
{
return
$
this
->
name
->
getIdentifier
() && (!
$
this
->
partitions
&& !
$
this
->
frame
&& !
$
this
->
order
);
}
/**
* Sets the window name.
*
* @param string $name Window name
* @return $this
*/
public
function
name
(
string
$
name
)
{
$
this
->
name
=
new
IdentifierExpression
(
$
name
);
return
$
this
;
}
/**
* @inheritDoc
*/
public
function
partition
(
ExpressionInterface
|
Closure
|
array
|
string
$
partitions
)
{
if
(!
$
partitions
) {
return
$
this
;
}
if
(
$
partitions
instanceof
Closure) {
$
partitions
=
$
partitions
(
new
QueryExpression
([], [],
''
));
}
if
(!
is_array
(
$
partitions
)) {
$
partitions
= [
$
partitions
];
}
foreach
(
$
partitions
as
&
$
partition
) {
if
(
is_string
(
$
partition
)) {
$
partition
=
new
IdentifierExpression
(
$
partition
);
}
}
$
this
->
partitions
=
array_merge
(
$
this
->
partitions
,
$
partitions
);
return
$
this
;
}
/**
* @inheritDoc
*/
public
function
order
(
ExpressionInterface
|
Closure
|
array
|
string
$
fields
)
{
deprecationWarning
(
'
5.0.0
'
,
'
WindowExpression::order() is deprecated. Use WindowExpression::orderBy() instead.
'
,
);
return
$
this
->
orderBy
(
$
fields
);
}
/**
* @inheritDoc
*/
public
function
orderBy
(
ExpressionInterface
|
Closure
|
array
|
string
$
fields
)
{
if
(!
$
fields
) {
return
$
this
;
}
$
this
->
order
??=
new
OrderByExpression
();
if
(
$
fields
instanceof
Closure) {
$
fields
=
$
fields
(
new
QueryExpression
([], [],
''
));
}
$
this
->
order
->
add
(
$
fields
);
return
$
this
;
}
/**
* @inheritDoc
*/
public
function
range
(
ExpressionInterface
|
string
|
int
|
null
$
start
,
ExpressionInterface
|
string
|
int
|
null
$
end
=
0
)
{
return
$
this
->
frame
(
self
::
RANGE
,
$
start
,
self
::
PRECEDING
,
$
end
,
self
::
FOLLOWING
);
}
/**
* @inheritDoc
*/
public
function
rows
(?
int
$
start
, ?
int
$
end
=
0
)
{
return
$
this
->
frame
(
self
::
ROWS
,
$
start
,
self
::
PRECEDING
,
$
end
,
self
::
FOLLOWING
);
}
/**
* @inheritDoc
*/
public
function
groups
(?
int
$
start
, ?
int
$
end
=
0
)
{
return
$
this
->
frame
(
self
::
GROUPS
,
$
start
,
self
::
PRECEDING
,
$
end
,
self
::
FOLLOWING
);
}
/**
* @inheritDoc
*/
public
function
frame
(
string
$
type
,
ExpressionInterface
|
string
|
int
|
null
$
startOffset
,
string
$
startDirection
,
ExpressionInterface
|
string
|
int
|
null
$
endOffset
,
string
$
endDirection
,
) {
$
this
->
frame
= [
'
type
'
=>
$
type
,
'
start
'
=> [
'
offset
'
=>
$
startOffset
,
'
direction
'
=>
$
startDirection
,
],
'
end
'
=> [
'
offset
'
=>
$
endOffset
,
'
direction
'
=>
$
endDirection
,
],
];
return
$
this
;
}
/**
* @inheritDoc
*/
public
function
excludeCurrent
()
{
$
this
->
exclusion
=
'
CURRENT ROW
'
;
return
$
this
;
}
/**
* @inheritDoc
*/
public
function
excludeGroup
()
{
$
this
->
exclusion
=
'
GROUP
'
;
return
$
this
;
}
/**
* @inheritDoc
*/
public
function
excludeTies
()
{
$
this
->
exclusion
=
'
TIES
'
;
return
$
this
;
}
/**
* @inheritDoc
*/
public
function
sql
(
ValueBinder
$
binder
):
string
{
$
clauses
= [];
if
(
$
this
->
name
->
getIdentifier
()) {
$
clauses
[] =
$
this
->
name
->
sql
(
$
binder
);
}
if
(
$
this
->
partitions
) {
$
expressions
= [];
foreach
(
$
this
->
partitions
as
$
partition
) {
$
expressions
[] =
$
partition
->
sql
(
$
binder
);
}
$
clauses
[] =
'
PARTITION BY
'
.
implode
(
'
,
'
,
$
expressions
);
}
if
(
$
this
->
order
) {
$
clauses
[] =
$
this
->
order
->
sql
(
$
binder
);
}
if
(
$
this
->
frame
) {
$
start
=
$
this
->
buildOffsetSql
(
$
binder
,
$
this
->
frame
[
'
start
'
][
'
offset
'
],
$
this
->
frame
[
'
start
'
][
'
direction
'
],
);
$
end
=
$
this
->
buildOffsetSql
(
$
binder
,
$
this
->
frame
[
'
end
'
][
'
offset
'
],
$
this
->
frame
[
'
end
'
][
'
direction
'
],
);
$
frameSql
=
sprintf
(
'
%s BETWEEN %s AND %s
'
,
$
this
->
frame
[
'
type
'
],
$
start
,
$
end
);
if
(
$
this
->
exclusion
!==
null
) {
$
frameSql
.=
'
EXCLUDE
'
.
$
this
->
exclusion
;
}
$
clauses
[] =
$
frameSql
;
}
return
implode
(
'
'
,
$
clauses
);
}
/**
* @inheritDoc
*/
public
function
traverse
(
Closure
$
callback
)
{
$
callback
(
$
this
->
name
);
foreach
(
$
this
->
partitions
as
$
partition
) {
$
callback
(
$
partition
);
$
partition
->
traverse
(
$
callback
);
}
if
(
$
this
->
order
) {
$
callback
(
$
this
->
order
);
$
this
->
order
->
traverse
(
$
callback
);
}
if
(
$
this
->
frame
!==
null
) {
$
offset
=
$
this
->
frame
[
'
start
'
][
'
offset
'
];
if
(
$
offset
instanceof
ExpressionInterface) {
$
callback
(
$
offset
);
$
offset
->
traverse
(
$
callback
);
}
$
offset
=
$
this
->
frame
[
'
end
'
][
'
offset
'
] ??
null
;
if
(
$
offset
instanceof
ExpressionInterface) {
$
callback
(
$
offset
);
$
offset
->
traverse
(
$
callback
);
}
}
return
$
this
;
}
/**
* Builds frame offset sql.
*
* @param \Cake\Database\ValueBinder $binder Value binder
* @param \Cake\Database\ExpressionInterface|string|int|null $offset Frame offset
* @param string $direction Frame offset direction
* @return string
*/
protected
function
buildOffsetSql
(
ValueBinder
$
binder
,
ExpressionInterface
|
string
|
int
|
null
$
offset
,
string
$
direction
,
):
string
{
if
(
$
offset
===
0
) {
return
'
CURRENT ROW
'
;
}
if
(
$
offset
instanceof
ExpressionInterface) {
$
offset
=
$
offset
->
sql
(
$
binder
);
}
return
sprintf
(
'
%s %s
'
,
$
offset
??
'
UNBOUNDED
'
,
$
direction
,
);
}
/**
* Clone this object and its subtree of expressions.
*/
public
function
__clone
()
{
$
this
->
name
=
clone
$
this
->
name
;
foreach
(
$
this
->
partitions
as
$
i
=>
$
partition
) {
$
this
->
partitions
[
$
i
] =
clone
$
partition
;
}
if
(
$
this
->
order
!==
null
) {
$
this
->
order
=
clone
$
this
->
order
;
}
}
}
Back
|
FazBrowse Home
|
New Git URL