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

Collaboration diagram for MediaWiki\Rest\Handler\PageHistoryHandler:

[legend]

Public Member Functions
	__construct (RevisionStore $revisionStore, NameTableStoreFactory $nameTableStoreFactory, GroupPermissionsLookup $groupPermissionsLookup, IConnectionProvider $dbProvider, PageLookup $pageLookup, TitleFormatter $titleFormatter, PageRestHelperFactory $helperFactory)
	RevisionStore $revisionStore.

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

	getResponseBodySchemaFileName (string $method)
	Returns the path and name of a JSON file containing an OpenAPI Schema Object specification structure.

	needsWriteAccess ()
	Indicates whether this route requires write access to the wiki.

	run ( $title)
	At most one of older_than and newer_than may be specified.

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.

	getBodyParamSettings ()
	Fetch ParamValidator settings for body fields.

	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 relative to the module prefix.

	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 placeholders present in the route's path as returned by getPath().

	getSupportedRequestTypes ()
	Returns the content types that should be accepted by parseBodyData().

	getValidatedBody ()
	Fetch the validated body.

	getValidatedParams ()
	Fetch the validated parameters.

	initContext (Module $module, string $path, array $routeConfig)
	Injects information about the handler's context in the Module.

	initForExecute (RequestInterface $request)
	Initialise for execution based on the given request.

	initServices (Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer)
	Inject service objects.

	initSession (Session $session)
	Inject session information.

	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 ()
	Returns an ETag representing a page's latest revision.

	getLastModified ()
	Returns the time of the last change to the page.

	hasRepresentation ()

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

	generateResponseSpec (string $method)
	Returns an OpenAPI Responses Object specification structure as an associative array.

	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.

	getModule ()
	Get the Module this handler belongs to.

	getRequestBodySchema (string $mediaType)
	Returns a content schema per the OpenAPI spec.

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

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

	getRouter ()

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

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

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

	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	OPENAPI_DESCRIPTION_KEY = 'description'

const	PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION

const	PARAM_SOURCE = Validator::PARAM_SOURCE

const	RESPONSE_BODY_DESCRIPTION_KEY = 'x-i18n-description'

Detailed Description

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

Definition at line 33 of file PageHistoryHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\PageHistoryHandler::__construct	(	RevisionStore	$revisionStore,
		NameTableStoreFactory	$nameTableStoreFactory,
		GroupPermissionsLookup	$groupPermissionsLookup,
		IConnectionProvider	$dbProvider,
		PageLookup	$pageLookup,
		TitleFormatter	$titleFormatter,
		PageRestHelperFactory	$helperFactory )

RevisionStore $revisionStore.

Parameters

RevisionStore	$revisionStore
NameTableStoreFactory	$nameTableStoreFactory
GroupPermissionsLookup	$groupPermissionsLookup
IConnectionProvider	$dbProvider
PageLookup	$pageLookup
TitleFormatter	$titleFormatter
PageRestHelperFactory	$helperFactory

Definition at line 62 of file PageHistoryHandler.php.

References MediaWiki\Storage\NameTableStoreFactory\getChangeTagDef().

Member Function Documentation

◆ getETag()

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

protected

Returns an ETag representing a page's latest revision.

Returns: string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 459 of file PageHistoryHandler.php.

◆ getLastModified()

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

protected

Returns the time of the last change to the page.

Returns: string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 473 of file PageHistoryHandler.php.

◆ getParamSettings()

MediaWiki\Rest\Handler\PageHistoryHandler::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 the request body as well, by setting self::PARAM_SOURCE to "post". Note that the values of "post" parameters will be accessible through getValidatedParams(). "post" parameters are used with form data (application/x-www-form-urlencoded or multipart/form-data).

For "query" parameters, a PARAM_REQUIRED setting of "false" means the caller does not have to supply the parameter. For "path" parameters, the path matcher will always require the caller to supply all path parameters for a route, regardless of the PARAM_REQUIRED setting. However, "path" parameters may be specified in getParamSettings() as non-required to indicate that the handler services multiple routes, some of which may not supply the parameter.

Stability: stable: to override

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 425 of file PageHistoryHandler.php.

◆ getResponseBodySchemaFileName()

MediaWiki\Rest\Handler\PageHistoryHandler::getResponseBodySchemaFileName ( string $method )

Returns the path and name of a JSON file containing an OpenAPI Schema Object specification structure.

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

Returns null by default. Subclasses with a suitable JSON file should implement this method.

Parameters

string $method The HTTP method to produce a spec for ("get", "post", etc).

Stability: stable: to override

Since: 1.43

Returns: ?string

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 490 of file PageHistoryHandler.php.

◆ hasRepresentation()

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

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 486 of file PageHistoryHandler.php.

◆ needsWriteAccess()

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

Indicates whether this route requires write access to the wiki.

Handlers may override this method to return false if and only if the operation they implement is "safe" per RFC 7231 section 4.2.1. A handler's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

Handlers for GET, HEAD, OPTIONS, and TRACE requests should each implement a "safe" operation. Handlers of PUT and DELETE requests should each implement a non-"safe" operation. Note that handlers of POST requests can implement a "safe" operation, particularly in the case where large input parameters are required.

The information provided by this method is used to perform basic authorization checks and to determine whether cross-origin requests are safe.

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 421 of file PageHistoryHandler.php.

◆ run()

MediaWiki\Rest\Handler\PageHistoryHandler::run ( $title )

At most one of older_than and newer_than may be specified.

Keep in mind that revision ids are not monotonically increasing, so a revision may be older than another but have a higher revision id.

Parameters

string $title

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 107 of file PageHistoryHandler.php.

References $params, and ChangeTags\REVERT_TAGS.

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

includes/Rest/Handler/PageHistoryHandler.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getETag()

◆ getLastModified()

◆ getParamSettings()

◆ getResponseBodySchemaFileName()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ run()