MediaWiki  master
Wikimedia\Rdbms\JoinGroupBase Class Reference

A class for code shared between SelectQueryBuilder and JoinGroup. More...

Inheritance diagram for Wikimedia\Rdbms\JoinGroupBase:

Public Member Functions

 join ( $table, $alias=null, $conds=[])
 Inner join a table or group of tables. More...
 
 leftJoin ( $table, $alias=null, $conds=[])
 Left join a table or group of tables. More...
 
 table ( $table, $alias=null)
 Add a single table or a single parenthesized group. More...
 

Protected Member Functions

 getAutoAlias ()
 

Protected Attributes

array $joinConds = []
 
 $lastAlias
 
array $tables = []
 

Private Member Functions

 addJoin ( $type, $table, $alias, $joinConds)
 Private helper for functions that add joins. More...
 

Detailed Description

A class for code shared between SelectQueryBuilder and JoinGroup.

Represents tables and join conditions.

Definition at line 9 of file JoinGroupBase.php.

Member Function Documentation

◆ addJoin()

Wikimedia\Rdbms\JoinGroupBase::addJoin (   $type,
  $table,
  $alias,
  $joinConds 
)
private

Private helper for functions that add joins.

Parameters
string$type
string | JoinGroup | SelectQueryBuilder$table
string | null$alias
string | array$joinConds

Definition at line 92 of file JoinGroupBase.php.

References Wikimedia\Rdbms\JoinGroupBase\$joinConds, $type, and Wikimedia\Rdbms\JoinGroupBase\getAutoAlias().

Referenced by Wikimedia\Rdbms\JoinGroupBase\join(), and Wikimedia\Rdbms\JoinGroupBase\leftJoin().

◆ getAutoAlias()

Wikimedia\Rdbms\JoinGroupBase::getAutoAlias ( )
abstractprotected

◆ join()

Wikimedia\Rdbms\JoinGroupBase::join (   $table,
  $alias = null,
  $conds = [] 
)

Inner join a table or group of tables.

This should be called after table().

Parameters
string | JoinGroup | SelectQueryBuilder$tableThe table name, or a JoinGroup containing multiple tables, or a SelectQueryBuilder representing a subquery.
string | null$aliasThe alias name, or null to automatically generate an alias which will be unique to this builder
string | array$condsThe conditions for the ON clause
Returns
$this

Definition at line 80 of file JoinGroupBase.php.

References Wikimedia\Rdbms\JoinGroupBase\addJoin().

◆ leftJoin()

Wikimedia\Rdbms\JoinGroupBase::leftJoin (   $table,
  $alias = null,
  $conds = [] 
)

Left join a table or group of tables.

This should be called after table().

Parameters
string | JoinGroup | SelectQueryBuilder$tableThe table name, or a JoinGroup containing multiple tables, or a SelectQueryBuilder representing a subquery.
string | null$aliasThe alias name, or null to automatically generate an alias which will be unique to this builder
string | array$condsThe conditions for the ON clause
Returns
$this

Definition at line 64 of file JoinGroupBase.php.

References Wikimedia\Rdbms\JoinGroupBase\addJoin().

◆ table()

Wikimedia\Rdbms\JoinGroupBase::table (   $table,
  $alias = null 
)

Add a single table or a single parenthesized group.

Parameters
string | JoinGroup | SelectQueryBuilder$tableThe table to add. If this is a string, it is the table name. If it is a JoinGroup created by SelectQueryBuilder::newJoinGroup(), the group will be added. If it is a SelectQueryBuilder, a table subquery will be added.
string | null$aliasThe table alias, or null for no alias
Returns
$this

Definition at line 28 of file JoinGroupBase.php.

References Wikimedia\Rdbms\JoinGroupBase\getAutoAlias().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\from(), and Wikimedia\Rdbms\SelectQueryBuilder\tables().

Member Data Documentation

◆ $joinConds

array Wikimedia\Rdbms\JoinGroupBase::$joinConds = []
protected

◆ $lastAlias

Wikimedia\Rdbms\JoinGroupBase::$lastAlias
protected

Definition at line 16 of file JoinGroupBase.php.

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\setIndexHint().

◆ $tables


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