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.

	needsWriteAccess ()
	Indicates whether this route requires write access.

	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.

	getBodyValidator ( $contentType)
	Fetch the BodyValidator.

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

	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.

	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.

	needsReadAccess ()
	Indicates whether this route requires read rights.

	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
	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.

	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	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 31 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 60 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 456 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 470 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 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 426 of file PageHistoryHandler.php.

◆ hasRepresentation()

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

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 483 of file PageHistoryHandler.php.

◆ needsWriteAccess()

MediaWiki\Rest\Handler\PageHistoryHandler::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 422 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 108 of file PageHistoryHandler.php.

References getAuthority(), 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()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ run()