Elgg\Database\Clauses\RelationshipWhereClause Class Reference

Builds clauses for filtering entities by their properties in entity_relationships table. More...

Inheritance diagram for Elgg\Database\Clauses\RelationshipWhereClause:

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\WhereClause
	__construct ($expr=null)
	Constructor. More...

Static Public Member Functions
static	factory (array $attributes)
	Build a new RelationshipWhereClause. More...

Public Attributes
	$ids
	$names
	$guid_one
	$guid_two
	$created_after
	$created_before
bool	$inverse = false
string	$join_on = 'guid'
Public Attributes inherited from Elgg\Database\Clauses\WhereClause
	$expr

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

Builds clauses for filtering entities by their properties in entity_relationships table.

Definition at line 10 of file RelationshipWhereClause.php.

Member Function Documentation

factory()

static Elgg\Database\Clauses\RelationshipWhereClause::factory ( array  $attributes )

static

Build a new RelationshipWhereClause.

Parameters

array

$attributes

parameters for clause

Returns

static

Since

6.3

Definition at line 80 of file RelationshipWhereClause.php.

prepare()

Elgg\Database\Clauses\RelationshipWhereClause::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\WhereClause.

Definition at line 53 of file RelationshipWhereClause.php.

Member Data Documentation

$created_after

Elgg\Database\Clauses\RelationshipWhereClause::$created_after

Definition at line 39 of file RelationshipWhereClause.php.

$created_before

Elgg\Database\Clauses\RelationshipWhereClause::$created_before

Definition at line 44 of file RelationshipWhereClause.php.

$guid_one

Elgg\Database\Clauses\RelationshipWhereClause::$guid_one

Definition at line 27 of file RelationshipWhereClause.php.

$guid_two

Elgg\Database\Clauses\RelationshipWhereClause::$guid_two

Definition at line 34 of file RelationshipWhereClause.php.

$ids

Elgg\Database\Clauses\RelationshipWhereClause::$ids

Definition at line 15 of file RelationshipWhereClause.php.

$inverse

bool Elgg\Database\Clauses\RelationshipWhereClause::$inverse = false

Definition at line 46 of file RelationshipWhereClause.php.

$join_on

string Elgg\Database\Clauses\RelationshipWhereClause::$join_on = 'guid'

Definition at line 48 of file RelationshipWhereClause.php.

$names

Elgg\Database\Clauses\RelationshipWhereClause::$names

Definition at line 20 of file RelationshipWhereClause.php.

---

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

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