MediaWiki  master
Page\PageStore Class Reference
Inheritance diagram for Page\PageStore:
Collaboration diagram for Page\PageStore:

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. More...
 
 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) More...
 

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 28 of file PageStore.php.

Constructor & Destructor Documentation

◆ __construct()

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 67 of file PageStore.php.

References Page\PageStore\$dbLoadBalancer, Page\PageStore\$linkCache, Page\PageStore\$namespaceInfo, Page\PageStore\$options, Page\PageStore\$stats, Page\PageStore\$titleParser, and Page\PageStore\$wikiId.

Member Function Documentation

◆ getDBConnectionRef()

Page\PageStore::getDBConnectionRef ( int  $mode = DB_REPLICA)
private
Parameters
int$modeDB_PRIMARY or DB_REPLICA
Returns
IDatabase

Definition at line 420 of file PageStore.php.

◆ getExistingPageByText()

Page\PageStore::getExistingPageByText ( string  $text,
int  $defaultNamespace = NS_MAIN,
int  $queryFlags = self::READ_NORMAL 
)
Since
1.37
Parameters
string$text
int$defaultNamespaceNamespace to assume per default (usually NS_MAIN)
int$queryFlags
Returns
ExistingPageRecord|null

Implements Page\PageLookup.

Definition at line 274 of file PageStore.php.

◆ getPageById()

Page\PageStore::getPageById ( int  $pageId,
int  $queryFlags = self::READ_NORMAL 
)
Parameters
int$pageId
int$queryFlags
Returns
ExistingPageRecord|null

Implements Page\PageLookup.

Definition at line 292 of file PageStore.php.

◆ getPageByName()

Page\PageStore::getPageByName ( int  $namespace,
string  $dbKey,
int  $queryFlags = self::READ_NORMAL 
)
Parameters
int$namespace
string$dbKey
int$queryFlags
Returns
ExistingPageRecord|null

Implements Page\PageLookup.

Definition at line 139 of file PageStore.php.

◆ getPageByNameViaLinkCache()

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 167 of file PageStore.php.

◆ getPageByReference()

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 Page\PageLookup.

Definition at line 313 of file PageStore.php.

◆ getPageByText()

Page\PageStore::getPageByText ( string  $text,
int  $defaultNamespace = NS_MAIN,
int  $queryFlags = self::READ_NORMAL 
)
Since
1.37
Parameters
string$text
int$defaultNamespaceNamespace to assume per default (usually NS_MAIN)
int$queryFlags
Returns
ProperPageIdentity|null

Implements Page\PageLookup.

Definition at line 250 of file PageStore.php.

◆ getPageForLink()

Page\PageStore::getPageForLink ( LinkTarget  $link,
int  $queryFlags = self::READ_NORMAL 
)
Parameters
LinkTarget$link
int$queryFlags
Returns
ProperPageIdentity

Implements Page\PageLookup.

Definition at line 107 of file PageStore.php.

◆ getSelectFields()

Page\PageStore::getSelectFields ( )
Access: internal
Returns
string[]

Definition at line 366 of file PageStore.php.

◆ getSubpages()

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$limitMaximum number of subpages to fetch
Returns
Iterator<ExistingPageRecord>

Definition at line 433 of file PageStore.php.

◆ incrementStats()

Page\PageStore::incrementStats ( string  $metric)
private
Parameters
string$metric

Definition at line 97 of file PageStore.php.

◆ loadPageFromConditions()

Page\PageStore::loadPageFromConditions ( array  $conds,
int  $queryFlags = self::READ_NORMAL 
)
private
Parameters
array$conds
int$queryFlags
Returns
ExistingPageRecord|null

Definition at line 335 of file PageStore.php.

◆ newPageRecordFromRow()

Page\PageStore::newPageRecordFromRow ( stdClass  $row)
Access: internal
Parameters
stdClass$row
Returns
ExistingPageRecord

Definition at line 354 of file PageStore.php.

◆ newSelectQueryBuilder()

Page\PageStore::newSelectQueryBuilder (   $dbOrFlags = self::READ_NORMAL)
Stability: unstable
Parameters
IDatabase | int$dbOrFlagsThe database connection to use, or a READ_XXX constant indicating what kind of database connection to use.
Returns
PageSelectQueryBuilder

Definition at line 401 of file PageStore.php.

Member Data Documentation

◆ $dbLoadBalancer

ILoadBalancer Page\PageStore::$dbLoadBalancer
private

Definition at line 34 of file PageStore.php.

Referenced by Page\PageStore\__construct().

◆ $linkCache

LinkCache null Page\PageStore::$linkCache
private

Definition at line 43 of file PageStore.php.

Referenced by Page\PageStore\__construct().

◆ $namespaceInfo

NamespaceInfo Page\PageStore::$namespaceInfo
private

Definition at line 37 of file PageStore.php.

Referenced by Page\PageStore\__construct().

◆ $options

ServiceOptions Page\PageStore::$options
private

Definition at line 31 of file PageStore.php.

Referenced by Page\PageStore\__construct().

◆ $stats

StatsdDataFactoryInterface Page\PageStore::$stats
private

Definition at line 46 of file PageStore.php.

Referenced by Page\PageStore\__construct().

◆ $titleParser

TitleParser Page\PageStore::$titleParser
private

Definition at line 40 of file PageStore.php.

Referenced by Page\PageStore\__construct().

◆ $wikiId

string false Page\PageStore::$wikiId
private

Definition at line 49 of file PageStore.php.

Referenced by Page\PageStore\__construct().

◆ CONSTRUCTOR_OPTIONS

const Page\PageStore::CONSTRUCTOR_OPTIONS
Initial value:
= [
]
const PageLanguageUseDB
Name constant for the PageLanguageUseDB setting, for use with Config::get()
Access: internal
for use by service wiring

Definition at line 54 of file PageStore.php.


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