MediaWiki\Rest\Handler\Helper\RevisionContentHelper Class Reference

Inherits MediaWiki\Rest\Handler\Helper\PageContentHelper.

Collaboration diagram for MediaWiki\Rest\Handler\Helper\RevisionContentHelper:

Public Member Functions
	checkAccess ()
	constructMetadata ()
	getPage ()
	getParamSettings ()
	getRevisionId ()
	getTargetRevision ()
	getTitleText ()
	hasContent ()
	Checks whether content exists.
	isAccessible ()
	setCacheControl (ResponseInterface $response, ?int $expiry=null)
	Sets the 'Cache-Control' header no more then provided $expiry.
Public Member Functions inherited from MediaWiki\Rest\Handler\Helper\PageContentHelper
	__construct (protected ServiceOptions $options, protected RevisionLookup $revisionLookup, protected TitleFormatter $titleFormatter, protected PageLookup $pageLookup, private TitleFactory $titleFactory, private IConnectionProvider $dbProvider, private ChangeTagsStore $changeTagsStore, private ShadowPageLoader $shadowPageLoader,)
	checkAccessPermission ()
	checkHasContent ()
	constructRestbaseCompatibleMetadata ()
	getContent ()
	getETag ()
	Returns an ETag representing a page's source.
	getLastModified ()
	getPageIdentity ()
	getRedirectsAllowed ()
	Whether the handler is allowed to follow redirects, according to the request parameters.
	getRole ()
	getShadowPage ()
	Get the shadow page, if any.
	init (Authority $authority, array $parameters)
	useShadowContent ()
	If the page is a shadow page.

Additional Inherited Members
Public Attributes inherited from MediaWiki\Rest\Handler\Helper\PageContentHelper
const	CONSTRUCTOR_OPTIONS
Protected Attributes inherited from MediaWiki\Rest\Handler\Helper\PageContentHelper
Authority null	$authority = null
ExistingPageRecord false null	$pageRecord = false
string[]	$parameters = null
RevisionRecord false null	$targetRevision = false

Detailed Description

Access: internal

for use by core REST infrastructure

Definition at line 18 of file RevisionContentHelper.php.

Member Function Documentation

checkAccess()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::checkAccess

(

)

Exceptions

LocalizedHttpException

if the content is not accessible

Reimplemented from MediaWiki\Rest\Handler\Helper\PageContentHelper.

Definition at line 155 of file RevisionContentHelper.php.

constructMetadata()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::constructMetadata

(

)

Reimplemented from MediaWiki\Rest\Handler\Helper\PageContentHelper.

Definition at line 89 of file RevisionContentHelper.php.

getPage()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::getPage

(

)

Reimplemented from MediaWiki\Rest\Handler\Helper\PageContentHelper.

Definition at line 36 of file RevisionContentHelper.php.

getParamSettings()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::getParamSettings

(

)

Returns

array[]

Reimplemented from MediaWiki\Rest\Handler\Helper\PageContentHelper.

Definition at line 140 of file RevisionContentHelper.php.

getRevisionId()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::getRevisionId

(

)

Returns

int|null The ID of the target revision

Definition at line 22 of file RevisionContentHelper.php.

getTargetRevision()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::getTargetRevision

(

)

Returns

RevisionRecord|null latest revision or null if unable to retrieve revision

Reimplemented from MediaWiki\Rest\Handler\Helper\PageContentHelper.

Definition at line 44 of file RevisionContentHelper.php.

getTitleText()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::getTitleText

(

)

Returns

string|null title text or null if unable to retrieve title

Reimplemented from MediaWiki\Rest\Handler\Helper\PageContentHelper.

Definition at line 29 of file RevisionContentHelper.php.

hasContent()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::hasContent

(

)

Checks whether content exists.

Permission checks are not considered.

Reimplemented from MediaWiki\Rest\Handler\Helper\PageContentHelper.

Definition at line 74 of file RevisionContentHelper.php.

isAccessible()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::isAccessible

(

)

Reimplemented from MediaWiki\Rest\Handler\Helper\PageContentHelper.

Definition at line 56 of file RevisionContentHelper.php.

setCacheControl()

MediaWiki\Rest\Handler\Helper\RevisionContentHelper::setCacheControl	(	ResponseInterface	$response,
		?int	$expiry = null )

Sets the 'Cache-Control' header no more then provided $expiry.

Parameters

ResponseInterface	$response
int | null	$expiry

Reimplemented from MediaWiki\Rest\Handler\Helper\PageContentHelper.

Definition at line 78 of file RevisionContentHelper.php.

---

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

• includes/Rest/Handler/Helper/RevisionContentHelper.php