Handler class for Core REST API endpoints that perform operations on revisions. More...

Inheritance diagram for MediaWiki\Rest\Handler\RevisionHandler:

[legend]

Collaboration diagram for MediaWiki\Rest\Handler\RevisionHandler:

[legend]

Public Member Functions
	__construct (RevisionLookup $revisionLookup, PermissionManager $permissionManager)

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

	needsWriteAccess ()
	Indicates whether this route requires write access.

	run ( $id)

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 the requested revision.

	getLastModified ()
	Returns the requested revision's timestamp.

	hasRepresentation ()

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.

	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
	getRevision ()

Private Attributes
PermissionManager	$permissionManager

RevisionRecord bool null	$revision = null

RevisionLookup	$revisionLookup

User	$user

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.

Detailed Description

Handler class for Core REST API endpoints that perform operations on revisions.

Definition at line 19 of file RevisionHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\RevisionHandler::__construct	(	RevisionLookup	$revisionLookup,
		PermissionManager	$permissionManager
	)

Parameters

RevisionLookup	$revisionLookup
PermissionManager	$permissionManager

Definition at line 38 of file RevisionHandler.php.

References MediaWiki\Rest\Handler\RevisionHandler\$permissionManager, and MediaWiki\Rest\Handler\RevisionHandler\$revisionLookup.

Member Function Documentation

◆ getETag()

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

protected

Returns an ETag representing the requested revision.

If access to the revision is restricted, do not return an etag.

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 135 of file RevisionHandler.php.

◆ getLastModified()

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

protected

Returns the requested revision's timestamp.

If access to the revision is restricted, do not return a timestamp.

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 153 of file RevisionHandler.php.

◆ getParamSettings()

MediaWiki\Rest\Handler\RevisionHandler::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.

Stable to override

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 118 of file RevisionHandler.php.

◆ getRevision()

MediaWiki\Rest\Handler\RevisionHandler::getRevision ( )

private

Returns: RevisionRecord|bool

Definition at line 52 of file RevisionHandler.php.

References MediaWiki\Rest\Handler\RevisionHandler\$revision, and MediaWiki\Rest\Handler\getValidatedParams().

Referenced by MediaWiki\Rest\Handler\RevisionHandler\run().

◆ hasRepresentation()

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

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 165 of file RevisionHandler.php.

References true.

◆ needsWriteAccess()

MediaWiki\Rest\Handler\RevisionHandler::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 master database access, since only read queries are needed and each master DB is a single point of failure.

Stable to override

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 114 of file RevisionHandler.php.

◆ run()

MediaWiki\Rest\Handler\RevisionHandler::run ( $id )

Parameters

int $id

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 70 of file RevisionHandler.php.

References MediaWiki\Rest\Handler\getResponseFactory(), MediaWiki\Rest\Handler\RevisionHandler\getRevision(), and wfTimestamp().

Member Data Documentation

◆ $permissionManager

PermissionManager MediaWiki\Rest\Handler\RevisionHandler::$permissionManager

private

Definition at line 24 of file RevisionHandler.php.

Referenced by MediaWiki\Rest\Handler\RevisionHandler\__construct().

◆ $revision

RevisionRecord bool null MediaWiki\Rest\Handler\RevisionHandler::$revision = null

private

Definition at line 32 of file RevisionHandler.php.

Referenced by MediaWiki\Rest\Handler\RevisionHandler\getRevision().

◆ $revisionLookup

RevisionLookup MediaWiki\Rest\Handler\RevisionHandler::$revisionLookup

private

Definition at line 21 of file RevisionHandler.php.

Referenced by MediaWiki\Rest\Handler\RevisionHandler\__construct().

◆ $user

User MediaWiki\Rest\Handler\RevisionHandler::$user

private

Definition at line 27 of file RevisionHandler.php.

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

includes/Rest/Handler/RevisionHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getETag()

◆ getLastModified()

◆ getParamSettings()

◆ getRevision()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ run()

Member Data Documentation

◆ $permissionManager

◆ $revision

◆ $revisionLookup

◆ $user