Immutable data record representing an editable page on a wiki. More...

Inherits MediaWiki\Page\PageIdentityValue, and MediaWiki\Page\ExistingPageRecord.

Collaboration diagram for MediaWiki\Page\PageStoreRecord:

[legend]

Public Member Functions

__construct (stdClass $row, $wikiId)

The $row object must provide all fields listed in PageStoreRecord::REQUIRED_FIELDS.

getField (string $field)

Return the raw value for the given field as returned by the database query.

getLanguage ()

Language in which the page is written.

getLatest ( $wikiId=self::LOCAL)

The ID of the page'S latest revision.

getTouched ()

Timestamp at which the page was last rerendered.

isNew ()

False if the page has had more than one edit.

isRedirect ()

True if the page is a redirect.

Public Member Functions inherited from MediaWiki\Page\PageIdentityValue

__construct (int $pageId, int $namespace, string $dbKey, $wikiId)

canExist ()

exists ()

Returns whether the page currently exists.

getId ( $wikiId=self::LOCAL)

The numerical page ID provided to the constructor.

Public Member Functions inherited from MediaWiki\Page\PageReferenceValue

__construct (int $namespace, string $dbKey, $wikiId)

__toString ()

Returns a string representation of the title, for logging.

getDBkey ()

Get the page title in DB key form.

Note: This may return a string starting with a hash, if the PageReference represents the target of a block or unblock operation. This is due to the way the block target is represented in the logging table. This is intended to change in the future.; This may return an empty string, if this PageReference is a Title that represents a relative section link. This is intended to change in the future.

Returns: string

getNamespace ()

Returns the page's namespace number.The value returned by this method should represent a valid namespace, but this cannot be guaranteed in all cases.

Returns: int

getWikiId ()

Get the ID of the wiki provided to the constructor.

isSamePageAs (PageReference $other)

Checks whether the given PageReference refers to the same page as this PageReference.Two PageReference instances are considered to refer to the same page if they belong to the same wiki, and have the same namespace and DB key.

Parameters

PageReference $other

Returns: bool

Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity

assertWiki ( $wikiId)

Throws if $wikiId is different from the return value of getWikiId().

Public Member Functions inherited from MediaWiki\Page\ProperPageIdentity

getDBkey ()

Get the page title in DB key form.

getWikiId ()

Get the ID of the wiki this page belongs to.

Public Member Functions inherited from MediaWiki\Page\ExistingPageRecord

exists ()

Always true.

Public Attributes
const	REQUIRED_FIELDS
	Fields that must be present in the row object passed to the constructor.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Page\PageIdentityValue
static	localIdentity (int $pageId, int $namespace, string $dbKey)
	Create PageIdentity for a local page.

static	tryNew (int $pageId, int $namespace, string $dbKey, $wikiId)
	Constructs a PageIdentityValue, or returns null if the parameters are not valid.

Static Public Member Functions inherited from MediaWiki\Page\PageReferenceValue
static	localReference (int $namespace, string $dbKey)
	Create PageReference for a local page.

Detailed Description

Immutable data record representing an editable page on a wiki.

Corresponds to a row in the page table.

See also: https://www.mediawiki.org/wiki/Manual:Modeling_pages

Since: 1.36

Definition at line 36 of file PageStoreRecord.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Page\PageStoreRecord::__construct	(	stdClass	$row,
			$wikiId )

The $row object must provide all fields listed in PageStoreRecord::REQUIRED_FIELDS.

Parameters

stdClass	$row	A row from the page table
string \| false	$wikiId	The Id of the wiki this page belongs to, or self::LOCAL for the local wiki.

Definition at line 68 of file PageStoreRecord.php.

Member Function Documentation

◆ getField()

MediaWiki\Page\PageStoreRecord::getField ( string $field )

Return the raw value for the given field as returned by the database query.

Numeric values may be encoded as strings. Boolean values may be represented as integers (or numeric strings). Timestamps will use the database's native format.

Access: internal

Parameters

string $field

Returns: string|int|bool|null

Definition at line 141 of file PageStoreRecord.php.

◆ getLanguage()

MediaWiki\Page\PageStoreRecord::getLanguage ( )

Language in which the page is written.

Returns: ?string

Implements MediaWiki\Page\PageRecord.

Definition at line 124 of file PageStoreRecord.php.

◆ getLatest()

MediaWiki\Page\PageStoreRecord::getLatest ( $wikiId = self::LOCAL )

The ID of the page'S latest revision.

Parameters

string | false $wikiId

Returns: int

Implements MediaWiki\Page\PageRecord.

Definition at line 105 of file PageStoreRecord.php.

◆ getTouched()

MediaWiki\Page\PageStoreRecord::getTouched ( )

Timestamp at which the page was last rerendered.

Returns: string

Implements MediaWiki\Page\PageRecord.

Definition at line 115 of file PageStoreRecord.php.

◆ isNew()

MediaWiki\Page\PageStoreRecord::isNew ( )

False if the page has had more than one edit.

Returns: bool

Implements MediaWiki\Page\PageRecord.

Definition at line 85 of file PageStoreRecord.php.

◆ isRedirect()

MediaWiki\Page\PageStoreRecord::isRedirect ( )

True if the page is a redirect.

Returns: bool

Implements MediaWiki\Page\PageRecord.

Definition at line 94 of file PageStoreRecord.php.

Member Data Documentation

◆ REQUIRED_FIELDS

const MediaWiki\Page\PageStoreRecord::REQUIRED_FIELDS

Initial value:

= [
        'page_id',
        'page_namespace',
        'page_title',
        'page_is_redirect',
        'page_is_new',
        'page_latest',
        'page_touched',
    ]

Fields that must be present in the row object passed to the constructor.

Note that page_lang is optional, so it is not included here.

Since: 1.37

Definition at line 44 of file PageStoreRecord.php.

Referenced by MediaWiki\Cache\LinkCache\getSelectFields().

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

includes/page/PageStoreRecord.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getField()

◆ getLanguage()

◆ getLatest()

◆ getTouched()

◆ isNew()

◆ isRedirect()

Member Data Documentation

◆ REQUIRED_FIELDS