Class OrderClauseExpression
An expression object for complex ORDER BY clauses
Property Summary
-
$_direction protected
stringThe direction of sorting.
-
$_field protected
Cake\Database\ExpressionInterface|array|stringThe field name or expression to be used in the left hand side of the operator
Method Summary
-
__clone() public
Create a deep clone of the order clause.
-
__construct() public
Constructor
-
getField() public
Returns the field name
-
setField() public
Sets the field name
-
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, passing as first parameter the instance of the expression currently being iterated.
Method Detail
__construct() ¶ public
__construct(Cake\Database\ExpressionInterface|string $field, string $direction)Constructor
Parameters
-
Cake\Database\ExpressionInterface|string$field The field to order on.
-
string$direction The direction to sort on.
getField() ¶ public
getField(): Cake\Database\ExpressionInterface|array|stringReturns the field name
Returns
Cake\Database\ExpressionInterface|array|stringsetField() ¶ public
setField(Cake\Database\ExpressionInterface|array|string $field): voidSets the field name
Parameters
-
Cake\Database\ExpressionInterface|array|string$field The field to compare with.
Returns
voidsql() ¶ 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, passing as first parameter the instance of the expression currently being iterated.
Parameters
-
Closure$callback
Returns
$this