Elgg\Database\Clauses\OrderByClause Class Reference

Extends QueryBuilder with ORDER BY clauses. More...

Inheritance diagram for Elgg\Database\Clauses\OrderByClause:

Public Member Functions
	__construct ($expr=null, $direction=null)
	Constructor. More...
	prepare (QueryBuilder $qb, $table_alias=null)
	{Build an expression and/or apply it to an instance of query builder. Parameters QueryBuilder $qb Query builder string $table_alias Table alias Returns CompositeExpression|null|string } More...

Public Attributes
	$expr
	$direction

Additional Inherited Members
Protected Member Functions inherited from Elgg\Database\Clauses\Clause
	isCallable ($callback)
	Check if a clause expression is callable. More...
	call ($callback, QueryBuilder $qb, $table_alias=null)
	Call the expression for the clause. More...
	callJoin ($callback, QueryBuilder $qb, $joined_alias, $table_alias=null)
	Call the expression for a join clause. More...

Detailed Description

Extends QueryBuilder with ORDER BY clauses.

Definition at line 11 of file OrderByClause.php.

Constructor & Destructor Documentation

__construct()

Elgg\Database\Clauses\OrderByClause::__construct	(		$expr = null,
			$direction = null
	)

Constructor.

Parameters

CompositeExpression | \Closure | string	$expr	Expression
string	$direction	Direction

Definition at line 29 of file OrderByClause.php.

Member Function Documentation

prepare()

Elgg\Database\Clauses\OrderByClause::prepare	(	QueryBuilder	$qb,
			$table_alias = null
	)

{Build an expression and/or apply it to an instance of query builder.

Parameters

QueryBuilder	$qb	Query builder
string	$table_alias	Table alias

Returns

CompositeExpression|null|string

}

Reimplemented from Elgg\Database\Clauses\Clause.

Reimplemented in Elgg\Database\Clauses\EntitySortByClause.

Definition at line 37 of file OrderByClause.php.

Member Data Documentation

$direction

Elgg\Database\Clauses\OrderByClause::$direction

Definition at line 21 of file OrderByClause.php.

$expr

Elgg\Database\Clauses\OrderByClause::$expr

Definition at line 16 of file OrderByClause.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/Database/Clauses/OrderByClause.php