W3cubDocs

/CakePHP 3.8

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

  • $_direction protected
    string
    The 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

__clone()source public

__clone( )

Create a deep clone of the order clause.

__construct()source 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()source public

sql( Cake\Database\ValueBinder $generator )

Converts the Node into a SQL string fragment.

Parameters

Cake\Database\ValueBinder $generator
Placeholder generator object

Returns

string

Implementation of

Cake\Database\ExpressionInterface::sql()

traverse()source 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

Cake\Database\ExpressionInterface::traverse()

Methods used from Cake\Database\Expression\FieldTrait

getField()source public

getField( )

Returns the field name

Returns

string|Cake\Database\ExpressionInterface

setField()source public

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

Sets the field name

Parameters

string|Cake\Database\ExpressionInterface $field
The field to compare with.

Properties detail

$_directionsource

protected string

The direction of sorting.

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.Database.Expression.OrderClauseExpression.html