Elgg\Database\Clauses\JoinClause Class Reference

Extends QueryBuilder with JOIN clauses. More...

Inheritance diagram for Elgg\Database\Clauses\JoinClause:

Public Member Functions
	__construct ($joined_table, $joined_alias=null, $condition=null, $join_type='inner')
	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
	$joined_table
	$joined_alias
	$condition
	$join_type

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 JOIN clauses.

Definition at line 11 of file JoinClause.php.

Constructor & Destructor Documentation

__construct()

Elgg\Database\Clauses\JoinClause::__construct	(		$joined_table,
			$joined_alias = null,
			$condition = null,
			$join_type = 'inner'
	)

Constructor.

Parameters

string	$joined_table	Table to join
string	$joined_alias	Alias of the joined table
CompositeExpression | \Closure | string	$condition	On expression
string	$join_type	Join type INNER|LEFT|RIGHT

Definition at line 41 of file JoinClause.php.

Member Function Documentation

prepare()

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

Definition at line 51 of file JoinClause.php.

Member Data Documentation

$condition

Elgg\Database\Clauses\JoinClause::$condition

Definition at line 26 of file JoinClause.php.

$join_type

Elgg\Database\Clauses\JoinClause::$join_type

Definition at line 31 of file JoinClause.php.

$joined_alias

Elgg\Database\Clauses\JoinClause::$joined_alias

Definition at line 21 of file JoinClause.php.

$joined_table

Elgg\Database\Clauses\JoinClause::$joined_table

Definition at line 16 of file JoinClause.php.

---

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

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