Inheritance diagram for MediaWiki\Page\PageStore:

[legend]

Collaboration diagram for MediaWiki\Page\PageStore:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, ILoadBalancer $dbLoadBalancer, NamespaceInfo $namespaceInfo, TitleParser $titleParser, ?LinkCache $linkCache, ?StatsdDataFactoryInterface $stats, $wikiId=WikiAwareEntity::LOCAL)

	getExistingPageByText (string $text, int $defaultNamespace=NS_MAIN, int $queryFlags=self::READ_NORMAL)

	getPageById (int $pageId, int $queryFlags=self::READ_NORMAL)

	getPageByName (int $namespace, string $dbKey, int $queryFlags=self::READ_NORMAL)

	getPageByReference (PageReference $page, int $queryFlags=self::READ_NORMAL)

	getPageByText (string $text, int $defaultNamespace=NS_MAIN, int $queryFlags=self::READ_NORMAL)

	getPageForLink (LinkTarget $link, int $queryFlags=self::READ_NORMAL)

	getSelectFields ()

	getSubpages (PageIdentity $page, int $limit)
	Get all subpages of this page.

	newPageRecordFromRow (stdClass $row)

	newSelectQueryBuilder ( $dbOrFlags=self::READ_NORMAL)

Public Attributes
const	CONSTRUCTOR_OPTIONS

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

Private Member Functions
	getDBConnectionRef (int $mode=DB_REPLICA)

	getPageByNameViaLinkCache (int $namespace, string $dbKey, int $queryFlags=self::READ_NORMAL)

	incrementStats (string $metric)

	loadPageFromConditions (array $conds, int $queryFlags=self::READ_NORMAL)

Private Attributes
ILoadBalancer	$dbLoadBalancer

LinkCache null	$linkCache

NamespaceInfo	$namespaceInfo

ServiceOptions	$options

StatsdDataFactoryInterface	$stats

TitleParser	$titleParser

string false	$wikiId

Detailed Description

Since: 1.36

Stability: unstable

Definition at line 29 of file PageStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Page\PageStore::__construct	(	ServiceOptions	$options,
		ILoadBalancer	$dbLoadBalancer,
		NamespaceInfo	$namespaceInfo,
		TitleParser	$titleParser,
		?LinkCache	$linkCache,
		?StatsdDataFactoryInterface	$stats,
			$wikiId = `WikiAwareEntity::LOCAL`
	)

Parameters

ServiceOptions	$options
ILoadBalancer	$dbLoadBalancer
NamespaceInfo	$namespaceInfo
TitleParser	$titleParser
	?LinkCache	$linkCache
	?StatsdDataFactoryInterface	$stats
false \| string	$wikiId

Definition at line 68 of file PageStore.php.

References MediaWiki\Page\PageStore\$dbLoadBalancer, MediaWiki\Page\PageStore\$linkCache, MediaWiki\Page\PageStore\$namespaceInfo, MediaWiki\Page\PageStore\$options, MediaWiki\Page\PageStore\$stats, MediaWiki\Page\PageStore\$titleParser, MediaWiki\Page\PageStore\$wikiId, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ getDBConnectionRef()

MediaWiki\Page\PageStore::getDBConnectionRef ( int $mode = DB_REPLICA )

private

Parameters

int $mode DB_PRIMARY or DB_REPLICA

Returns: IDatabase

Definition at line 425 of file PageStore.php.

◆ getExistingPageByText()

MediaWiki\Page\PageStore::getExistingPageByText	(	string	$text,
		int	$defaultNamespace = `NS_MAIN`,
		int	$queryFlags = `self::READ_NORMAL`
	)

Since: 1.37

Parameters

string	$text
int	$defaultNamespace	Namespace to assume per default (usually NS_MAIN)
int	$queryFlags

Returns: ExistingPageRecord|null

Implements MediaWiki\Page\PageLookup.

Definition at line 271 of file PageStore.php.

◆ getPageById()

MediaWiki\Page\PageStore::getPageById	(	int	$pageId,
		int	$queryFlags = `self::READ_NORMAL`
	)

Parameters

int	$pageId
int	$queryFlags

Returns: ExistingPageRecord|null

Implements MediaWiki\Page\PageLookup.

Definition at line 289 of file PageStore.php.

◆ getPageByName()

MediaWiki\Page\PageStore::getPageByName	(	int	$namespace,
		string	$dbKey,
		int	$queryFlags = `self::READ_NORMAL`
	)

Parameters

int	$namespace
string	$dbKey
int	$queryFlags

Returns: ExistingPageRecord|null

Implements MediaWiki\Page\PageLookup.

Definition at line 140 of file PageStore.php.

◆ getPageByNameViaLinkCache()

MediaWiki\Page\PageStore::getPageByNameViaLinkCache	(	int	$namespace,
		string	$dbKey,
		int	$queryFlags = `self::READ_NORMAL`
	)

private

Parameters

int	$namespace
string	$dbKey
int	$queryFlags

Returns: ExistingPageRecord|null

Definition at line 168 of file PageStore.php.

◆ getPageByReference()

MediaWiki\Page\PageStore::getPageByReference	(	PageReference	$page,
		int	$queryFlags = `self::READ_NORMAL`
	)

Parameters

PageReference	$page
int	$queryFlags

Returns: ExistingPageRecord|null The page's PageRecord, or null if the page was not found.

Implements MediaWiki\Page\PageLookup.

Definition at line 310 of file PageStore.php.

◆ getPageByText()

MediaWiki\Page\PageStore::getPageByText	(	string	$text,
		int	$defaultNamespace = `NS_MAIN`,
		int	$queryFlags = `self::READ_NORMAL`
	)

Since: 1.37

Parameters

string	$text
int	$defaultNamespace	Namespace to assume per default (usually NS_MAIN)
int	$queryFlags

Returns: ProperPageIdentity|null

Implements MediaWiki\Page\PageLookup.

Definition at line 247 of file PageStore.php.

◆ getPageForLink()

MediaWiki\Page\PageStore::getPageForLink	(	LinkTarget	$link,
		int	$queryFlags = `self::READ_NORMAL`
	)

Parameters

LinkTarget	$link
int	$queryFlags

Returns: ProperPageIdentity

Implements MediaWiki\Page\PageLookup.

Definition at line 108 of file PageStore.php.

◆ getSelectFields()

MediaWiki\Page\PageStore::getSelectFields ( )

Access: internal

Returns: string[]

Definition at line 371 of file PageStore.php.

◆ getSubpages()

MediaWiki\Page\PageStore::getSubpages	(	PageIdentity	$page,
		int	$limit
	)

Get all subpages of this page.

Will return an empty list of the namespace doesn't support subpages.

Parameters

PageIdentity	$page
int	$limit	Maximum number of subpages to fetch

Returns: Iterator<ExistingPageRecord>

Definition at line 438 of file PageStore.php.

◆ incrementStats()

MediaWiki\Page\PageStore::incrementStats ( string $metric )

private

Parameters

string $metric

Definition at line 98 of file PageStore.php.

◆ loadPageFromConditions()

MediaWiki\Page\PageStore::loadPageFromConditions	(	array	$conds,
		int	$queryFlags = `self::READ_NORMAL`
	)

private

Parameters

array	$conds
int	$queryFlags

Returns: ExistingPageRecord|null

Definition at line 340 of file PageStore.php.

◆ newPageRecordFromRow()

MediaWiki\Page\PageStore::newPageRecordFromRow ( stdClass $row )

Access: internal

Parameters

stdClass $row

Returns: ExistingPageRecord

Definition at line 359 of file PageStore.php.

◆ newSelectQueryBuilder()

MediaWiki\Page\PageStore::newSelectQueryBuilder ( $dbOrFlags = self::READ_NORMAL )

Stability: unstable

Parameters

IDatabase | int | null $dbOrFlags The database connection to use, or a READ_XXX constant indicating what kind of database connection to use.

Returns: PageSelectQueryBuilder

Definition at line 406 of file PageStore.php.

Member Data Documentation

◆ $dbLoadBalancer

ILoadBalancer MediaWiki\Page\PageStore::$dbLoadBalancer

private

Definition at line 35 of file PageStore.php.

Referenced by MediaWiki\Page\PageStore\__construct().

◆ $linkCache

LinkCache null MediaWiki\Page\PageStore::$linkCache

private

Definition at line 44 of file PageStore.php.

Referenced by MediaWiki\Page\PageStore\__construct().

◆ $namespaceInfo

NamespaceInfo MediaWiki\Page\PageStore::$namespaceInfo

private

Definition at line 38 of file PageStore.php.

Referenced by MediaWiki\Page\PageStore\__construct().

◆ $options

ServiceOptions MediaWiki\Page\PageStore::$options

private

Definition at line 32 of file PageStore.php.

Referenced by MediaWiki\Page\PageStore\__construct().

◆ $stats

StatsdDataFactoryInterface MediaWiki\Page\PageStore::$stats

private

Definition at line 47 of file PageStore.php.

Referenced by MediaWiki\Page\PageStore\__construct().

◆ $titleParser

TitleParser MediaWiki\Page\PageStore::$titleParser

private

Definition at line 41 of file PageStore.php.

Referenced by MediaWiki\Page\PageStore\__construct().

◆ $wikiId

string false MediaWiki\Page\PageStore::$wikiId

private

Definition at line 50 of file PageStore.php.

Referenced by MediaWiki\Page\PageStore\__construct().

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Page\PageStore::CONSTRUCTOR_OPTIONS

Initial value:

= [
        'PageLanguageUseDB',
    ]

Access: internal: for use by service wiring

Definition at line 55 of file PageStore.php.

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

includes/page/PageStore.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDBConnectionRef()

◆ getExistingPageByText()

◆ getPageById()

◆ getPageByName()

◆ getPageByNameViaLinkCache()

◆ getPageByReference()

◆ getPageByText()

◆ getPageForLink()

◆ getSelectFields()

◆ getSubpages()

◆ incrementStats()

◆ loadPageFromConditions()

◆ newPageRecordFromRow()

◆ newSelectQueryBuilder()

Member Data Documentation

◆ $dbLoadBalancer

◆ $linkCache

◆ $namespaceInfo

◆ $options

◆ $stats

◆ $titleParser

◆ $wikiId

◆ CONSTRUCTOR_OPTIONS