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

Inheritance diagram for MediaWiki\Rest\Handler\PageHistoryHandler:

[legend]

Collaboration diagram for MediaWiki\Rest\Handler\PageHistoryHandler:

[legend]

Public Member Functions
	__construct (RevisionStore $revisionStore, NameTableStoreFactory $nameTableStoreFactory, PermissionManager $permissionManager, ILoadBalancer $loadBalancer)
	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
	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 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.

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

Private Member Functions
	getBitmask ()
	Helper function for rev_deleted/user rights query conditions.

	getDbResults (Title $titleObj, array $params, $relativeRevId, $ts, $tagIds)

	getTitle ()

	processDbResults ( $res, $titleObj, $params)

Private Attributes
NameTableStore	$changeTagDefStore

ILoadBalancer	$loadBalancer

PermissionManager	$permissionManager

RevisionStore	$revisionStore

Title bool null	$title = null

User	$user

const	ALLOWED_FILTER_TYPES = [ 'anonymous', 'bot', 'reverted', 'minor' ]

const	REVERTED_TAG_NAMES = [ 'mw-undo', 'mw-rollback' ]

const	REVISIONS_RETURN_LIMIT = 20

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 28 of file PageHistoryHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\PageHistoryHandler::__construct	(	RevisionStore	$revisionStore,
		NameTableStoreFactory	$nameTableStoreFactory,
		PermissionManager	$permissionManager,
		ILoadBalancer	$loadBalancer
	)

RevisionStore $revisionStore.

Parameters

RevisionStore	$revisionStore
NameTableStoreFactory	$nameTableStoreFactory
PermissionManager	$permissionManager
ILoadBalancer	$loadBalancer

Definition at line 61 of file PageHistoryHandler.php.

References MediaWiki\Rest\Handler\PageHistoryHandler\$loadBalancer, MediaWiki\Rest\Handler\PageHistoryHandler\$permissionManager, MediaWiki\Rest\Handler\PageHistoryHandler\$revisionStore, and MediaWiki\Storage\NameTableStoreFactory\getChangeTagDef().

Member Function Documentation

◆ getBitmask()

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

private

Helper function for rev_deleted/user rights query conditions.

Todo:: Factor out rev_deleted logic per T233222

Returns: int

Definition at line 272 of file PageHistoryHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryHandler\getDbResults().

◆ getDbResults()

MediaWiki\Rest\Handler\PageHistoryHandler::getDbResults	(	Title	$titleObj,
		array	$params,
			$relativeRevId,
			$ts,
			$tagIds
	)

private

Parameters

Title	$titleObj	title object identifying the page to load history for
array	$params	request parameters
int	$relativeRevId	relative revision id for paging, or zero if none
int	$ts	timestamp for paging, or zero if none
array	$tagIds	validated tags ids, or empty array if not needed for this query

Returns: IResultWrapper|bool the results, or false if no query was executed

Definition at line 178 of file PageHistoryHandler.php.

References $dbr, $res, $revQuery, DB_REPLICA, Title\getArticleID(), and MediaWiki\Rest\Handler\PageHistoryHandler\getBitmask().

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

◆ 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 446 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 460 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.

Stable to override

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 416 of file PageHistoryHandler.php.

References MediaWiki\Rest\Handler\PageHistoryHandler\ALLOWED_FILTER_TYPES.

◆ getTitle()

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

private

Returns: Title|bool Title or false if unable to retrieve title

Definition at line 79 of file PageHistoryHandler.php.

References MediaWiki\Rest\Handler\PageHistoryHandler\$title, and MediaWiki\Rest\Handler\getValidatedParams().

◆ hasRepresentation()

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

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 473 of file PageHistoryHandler.php.

References $title, and getTitle().

◆ 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 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 412 of file PageHistoryHandler.php.

◆ processDbResults()

MediaWiki\Rest\Handler\PageHistoryHandler::processDbResults	(	$res,
		$titleObj,
		$params
	)

private

Parameters

IResultWrapper \| bool	$res	database results, or false if no query was executed
Title	$titleObj	title object identifying the page to load history for
array	$params	request parameters

Returns: array response data

Definition at line 291 of file PageHistoryHandler.php.

References $res, MediaWiki\Rest\Handler\getRouteUrl(), and wfTimestamp().

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

◆ 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 95 of file PageHistoryHandler.php.

References $res, MediaWiki\Rest\Handler\PageHistoryHandler\$title, MediaWiki\Rest\Handler\PageHistoryHandler\getDbResults(), MediaWiki\Rest\Handler\getResponseFactory(), MediaWiki\Rest\Handler\getValidatedParams(), and MediaWiki\Rest\Handler\PageHistoryHandler\processDbResults().

Member Data Documentation

◆ $changeTagDefStore

NameTableStore MediaWiki\Rest\Handler\PageHistoryHandler::$changeTagDefStore

private

Definition at line 37 of file PageHistoryHandler.php.

◆ $loadBalancer

ILoadBalancer MediaWiki\Rest\Handler\PageHistoryHandler::$loadBalancer

private

Definition at line 43 of file PageHistoryHandler.php.

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

◆ $permissionManager

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

private

Definition at line 40 of file PageHistoryHandler.php.

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

◆ $revisionStore

RevisionStore MediaWiki\Rest\Handler\PageHistoryHandler::$revisionStore

private

Definition at line 34 of file PageHistoryHandler.php.

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

◆ $title

Title bool null MediaWiki\Rest\Handler\PageHistoryHandler::$title = null

private

Definition at line 51 of file PageHistoryHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryHandler\getTitle(), and MediaWiki\Rest\Handler\PageHistoryHandler\run().

◆ $user

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

private

Definition at line 46 of file PageHistoryHandler.php.

◆ ALLOWED_FILTER_TYPES

const MediaWiki\Rest\Handler\PageHistoryHandler::ALLOWED_FILTER_TYPES = [ 'anonymous', 'bot', 'reverted', 'minor' ]

private

Definition at line 31 of file PageHistoryHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryHandler\getParamSettings().

◆ REVERTED_TAG_NAMES

const MediaWiki\Rest\Handler\PageHistoryHandler::REVERTED_TAG_NAMES = [ 'mw-undo', 'mw-rollback' ]

private

Definition at line 30 of file PageHistoryHandler.php.

◆ REVISIONS_RETURN_LIMIT

const MediaWiki\Rest\Handler\PageHistoryHandler::REVISIONS_RETURN_LIMIT = 20

private

Definition at line 29 of file PageHistoryHandler.php.

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

includes/Rest/Handler/PageHistoryHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBitmask()

◆ getDbResults()

◆ getETag()

◆ getLastModified()

◆ getParamSettings()

◆ getTitle()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ processDbResults()

◆ run()

Member Data Documentation

◆ $changeTagDefStore

◆ $loadBalancer

◆ $permissionManager

◆ $revisionStore

◆ $title

◆ $user

◆ ALLOWED_FILTER_TYPES

◆ REVERTED_TAG_NAMES

◆ REVISIONS_RETURN_LIMIT