OrderBy trait
Framework\Database\Manipulation\Traits\OrderBy
Trait OrderBy.
Defined in libraries/database/src/Manipulation/Traits/OrderBy.php
Methods #
- orderBy()
- Appends columns to the ORDER BY clause.
- orderByAsc()
- Appends columns with the ASC direction to the ORDER BY clause.
- orderByDesc()
- Appends columns with the DESC direction to the ORDER BY clause.
- renderOrderBy()
- Renders the ORDER BY clause.
- addOrderBy()
- Adds a ORDER BY expression.
orderBy()
public function orderBy(Closure|string $column, Closure|string ...$columns): static
Appends columns to the ORDER BY clause.
Parameters
- Closure|string $column - The column name or a subquery
- Closure|string $columns
Returns
static
orderByAsc()
public function orderByAsc(Closure|string $column, Closure|string ...$columns): static
Appends columns with the ASC direction to the ORDER BY clause.
Parameters
- Closure|string $column - The column name or a subquery
- Closure|string $columns
Returns
static
orderByDesc()
public function orderByDesc(Closure|string $column, Closure|string ...$columns): static
Appends columns with the DESC direction to the ORDER BY clause.
Parameters
- Closure|string $column - The column name or a subquery
- Closure|string $columns
Returns
static
renderOrderBy()
protected function renderOrderBy(): ?string
Renders the ORDER BY clause.
Returns
?string
- The ORDER BY clause or null if it was not set
addOrderBy()
private function addOrderBy(Closure|string $column, array $columns, ?string $direction): static
Adds a ORDER BY expression.
Parameters
- Closure|string $column - The column name or a subquery
- array $columns - Extra column names and/or subqueries
- ?string $direction - `ASC`, `DESC` or null for none
Returns
static