MediaWiki\Rest\Handler\Helper\PageContentHelper Class Reference

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

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

Public Member Functions
	__construct (ServiceOptions $options, RevisionLookup $revisionLookup, TitleFormatter $titleFormatter, PageLookup $pageLookup, TitleFactory $titleFactory, IConnectionProvider $dbProvider, ChangeTagsStore $changeTagsStore)
	checkAccess ()
	checkAccessPermission ()
	checkHasContent ()
	constructMetadata ()
	constructRestbaseCompatibleMetadata ()
	getContent ()
	getDefaultSystemMessage ()
	getETag ()
	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 ()
	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.
	useDefaultSystemMessage ()
	If the page is a system message page.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Protected Attributes
Authority null	$authority = null
ServiceOptions	$options
PageLookup	$pageLookup
ExistingPageRecord false null	$pageRecord = false
string[]	$parameters = null
RevisionLookup	$revisionLookup
RevisionRecord false null	$targetRevision = false
TitleFormatter	$titleFormatter

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	(	ServiceOptions	$options,
		RevisionLookup	$revisionLookup,
		TitleFormatter	$titleFormatter,
		PageLookup	$pageLookup,
		TitleFactory	$titleFactory,
		IConnectionProvider	$dbProvider,
		ChangeTagsStore	$changeTagsStore )

Definition at line 80 of file PageContentHelper.php.

References MediaWiki\Rest\Handler\Helper\PageContentHelper\$options, MediaWiki\Rest\Handler\Helper\PageContentHelper\$pageLookup, MediaWiki\Rest\Handler\Helper\PageContentHelper\$revisionLookup, and MediaWiki\Rest\Handler\Helper\PageContentHelper\$titleFormatter.

Member Function Documentation

checkAccess()

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

(

)

Exceptions

LocalizedHttpException

if the content is not accessible

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

Definition at line 419 of file PageContentHelper.php.

checkAccessPermission()

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

(

)

Exceptions

LocalizedHttpException

if access is not allowed

Definition at line 373 of file PageContentHelper.php.

checkHasContent()

MediaWiki\Rest\Handler\Helper\PageContentHelper::checkHasContent

(

)

Exceptions

LocalizedHttpException

if no content is available

Definition at line 388 of file PageContentHelper.php.

constructMetadata()

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

(

)

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

Definition at line 243 of file PageContentHelper.php.

constructRestbaseCompatibleMetadata()

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

(

)

Definition at line 263 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 167 of file PageContentHelper.php.

getDefaultSystemMessage()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getDefaultSystemMessage

(

)

Definition at line 364 of file PageContentHelper.php.

getETag()

MediaWiki\Rest\Handler\Helper\PageContentHelper::getETag

(

)

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, un-readable for another reason, or a newer revision exists.

Returns

string|null

Definition at line 213 of file PageContentHelper.php.

getLastModified()

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

(

)

Definition at line 224 of file PageContentHelper.php.

getPage()

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

(

)

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

Definition at line 114 of file PageContentHelper.php.

getPageIdentity()

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

(

)

Definition at line 125 of file PageContentHelper.php.

getParamSettings()

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

(

)

Returns

array[]

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

Definition at line 310 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 335 of file PageContentHelper.php.

getRole()

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

(

)

Definition at line 159 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 146 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 110 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 239 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 102 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 202 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 344 of file PageContentHelper.php.

References MediaWiki\Rest\ResponseInterface\setHeader().

useDefaultSystemMessage()

MediaWiki\Rest\Handler\Helper\PageContentHelper::useDefaultSystemMessage

(

)

If the page is a system message page.

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

Definition at line 360 of file PageContentHelper.php.

Member Data Documentation

$authority

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

protected

Definition at line 66 of file PageContentHelper.php.

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

$options

ServiceOptions MediaWiki\Rest\Handler\Helper\PageContentHelper::$options

protected

Definition at line 57 of file PageContentHelper.php.

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

$pageLookup

PageLookup MediaWiki\Rest\Handler\Helper\PageContentHelper::$pageLookup

protected

Definition at line 60 of file PageContentHelper.php.

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

$pageRecord

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

protected

Definition at line 75 of file PageContentHelper.php.

$parameters

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

protected

Definition at line 69 of file PageContentHelper.php.

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

$revisionLookup

RevisionLookup MediaWiki\Rest\Handler\Helper\PageContentHelper::$revisionLookup

protected

Definition at line 58 of file PageContentHelper.php.

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

$targetRevision

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

protected

Definition at line 72 of file PageContentHelper.php.

$titleFormatter

TitleFormatter MediaWiki\Rest\Handler\Helper\PageContentHelper::$titleFormatter

protected

Definition at line 59 of file PageContentHelper.php.

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

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