Inherited by MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

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

[legend]

Public Member Functions
	__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,)

	checkAccess ()

	checkAccessPermission ()

	checkHasContent (bool $allowShadowContent=true)

	constructMetadata ()

	constructRestbaseCompatibleMetadata ()

	getContent ()

	getETag (string $suffix='')
	Returns an ETag representing a page's source.

	getLastModified ()

	getPage ()

	getPageIdentity ()

	getParamSettings ()

	getRedirectsAllowed ()
	Whether the handler is allowed to follow redirects, according to the request parameters.

	getRole ()

	getShadowPage ()
	Get the shadow page, if any.

	getTargetRevision ()
	Returns the target revision.

	getTitleText ()

	hasContent ()
	Checks whether content exists.

	init (Authority $authority, array $parameters)

	isAccessible ()

	setCacheControl (ResponseInterface $response, ?int $expiry=null)
	Sets the 'Cache-Control' header no more then provided $expiry.

	useShadowContent ()
	If the page is a shadow page.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Protected Attributes
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 34 of file PageContentHelper.php.

Constructor & Destructor Documentation

◆ __construct()

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 )

Definition at line 75 of file PageContentHelper.php.

Member Function Documentation

◆ checkAccess()

MediaWiki\Rest\Handler\Helper\PageContentHelper::checkAccess ( )

Exceptions

LocalizedHttpException if the content is not accessible

Definition at line 462 of file PageContentHelper.php.

◆ checkAccessPermission()

MediaWiki\Rest\Handler\Helper\PageContentHelper::checkAccessPermission ( )

Exceptions

LocalizedHttpException 404 if the requested title does not address a page, 403 if that page may not be read

Definition at line 398 of file PageContentHelper.php.

◆ checkHasContent()

MediaWiki\Rest\Handler\Helper\PageContentHelper::checkHasContent ( bool $allowShadowContent = true )

Parameters

bool $allowShadowContent Whether the content of a "shadow page" (a page that is known but has no stored content, such as a system message page) satisfies this check. Routes that do not serve shadow content treat such a page as missing.

Exceptions

LocalizedHttpException if no content is available

Definition at line 429 of file PageContentHelper.php.

◆ constructMetadata()

MediaWiki\Rest\Handler\Helper\PageContentHelper::constructMetadata ( )

Reimplemented in MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

Definition at line 251 of file PageContentHelper.php.

◆ constructRestbaseCompatibleMetadata()

MediaWiki\Rest\Handler\Helper\PageContentHelper::constructRestbaseCompatibleMetadata ( )

Definition at line 271 of file PageContentHelper.php.

◆ getContent()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getContent ( )

Returns: TextContent

Exceptions

LocalizedHttpException slot content is not TextContent or RevisionRecord/Slot is inaccessible

Definition at line 156 of file PageContentHelper.php.

◆ getETag()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getETag ( string $suffix = '' )

Returns an ETag representing a page's source.

The ETag assumes a page's source has changed if:

The latest revision of a page has been made private or un-readable for another reason
A newer revision exists
The visible tags on the revision have changed

Parameters

string $suffix A suffix to attach to the etag. Must consist of characters that are legal in ETags.

Definition at line 205 of file PageContentHelper.php.

◆ getLastModified()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getLastModified ( )

Definition at line 232 of file PageContentHelper.php.

◆ getPage()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getPage ( )

Reimplemented in MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

Definition at line 103 of file PageContentHelper.php.

◆ getPageIdentity()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getPageIdentity ( )

Definition at line 114 of file PageContentHelper.php.

◆ getParamSettings()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getParamSettings ( )

Returns: array[]

Reimplemented in MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

Definition at line 322 of file PageContentHelper.php.

◆ getRedirectsAllowed()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getRedirectsAllowed ( )

Whether the handler is allowed to follow redirects, according to the request parameters.

Handlers that can follow wiki redirects can use this to give clients control over the redirect handling behavior.

Definition at line 349 of file PageContentHelper.php.

◆ getRole()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getRole ( )

Definition at line 148 of file PageContentHelper.php.

◆ getShadowPage()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getShadowPage ( )

Get the shadow page, if any.

Returns: ShadowPage|null

Definition at line 382 of file PageContentHelper.php.

◆ getTargetRevision()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getTargetRevision ( )

Returns the target revision.

No permission checks are applied.

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

Reimplemented in MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

Definition at line 135 of file PageContentHelper.php.

◆ getTitleText()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getTitleText ( )

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

Reimplemented in MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

Definition at line 99 of file PageContentHelper.php.

◆ hasContent()

MediaWiki\Rest\Handler\Helper\PageContentHelper::hasContent ( )

Checks whether content exists.

Permission checks are not considered.

Reimplemented in MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

Definition at line 247 of file PageContentHelper.php.

◆ init()

MediaWiki\Rest\Handler\Helper\PageContentHelper::init	(	Authority	$authority,
		array	$parameters )

Parameters

Authority	$authority
string[]	$parameters	validated parameters

Definition at line 91 of file PageContentHelper.php.

References MediaWiki\Rest\Handler\Helper\PageContentHelper\$authority, and MediaWiki\Rest\Handler\Helper\PageContentHelper\$parameters.

◆ isAccessible()

MediaWiki\Rest\Handler\Helper\PageContentHelper::isAccessible ( )

Reimplemented in MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

Definition at line 191 of file PageContentHelper.php.

◆ setCacheControl()

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

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

Parameters

ResponseInterface	$response
int \| null	$expiry

Reimplemented in MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

Definition at line 358 of file PageContentHelper.php.

References MediaWiki\Rest\ResponseInterface\setHeader().

◆ useShadowContent()

MediaWiki\Rest\Handler\Helper\PageContentHelper::useShadowContent ( )

If the page is a shadow page.

When the content gets overridden to create an actual page, this method returns false.

Reimplemented in MediaWiki\Rest\Handler\Helper\RevisionContentHelper.

Definition at line 374 of file PageContentHelper.php.

Member Data Documentation

◆ $authority

Authority null MediaWiki\Rest\Handler\Helper\PageContentHelper::$authority = null

protected

Definition at line 58 of file PageContentHelper.php.

Referenced by MediaWiki\Rest\Handler\Helper\PageContentHelper\init().

◆ $pageRecord

ExistingPageRecord false null MediaWiki\Rest\Handler\Helper\PageContentHelper::$pageRecord = false

protected

Definition at line 67 of file PageContentHelper.php.

◆ $parameters

string [] MediaWiki\Rest\Handler\Helper\PageContentHelper::$parameters = null

protected

Definition at line 61 of file PageContentHelper.php.

Referenced by MediaWiki\Rest\Handler\Helper\PageContentHelper\init().

◆ $targetRevision

RevisionRecord false null MediaWiki\Rest\Handler\Helper\PageContentHelper::$targetRevision = false

protected

Definition at line 64 of file PageContentHelper.php.

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Rest\Handler\Helper\PageContentHelper::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::RightsUrl,
        MainConfigNames::RightsText,
    ]

Access: internal

Definition at line 52 of file PageContentHelper.php.

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

includes/Rest/Handler/Helper/PageContentHelper.php

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkAccess()

◆ checkAccessPermission()

◆ checkHasContent()

◆ constructMetadata()

◆ constructRestbaseCompatibleMetadata()

◆ getContent()

◆ getETag()

◆ getLastModified()

◆ getPage()

◆ getPageIdentity()

◆ getParamSettings()

◆ getRedirectsAllowed()

◆ getRole()

◆ getShadowPage()

◆ getTargetRevision()

◆ getTitleText()

◆ hasContent()

◆ init()

◆ isAccessible()

◆ setCacheControl()

◆ useShadowContent()

Member Data Documentation

◆ $authority

◆ $pageRecord

◆ $parameters

◆ $targetRevision

◆ CONSTRUCTOR_OPTIONS