Extends QueryBuilder with clauses necessary to sort entity lists by entity properties. More...

Inheritance diagram for Elgg\Database\Clauses\EntitySortByClause:

Public Member Functions

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 Member Functions inherited from Elgg\Database\Clauses\OrderByClause

__construct ($expr=null, $direction=null)

Constructor. More...

Public Attributes
	$property

	$signed

	$join_type

	$property_type

	$inverse_relationship

	$relationship_guid

Public Attributes inherited from Elgg\Database\Clauses\OrderByClause
	$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 clauses necessary to sort entity lists by entity properties.

Definition at line 15 of file EntitySortByClause.php.

Member Function Documentation

◆ prepare()

Elgg\Database\Clauses\EntitySortByClause::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

}}

Exceptions

DomainException

Reimplemented from Elgg\Database\Clauses\OrderByClause.

Definition at line 52 of file EntitySortByClause.php.

Member Data Documentation

◆ $inverse_relationship

Elgg\Database\Clauses\EntitySortByClause::$inverse_relationship

Definition at line 40 of file EntitySortByClause.php.

◆ $join_type

Elgg\Database\Clauses\EntitySortByClause::$join_type

Definition at line 30 of file EntitySortByClause.php.

◆ $property

Elgg\Database\Clauses\EntitySortByClause::$property

Definition at line 20 of file EntitySortByClause.php.

◆ $property_type

Elgg\Database\Clauses\EntitySortByClause::$property_type

Definition at line 35 of file EntitySortByClause.php.

◆ $relationship_guid

Elgg\Database\Clauses\EntitySortByClause::$relationship_guid

Definition at line 45 of file EntitySortByClause.php.

◆ $signed

Elgg\Database\Clauses\EntitySortByClause::$signed

Definition at line 25 of file EntitySortByClause.php.

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

engine/classes/Elgg/Database/Clauses/EntitySortByClause.php