DBAccessObjectUtils Class Reference

Helper class for DAO classes. More...

Inheritance diagram for DBAccessObjectUtils:

Collaboration diagram for DBAccessObjectUtils:

Static Public Member Functions
static	getDBFromIndex (IConnectionProvider $dbProvider, int $index)
	Takes $index from ::getDBOptions() and return proper Database object. More...
static	getDBOptions ( $bitfield)
	Get an appropriate DB index, options, and fallback DB index for a query. More...
static	hasFlags ( $bitfield, $flags)

Additional Inherited Members
Public Attributes inherited from IDBAccessObject
const	READ_NONE = -1
	Constants for object loading bitfield flags (higher => higher QoS) More...

Detailed Description

Helper class for DAO classes.

Since

1.26

Definition at line 32 of file DBAccessObjectUtils.php.

Member Function Documentation

getDBFromIndex()

static DBAccessObjectUtils::getDBFromIndex ( IConnectionProvider  $dbProvider, int  $index  )

static

Takes $index from ::getDBOptions() and return proper Database object.

Use of this function (and getDBOptions) is discouraged.

Parameters

IConnectionProvider	$dbProvider
int	$index	either DB_REPLICA or DB_PRIMARY

Returns

IReadableDatabase

Definition at line 94 of file DBAccessObjectUtils.php.

References Wikimedia\Rdbms\IConnectionProvider\getPrimaryDatabase().

Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\testUserExists(), and MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\testUserExists().

getDBOptions()

static DBAccessObjectUtils::getDBOptions (   $bitfield )

static

Get an appropriate DB index, options, and fallback DB index for a query.

The fallback DB index and options are to be used if the entity is not found with the initial DB index, typically querying the primary DB to avoid lag

Parameters

int

$bitfield

Bitfield of IDBAccessObject::READ_* constants

Returns

array List of DB indexes and options in this order:

• DB_PRIMARY or DB_REPLICA constant for the initial query
• SELECT options array for the initial query
• DB_PRIMARY constant for the fallback query; null if no fallback should happen
• SELECT options array for the fallback query; empty if no fallback should happen

Definition at line 55 of file DBAccessObjectUtils.php.

References DB_PRIMARY, and DB_REPLICA.

Referenced by MediaWiki\Revision\RevisionStore\getRecentChange(), MediaWiki\User\User\idForName(), MediaWiki\User\User\load(), MediaWiki\User\User\loadFromDatabase(), WikiPage\loadPageData(), MediaWiki\User\UserFactory\newFromConfirmationCode(), MediaWiki\Title\Title\newFromID(), MediaWiki\Page\WikiPageFactory\newFromID(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\testUserExists(), and MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\testUserExists().

hasFlags()

static DBAccessObjectUtils::hasFlags (   $bitfield,   $flags  )

static

Parameters

int	$bitfield
int	$flags	IDBAccessObject::READ_* constant

Returns

bool Bitfield has flag $flag set

Definition at line 38 of file DBAccessObjectUtils.php.

Referenced by MediaWiki\User\User\loadFromId().

---

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

• includes/libs/rdbms/DBAccessObjectUtils.php