Elgg  Version 3.0
Public Member Functions | Public Attributes | List of all members
Elgg\Database\Clauses\JoinClause Class Reference

Extends QueryBuilder with JOIN clauses. More...

Inheritance diagram for Elgg\Database\Clauses\JoinClause:
Elgg\Database\Clauses\Clause

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$qbQuery builder
string$table_aliasTable alias
Returns
CompositeExpression|null|string
} More...
 

Public Attributes

 $joined_table
 
 $joined_alias
 
 $condition
 
 $join_type
 

Detailed Description

Extends QueryBuilder with JOIN clauses.

Definition at line 12 of file JoinClause.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters
string$joined_tableTable to join
string$joined_aliasAlias of the joined table
CompositeExpression | Closure | string$conditionOn expression
string$join_typeJoin type INNER|LEFT|RIGHT

Definition at line 42 of file JoinClause.php.

Member Function Documentation

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$qbQuery builder
string$table_aliasTable alias
Returns
CompositeExpression|null|string
}

Implements Elgg\Database\Clauses\Clause.

Definition at line 52 of file JoinClause.php.

Member Data Documentation

Elgg\Database\Clauses\JoinClause::$condition

Definition at line 27 of file JoinClause.php.

Elgg\Database\Clauses\JoinClause::$join_type

Definition at line 32 of file JoinClause.php.

Elgg\Database\Clauses\JoinClause::$joined_alias

Definition at line 22 of file JoinClause.php.

Elgg\Database\Clauses\JoinClause::$joined_table

Definition at line 17 of file JoinClause.php.


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