\Cake\Database\ExpressionOrderClauseExpression

An expression object for complex ORDER BY clauses

Summary

Methods
Properties
Constants
setField()
getField()
__construct()
sql()
traverse()
__clone()
No public properties found
No constants found
No protected methods found
$_field
$_direction
N/A
No private methods found
No private properties found
N/A

Properties

$_field

$_field : string|\Cake\Database\ExpressionInterface

The field name or expression to be used in the left hand side of the operator

Type

string|\Cake\Database\ExpressionInterface

$_direction

$_direction : string

The direction of sorting.

Type

string

Methods

setField()

setField(string|\Cake\Database\ExpressionInterface  $field) : void

Sets the field name

Parameters

string|\Cake\Database\ExpressionInterface $field

The field to compare with.

__construct()

__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()

sql(\Cake\Database\ValueBinder  $generator) : string

Converts the Node into a SQL string fragment.

Parameters

\Cake\Database\ValueBinder $generator

Placeholder generator object

Returns

string

traverse()

traverse(callable  $visitor) : void

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.

__clone()

__clone() : void

Create a deep clone of the order clause.