Public Member Functions | |
| __construct (TitleFactory $titleFactory, WikiPageFactoryHook $wikiPageFactoryHookRunner, ILoadBalancer $loadBalancer) | |
| newFromID ( $id, $from='fromdb') | |
| Create a WikiPage object from a page ID. | |
| newFromLinkTarget (LinkTarget $title) | |
| Create a WikiPage object from a link target. | |
| newFromRow ( $row, $from='fromdb') | |
| Create a WikiPage object from a database row. | |
| newFromTitle (PageIdentity $pageIdentity) | |
| Create a WikiPage object from a title. | |
Private Attributes | |
| ILoadBalancer | $loadBalancer |
| TitleFactory | $titleFactory |
| WikiPageFactoryHook | $wikiPageFactoryHookRunner |
Detailed Description
- Since
- 1.36
Definition at line 20 of file WikiPageFactory.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Page\WikiPageFactory::__construct | ( | TitleFactory | $titleFactory, |
| WikiPageFactoryHook | $wikiPageFactoryHookRunner, | ||
| ILoadBalancer | $loadBalancer | ||
| ) |
- Parameters
-
TitleFactory $titleFactory WikiPageFactoryHook $wikiPageFactoryHookRunner ILoadBalancer $loadBalancer
Definition at line 36 of file WikiPageFactory.php.
References MediaWiki\Page\WikiPageFactory\$loadBalancer, MediaWiki\Page\WikiPageFactory\$titleFactory, and MediaWiki\Page\WikiPageFactory\$wikiPageFactoryHookRunner.
Member Function Documentation
◆ newFromID()
| MediaWiki\Page\WikiPageFactory::newFromID | ( | $id, | |
$from = 'fromdb' |
|||
| ) |
Create a WikiPage object from a page ID.
- Parameters
-
int $id Article ID to load string | int $from One of the following values: - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB
- "fromdbmaster" or WikiPage::READ_LATEST to select from the primary database
- Returns
- WikiPage|null Null when no page exists with that ID
Definition at line 128 of file WikiPageFactory.php.
References MediaWiki\Page\WikiPageFactory\newFromRow().
◆ newFromLinkTarget()
| MediaWiki\Page\WikiPageFactory::newFromLinkTarget | ( | LinkTarget | $title | ) |
Create a WikiPage object from a link target.
- Parameters
-
LinkTarget $title
- Returns
- WikiPage
Definition at line 97 of file WikiPageFactory.php.
References $title, and MediaWiki\Page\WikiPageFactory\newFromTitle().
◆ newFromRow()
| MediaWiki\Page\WikiPageFactory::newFromRow | ( | $row, | |
$from = 'fromdb' |
|||
| ) |
Create a WikiPage object from a database row.
- Parameters
-
stdClass $row Database row containing at least fields returned by getQueryInfo(). string | int $from Source of $data: - "fromdb" or WikiPage::READ_NORMAL: from a replica DB
- "fromdbmaster" or WikiPage::READ_LATEST: from the primary DB
- "forupdate" or WikiPage::READ_LOCKING: from the primary DB using SELECT FOR UPDATE
- Returns
- WikiPage
Definition at line 112 of file WikiPageFactory.php.
References MediaWiki\Page\WikiPageFactory\newFromTitle().
Referenced by MediaWiki\Page\WikiPageFactory\newFromID().
◆ newFromTitle()
| MediaWiki\Page\WikiPageFactory::newFromTitle | ( | PageIdentity | $pageIdentity | ) |
Create a WikiPage object from a title.
- Parameters
-
PageIdentity $pageIdentity
- Returns
- WikiPage
Definition at line 53 of file WikiPageFactory.php.
References $title, MediaWiki\Page\PageIdentity\canExist(), MediaWiki\Page\PageReference\getNamespace(), NS_CATEGORY, and NS_FILE.
Referenced by MediaWiki\Page\DeletePage\__construct(), MediaWiki\Page\WikiPageFactory\newFromLinkTarget(), and MediaWiki\Page\WikiPageFactory\newFromRow().
Member Data Documentation
◆ $loadBalancer
|
private |
Definition at line 29 of file WikiPageFactory.php.
Referenced by MediaWiki\Page\WikiPageFactory\__construct().
◆ $titleFactory
|
private |
Definition at line 23 of file WikiPageFactory.php.
Referenced by MediaWiki\Page\WikiPageFactory\__construct().
◆ $wikiPageFactoryHookRunner
|
private |
Definition at line 26 of file WikiPageFactory.php.
Referenced by MediaWiki\Page\WikiPageFactory\__construct().
The documentation for this class was generated from the following file:
- includes/page/WikiPageFactory.php
