Inheritance diagram for MediaWiki\Rest\Handler\PageHTMLHandler:

[legend]

Collaboration diagram for MediaWiki\Rest\Handler\PageHTMLHandler:

[legend]

Public Member Functions
	__construct (Config $config, PermissionManager $permissionManager, RevisionLookup $revisionLookup, TitleFormatter $titleFormatter, VirtualRESTServiceClient $virtualRESTServiceClient)

	run (string $title)

Public Member Functions inherited from MediaWiki\Rest\Handler\LatestPageContentHandler
	__construct (Config $config, PermissionManager $permissionManager, RevisionLookup $revisionLookup, TitleFormatter $titleFormatter)

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

	needsWriteAccess ()
	Indicates whether this route requires write access.

Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
	execute ()
	Execute the handler.

Public Member Functions inherited from MediaWiki\Rest\Handler
	applyConditionalResponseHeaders (ResponseInterface $response)
	Modify the response, adding Last-Modified and ETag headers as indicated the values previously returned by ETag and getLastModified().

	checkPreconditions ()
	Check the conditional request headers and generate a response if appropriate.

	getBodyValidator ( $contentType)
	Fetch the BodyValidator.

	getConfig ()
	Get the configuration array for the current route.

	getRequest ()
	Get the current request.

	getResponseFactory ()
	Get the ResponseFactory which can be used to generate Response objects.

	getValidatedBody ()
	Fetch the validated body.

	getValidatedParams ()
	Fetch the validated parameters.

	init (Router $router, RequestInterface $request, array $config, ResponseFactory $responseFactory, HookContainer $hookContainer)
	Initialise with dependencies from the Router.

	needsReadAccess ()
	Indicates whether this route requires read rights.

	validate (Validator $restValidator)
	Validate the request parameters/attributes and body.

Protected Member Functions
	getETag ()
	Returns an ETag representing a page's source.

	getLastModified ()

Protected Member Functions inherited from MediaWiki\Rest\Handler\LatestPageContentHandler
	constructMetadata (Title $titleObject, RevisionRecord $revision)

	getLatestRevision ()

	getTitle ()

	isAccessible ( $titleObject)

Protected Member Functions inherited from MediaWiki\Rest\Handler
	getConditionalHeaderUtil ()
	Get a ConditionalHeaderUtil object.

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata.

	getHookRunner ()
	Get a HookRunner for running core hooks.

	getRouter ()
	Get the Router.

	getRouteUrl ( $pathParams=[], $queryParams=[])
	Get the URL of this handler's endpoint.

	hasRepresentation ()
	The subclass should override this to indicate whether the resource exists.

	postInitSetup ()
	The handler can override this to do any necessary setup after init() is called to inject the dependencies.

	urlEncodeTitle ( $title)
	URL-encode titles in a "pretty" way.

Private Member Functions
	constructHtmlUrl ()

	fetch200HtmlFromRESTBase (LinkTarget $title)

	fetchHtmlFromRESTBase (LinkTarget $title)

	getHtmlType ()

Private Attributes
array	$htmlResponse

VirtualRESTServiceClient	$restClient

const	MAX_AGE_200 = 5

Additional Inherited Members
Public Attributes inherited from MediaWiki\Rest\Handler
const	PARAM_SOURCE = 'rest-param-source'
	(string) ParamValidator constant to specify the source of the parameter.

Protected Attributes inherited from MediaWiki\Rest\Handler\LatestPageContentHandler
Config	$config

PermissionManager	$permissionManager

RevisionLookup	$revisionLookup

TitleFormatter	$titleFormatter

User	$user

Detailed Description

Definition at line 34 of file PageHTMLHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\PageHTMLHandler::__construct	(	Config	$config,
		PermissionManager	$permissionManager,
		RevisionLookup	$revisionLookup,
		TitleFormatter	$titleFormatter,
		VirtualRESTServiceClient	$virtualRESTServiceClient
	)

Parameters

Config	$config
PermissionManager	$permissionManager
RevisionLookup	$revisionLookup
TitleFormatter	$titleFormatter
VirtualRESTServiceClient	$virtualRESTServiceClient

Definition at line 50 of file PageHTMLHandler.php.

References MediaWiki\Rest\Handler\LatestPageContentHandler\$config, MediaWiki\Rest\Handler\LatestPageContentHandler\$permissionManager, MediaWiki\Rest\Handler\LatestPageContentHandler\$revisionLookup, and MediaWiki\Rest\Handler\LatestPageContentHandler\$titleFormatter.

Member Function Documentation

◆ constructHtmlUrl()

MediaWiki\Rest\Handler\PageHTMLHandler::constructHtmlUrl ( )

private

Returns: string

Definition at line 117 of file PageHTMLHandler.php.

◆ fetch200HtmlFromRESTBase()

MediaWiki\Rest\Handler\PageHTMLHandler::fetch200HtmlFromRESTBase ( LinkTarget $title )

private

Parameters

LinkTarget $title

Returns: array

Exceptions

LocalizedHttpException

Definition at line 103 of file PageHTMLHandler.php.

◆ fetchHtmlFromRESTBase()

MediaWiki\Rest\Handler\PageHTMLHandler::fetchHtmlFromRESTBase ( LinkTarget $title )

private

Parameters

LinkTarget $title

Returns: array

Exceptions

LocalizedHttpException

Definition at line 67 of file PageHTMLHandler.php.

References MediaWiki\Rest\Handler\PageHTMLHandler\$htmlResponse.

◆ getETag()

MediaWiki\Rest\Handler\PageHTMLHandler::getETag ( )

protected

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

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 189 of file PageHTMLHandler.php.

◆ getHtmlType()

MediaWiki\Rest\Handler\PageHTMLHandler::getHtmlType ( )

private

Definition at line 232 of file PageHTMLHandler.php.

◆ getLastModified()

MediaWiki\Rest\Handler\PageHTMLHandler::getLastModified ( )

protected

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 206 of file PageHTMLHandler.php.

◆ run()

MediaWiki\Rest\Handler\PageHTMLHandler::run ( string $title )

Parameters

string $title

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 131 of file PageHTMLHandler.php.

References $title.

Member Data Documentation

◆ $htmlResponse

array MediaWiki\Rest\Handler\PageHTMLHandler::$htmlResponse

private

Definition at line 41 of file PageHTMLHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHTMLHandler\fetchHtmlFromRESTBase().

◆ $restClient

VirtualRESTServiceClient MediaWiki\Rest\Handler\PageHTMLHandler::$restClient

private

Definition at line 38 of file PageHTMLHandler.php.

◆ MAX_AGE_200

const MediaWiki\Rest\Handler\PageHTMLHandler::MAX_AGE_200 = 5

private

Definition at line 35 of file PageHTMLHandler.php.

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

includes/Rest/Handler/PageHTMLHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ constructHtmlUrl()

◆ fetch200HtmlFromRESTBase()

◆ fetchHtmlFromRESTBase()

◆ getETag()

◆ getHtmlType()

◆ getLastModified()

◆ run()

Member Data Documentation

◆ $htmlResponse

◆ $restClient

◆ MAX_AGE_200