95ab541612
The various classes and interfaces for representing titles, links, and pages can be a bit confusing. Link to a wiki page that provides an overview: https://www.mediawiki.org/wiki/Manual:Modeling_pages Change-Id: I04fcf53bd15ca50a2bbb8693482a99ab651a4b30
69 lines
2.1 KiB
PHP
69 lines
2.1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Page;
|
|
|
|
/**
|
|
* Data record representing a page that is (or used to be, or could be)
|
|
* an editable page on a wiki.
|
|
*
|
|
* For compatibility with the WikiPage class, PageIdentity instances may
|
|
* represent non-existing pages. In the future, the contract of this interface is intended
|
|
* to be changed to disallow this. PageIdentity instances may also
|
|
* be mutable, and return different values from methods such as getLatest() or isRedirect()
|
|
* at different times. In the future, the contract of this interface is intended
|
|
* to be changed to disallow this.
|
|
*
|
|
* Only WikiPage should implement PageRecord directly, other implementations should use
|
|
* ExistingPageRecord instead. Once WikiPage is removed or guaranteed to be immutable and
|
|
* existing, ExistingPageRecord will become an alias of PageRecord.
|
|
*
|
|
* @see https://www.mediawiki.org/wiki/Manual:Modeling_pages
|
|
*
|
|
* @stable to type
|
|
* @since 1.36
|
|
* @ingroup Page
|
|
*/
|
|
interface PageRecord extends ProperPageIdentity {
|
|
|
|
/**
|
|
* False if the page has had more than one edit.
|
|
*
|
|
* @warning this is not guaranteed to always return true for old pages that have only one edit.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isNew();
|
|
|
|
/**
|
|
* True if the page is a redirect.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isRedirect();
|
|
|
|
/**
|
|
* The ID of the page's latest revision.
|
|
*
|
|
* @param string|false $wikiId Must be provided when accessing the ID of the latest revision of
|
|
* a non-local PageRecord, to prevent data corruption when using a PageRecord belonging
|
|
* to one wiki in the context of another. Should be omitted if expecting the local wiki.
|
|
*
|
|
* @return int The revision ID of the page's latest revision, or 0 if the page does not exist.
|
|
*/
|
|
public function getLatest( $wikiId = self::LOCAL );
|
|
|
|
/**
|
|
* Timestamp at which the page was last flagged for rerendering.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getTouched();
|
|
|
|
/**
|
|
* The page's language, if explicitly recorded.
|
|
* The effective page language needs to be determined programmatically.
|
|
*
|
|
* @return ?string
|
|
*/
|
|
public function getLanguage();
|
|
}
|