Class OrderClauseExpression
An expression object for complex ORDER BY clauses
- Cake\Database\Expression\OrderClauseExpression implements Cake\Database\ExpressionInterface, Cake\Database\Expression\FieldInterface uses Cake\Database\Expression\FieldTrait
Properties summary
-
$_directionprotectedstringThe direction of sorting.
Inherited Properties
Method Summary
-
__clone() public
Create a deep clone of the order clause. -
__construct() public
Constructor -
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( 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.
sql() public ¶
sql( Cake\Database\ValueBinder $generator )
Converts the Node into a SQL string fragment.
Parameters
- Cake\Database\ValueBinder $generator
- Placeholder generator object
Returns
Implementation of
traverse() public ¶
traverse( callable $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
- callable $visitor
- The callable to apply to all nodes.
Implementation of
Methods used from Cake\Database\Expression\FieldTrait
setField() public ¶
setField( string|Cake\Database\ExpressionInterface $field )
Sets the field name
Parameters
-
string|
Cake\Database\ExpressionInterface$field - The field to compare with.