Class OrderClauseExpression
An expression object for complex ORDER BY clauses
Properties summary
-
$_direction protected
stringThe direction of sorting.
-
$_field protected
string|array|\Cake\Database\ExpressionInterfaceThe 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 $visitor callable passing as first parameter the instance of the expression currently being iterated.
Method Detail
__construct() public ¶
__construct(mixed $field, mixed $direction)
Constructor
Parameters
-
\Cake\Database\ExpressionInterface|string$field The field to order on.
-
string$direction The direction to sort on.
getField() public ¶
getField()
Returns the field name
Returns
string|array|\Cake\Database\ExpressionInterfacesetField() public ¶
setField(mixed $field)
Sets the field name
Parameters
-
string|array|\Cake\Database\ExpressionInterface$field The field to compare with.
sql() public ¶
sql(\Cake\Database\ValueBinder $generator)
Converts the Node into a SQL string fragment.
Parameters
-
\Cake\Database\ValueBinder$generator Placeholder generator object
Returns
stringtraverse() public ¶
traverse(\Closure $visitor)
Iterates over each part of the expression recursively for every level of the expressions tree and executes the $visitor callable passing as first parameter the instance of the expression currently being iterated.
Parameters
-
\Closure$visitor The callable to apply to all nodes.
Returns
$this