Class WindowExpression
This represents a SQL window expression used by aggregate and window functions.
Constants
Property Summary
-
$exclusion protected
string|null -
$frame protected
array|null -
$name protected
Cake\Database\Expression\IdentifierExpression -
$order protected
Cake\Database\Expression\OrderByExpression|null -
$partitions protected
Cake\Database\ExpressionInterface[]
Method Summary
-
__clone() public
Clone this object and its subtree of expressions.
-
__construct() public
-
buildOffsetSql() protected
Builds frame offset sql.
-
excludeCurrent() public
Adds current row frame exclusion.
-
excludeGroup() public
Adds group frame exclusion.
-
excludeTies() public
Adds ties frame exclusion.
-
frame() public
Adds a frame to the window.
-
groups() public
Adds a simple groups frame to the window.
-
isNamedOnly() public
Return whether is only a named window expression.
-
name() public
Sets the window name.
-
order() public
Adds one or more order clauses to the window.
-
partition() public
Adds one or more partition expressions to the window.
-
range() public
Adds a simple range frame to the window.
-
rows() public
Adds a simple rows frame to the window.
-
sql() public
Converts the Node into a SQL string fragment.
-
traverse() public
Iterates over each part of the expression recursively for every level of the expressions tree and executes the $callback callable passing as first parameter the instance of the expression currently being iterated.
Method Detail
buildOffsetSql() ¶ protected
buildOffsetSql(Cake\Database\ValueBinder $binder, int|string|Cake\Database\ExpressionInterface|null $offset, string $direction): stringBuilds frame offset sql.
Parameters
-
Cake\Database\ValueBinder$binder Value binder
-
int|string|Cake\Database\ExpressionInterface|null$offset Frame offset
-
string$direction Frame offset direction
Returns
stringframe() ¶ public
frame(string $type, int|string|Cake\Database\ExpressionInterface|null $startOffset, string $startDirection, int|string|Cake\Database\ExpressionInterface|null $endOffset, string $endDirection): $thisAdds a frame to the window.
Use the range(), rows() or groups() helpers if you need simple
'BETWEEN offset PRECEDING and offset FOLLOWING' frames.
You can specify any direction for both frame start and frame end.
With both $startOffset and $endOffset:
0- 'CURRENT ROW'null- 'UNBOUNDED'
Parameters
-
string$type -
int|string|Cake\Database\ExpressionInterface|null$startOffset -
string$startDirection -
int|string|Cake\Database\ExpressionInterface|null$endOffset -
string$endDirection
Returns
$thisgroups() ¶ public
groups(int|null $start, int|null $end = 0): $thisAdds a simple groups frame to the window.
See range() for details.
Parameters
-
int|null$start -
int|null$end optional
Returns
$thisisNamedOnly() ¶ public
isNamedOnly(): boolReturn 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.
Returns
boolname() ¶ public
name(string $name): $thisSets the window name.
Parameters
-
string$name Window name
Returns
$thisorder() ¶ public
order(Closure|(Cake\Database\ExpressionInterface|string)[]|Cake\Database\ExpressionInterface|string $fields): $thisAdds one or more order clauses to the window.
Parameters
-
Closure|(Cake\Database\ExpressionInterface|string)[]|Cake\Database\ExpressionInterface|string$fields
Returns
$thispartition() ¶ public
partition(Closure|(Cake\Database\ExpressionInterface|string)[]|Cake\Database\ExpressionInterface|string $partitions): $thisAdds one or more partition expressions to the window.
Parameters
-
Closure|(Cake\Database\ExpressionInterface|string)[]|Cake\Database\ExpressionInterface|string$partitions
Returns
$thisrange() ¶ public
range(int|string|Cake\Database\ExpressionInterface|null $start, int|string|Cake\Database\ExpressionInterface|null $end = 0): $thisAdds a simple range frame to the window.
$start:
0- 'CURRENT ROW'null- 'UNBOUNDED PRECEDING'- offset - 'offset PRECEDING'
$end:
0- 'CURRENT ROW'null- 'UNBOUNDED FOLLOWING'- offset - 'offset FOLLOWING'
If you need to use 'FOLLOWING' with frame start or
'PRECEDING' with frame end, use frame() instead.
Parameters
-
int|string|Cake\Database\ExpressionInterface|null$start -
int|string|Cake\Database\ExpressionInterface|null$end optional
Returns
$thisrows() ¶ public
rows(int|null $start, int|null $end = 0): $thisAdds a simple rows frame to the window.
See range() for details.
Parameters
-
int|null$start -
int|null$end optional
Returns
$thissql() ¶ public
sql(Cake\Database\ValueBinder $binder): stringConverts the Node into a SQL string fragment.
Parameters
-
Cake\Database\ValueBinder$binder
Returns
stringtraverse() ¶ public
traverse(Closure $callback): $thisIterates over each part of the expression recursively for every level of the expressions tree and executes the $callback callable passing as first parameter the instance of the expression currently being iterated.
Parameters
-
Closure$callback
Returns
$this