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.
	leftJoin ( $table, $alias=null, $conds=[])
	Left join a table or group of tables.
	table ( $table, $alias=null)
	Add a single table or a single parenthesized group.

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.

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

Reimplemented in Wikimedia\Rdbms\JoinGroup, and Wikimedia\Rdbms\SelectQueryBuilder.

Referenced by Wikimedia\Rdbms\JoinGroupBase\addJoin(), and Wikimedia\Rdbms\JoinGroupBase\table().

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	$table	The table name, or a JoinGroup containing multiple tables, or a SelectQueryBuilder representing a subquery.
string | null	$alias	The alias name, or null to automatically generate an alias which will be unique to this builder
string | array	$conds	The 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	$table	The table name, or a JoinGroup containing multiple tables, or a SelectQueryBuilder representing a subquery.
string | null	$alias	The alias name, or null to automatically generate an alias which will be unique to this builder
string | array	$conds	The 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	$table	The 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	$alias	The table alias, or null for no alias

Returns

$this

Definition at line 28 of file JoinGroupBase.php.

References Wikimedia\Rdbms\JoinGroupBase\getAutoAlias().

Referenced by MediaWiki\User\UserSelectQueryBuilder\__construct(), MediaWiki\Page\PageSelectQueryBuilder\__construct(), Wikimedia\Rdbms\SelectQueryBuilder\from(), and Wikimedia\Rdbms\SelectQueryBuilder\tables().

Member Data Documentation

$joinConds

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

protected

Definition at line 14 of file JoinGroupBase.php.

Referenced by Wikimedia\Rdbms\JoinGroupBase\addJoin(), Wikimedia\Rdbms\SelectQueryBuilder\getQueryInfo(), and Wikimedia\Rdbms\JoinGroup\getRawJoinConds().

$lastAlias

Wikimedia\Rdbms\JoinGroupBase::$lastAlias

protected

Definition at line 16 of file JoinGroupBase.php.

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

$tables

array Wikimedia\Rdbms\JoinGroupBase::$tables = []

protected

Definition at line 11 of file JoinGroupBase.php.

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\getQueryInfo(), Wikimedia\Rdbms\JoinGroup\getRawTables(), Wikimedia\Rdbms\SelectQueryBuilder\rawTables(), and Wikimedia\Rdbms\SelectQueryBuilder\tables().

---

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

• includes/libs/rdbms/querybuilder/JoinGroupBase.php