A class for code shared between SelectQueryBuilder and JoinGroup. More...
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. | |
| straightJoin ( $table, $alias=null, $conds=[]) | |
| Straight 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 = [] |
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
◆ getAutoAlias()
|
abstractprotected |
Reimplemented in Wikimedia\Rdbms\JoinGroup, and Wikimedia\Rdbms\SelectQueryBuilder.
Referenced by 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.
◆ 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.
◆ straightJoin()
| Wikimedia\Rdbms\JoinGroupBase::straightJoin | ( | $table, | |
| $alias = null, | |||
| $conds = [] ) |
Straight 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 96 of file JoinGroupBase.php.
◆ 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
|
protected |
Definition at line 14 of file JoinGroupBase.php.
Referenced by Wikimedia\Rdbms\SelectQueryBuilder\getQueryInfo(), and Wikimedia\Rdbms\JoinGroup\getRawJoinConds().
◆ $lastAlias
|
protected |
Definition at line 16 of file JoinGroupBase.php.
◆ $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
