A handler that returns page source and metadata for the following routes: More...

Collaboration diagram for MediaWiki\Rest\Handler\RevisionSourceHandler:

[legend]

Public Member Functions
	__construct (PageRestHelperFactory $helperFactory)

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

	needsWriteAccess ()
	Indicates whether this route requires write access.

	run ()

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

Public Member Functions inherited from MediaWiki\Rest\Handler
	applyCacheControl (ResponseInterface $response)
	Apply cache control to enforce privacy.

	applyConditionalResponseHeaders (ResponseInterface $response)
	Apply verifier headers to the response, per RFC 7231 §7.2.

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

	checkSession ()
	Check the session (and session provider)

	getAuthority ()
	Get the current acting authority.

	getBodyValidator ( $contentType)
	Fetch the BodyValidator.

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

	getOpenApiSpec (string $method)
	Returns an OpenAPI Operation Object specification structure as an associative array.

	getPath ()
	Returns the path this handler is bound to, including path variables.

	getRequest ()
	Get the current request.

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

	getSession ()
	Get the Session.

	getSupportedPathParams ()
	Get a list of parameter placeholder present in the route's path as returned by getPath().

	getValidatedBody ()
	Fetch the validated body.

	getValidatedParams ()
	Fetch the validated parameters.

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

	initContext (Router $router, array $routeConfig)
	Injects information about the handler's context in the Router.

	needsReadAccess ()
	Indicates whether this route requires read rights.

	parseBodyData (RequestInterface $request)
	Returns the parsed body of the request.

	requireSafeAgainstCsrf ()
	Indicates whether this route can be accessed only by session providers safe vs csrf.

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

Protected Member Functions
	getETag ()

	getLastModified ()

	getResponseBodySchema ()
	Returns an OpenAPI Schema Object specification structure as an associative array.

	hasRepresentation ()

	postValidationSetup ()
	The handler can override this to do any necessary setup after validate() has been called.

Protected Member Functions inherited from MediaWiki\Rest\Handler
	detectExtraneousBodyFields (Validator $restValidator)
	Subclasses may override this to disable or modify checks for extraneous body fields.

	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.

	getRequestSpec ()
	Returns an OpenAPI Request Body Object specification structure as an associative array.

	getResponseSpec ()
	Returns an OpenAPI Responses Object specification structure as an associative array.

	getRouter ()
	Get the Router.

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

	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.

Additional Inherited Members
Public Attributes inherited from MediaWiki\Rest\Handler
const	KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES

const	PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION

const	PARAM_SOURCE = Validator::PARAM_SOURCE

Detailed Description

A handler that returns page source and metadata for the following routes:

/revision/{revision}
/revision/{revision}/bare

Definition at line 18 of file RevisionSourceHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\RevisionSourceHandler::__construct ( PageRestHelperFactory $helperFactory )

Parameters

PageRestHelperFactory $helperFactory

Definition at line 26 of file RevisionSourceHandler.php.

References MediaWiki\Rest\Handler\Helper\PageRestHelperFactory\newRevisionContentHelper().

Member Function Documentation

◆ getETag()

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

protected

Returns: string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 86 of file RevisionSourceHandler.php.

◆ getLastModified()

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

protected

Returns: string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 93 of file RevisionSourceHandler.php.

◆ getParamSettings()

MediaWiki\Rest\Handler\RevisionSourceHandler::getParamSettings ( )

Fetch ParamValidator settings for parameters.

Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.

Can be used for validating parameters inside an application/x-www-form-urlencoded or multipart/form-data POST body (i.e. parameters which would be present in PHP's $_POST array). For validating other kinds of request bodies, override getBodyValidator().

Stability: stable: to override

Returns: array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 105 of file RevisionSourceHandler.php.

◆ getResponseBodySchema()

MediaWiki\Rest\Handler\RevisionSourceHandler::getResponseBodySchema ( )

protected

Returns an OpenAPI Schema Object specification structure as an associative array.

See also: https://swagger.io/specification/#schema-object

Returns null per default. Subclasses that return a JSON response should implement this method to return a schema of the response body.

Stability: stable: to override

Returns: ?array

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 77 of file RevisionSourceHandler.php.

References MediaWiki\Rest\Handler\getResponseBodySchema().

◆ hasRepresentation()

MediaWiki\Rest\Handler\RevisionSourceHandler::hasRepresentation ( )

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 112 of file RevisionSourceHandler.php.

◆ needsWriteAccess()

MediaWiki\Rest\Handler\RevisionSourceHandler::needsWriteAccess ( )

Indicates whether this route requires write access.

The handler should override this if the route does not need to write to the database.

This should return true for routes that may require synchronous database writes. Modules that do not need such writes should also not rely on primary database access, since only read queries are needed and each primary DB is a single point of failure.

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 101 of file RevisionSourceHandler.php.

◆ postValidationSetup()

MediaWiki\Rest\Handler\RevisionSourceHandler::postValidationSetup ( )

protected

The handler can override this to do any necessary setup after validate() has been called.

This gives the handler an opportunity to do initialization based on parameters before pre-execution calls like getLastModified() or getETag().

Stability: stable: to override

Since: 1.36

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 30 of file RevisionSourceHandler.php.

References MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\getValidatedParams().

◆ run()

MediaWiki\Rest\Handler\RevisionSourceHandler::run ( )

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 49 of file RevisionSourceHandler.php.

References MediaWiki\Rest\Handler\getResponseFactory().

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

includes/Rest/Handler/RevisionSourceHandler.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getETag()

◆ getLastModified()

◆ getParamSettings()

◆ getResponseBodySchema()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ postValidationSetup()

◆ run()