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

Collaboration diagram for MediaWiki\Rest\Handler\PageHistoryCountHandler:

[legend]

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

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

	needsWriteAccess ()
	Indicates whether this route requires write access.

	run ( $title, $type)

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.

	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.

	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
	getAnonCount ( $pageId, RevisionRecord $fromRev=null)

	getBotCount ( $pageId, RevisionRecord $fromRev=null)

	getEditorsCount ( $pageId, RevisionRecord $fromRev=null, RevisionRecord $toRev=null)

	getEditsCount ( $pageId, RevisionRecord $fromRev=null, RevisionRecord $toRev=null)

	getEtag ()
	Choosing to not implement etags in this handler.

	getLastModified ()
	Returns latest of 2 timestamps:

	getLastModifiedTimes ()
	Returns array with 2 timestamps:

	getMinorCount ( $pageId, RevisionRecord $fromRev=null)

	getRevertedCount ( $pageId, RevisionRecord $fromRev=null)

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.

	getETag ()
	The subclass should override this to provide an ETag for the current state of the requested resource.

	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.

	getResponseBodySchema ()
	Returns an OpenAPI Schema 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.

	hasRepresentation ()
	The subclass should override this to indicate whether the resource exists.

	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	KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES

const	PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION

const	PARAM_SOURCE = Validator::PARAM_SOURCE

Detailed Description

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

Definition at line 29 of file PageHistoryCountHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\PageHistoryCountHandler::__construct	(	RevisionStore	$revisionStore,
		NameTableStoreFactory	$nameTableStoreFactory,
		GroupPermissionsLookup	$groupPermissionsLookup,
		IConnectionProvider	$dbProvider,
		WANObjectCache	$cache,
		PageLookup	$pageLookup,
		PageRestHelperFactory	$helperFactory )

Parameters

RevisionStore	$revisionStore
NameTableStoreFactory	$nameTableStoreFactory
GroupPermissionsLookup	$groupPermissionsLookup
IConnectionProvider	$dbProvider
WANObjectCache	$cache
PageLookup	$pageLookup
PageRestHelperFactory	$helperFactory

Definition at line 75 of file PageHistoryCountHandler.php.

References MediaWiki\Storage\NameTableStoreFactory\getChangeTagDef().

Member Function Documentation

◆ getAnonCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getAnonCount	(		$pageId,
		RevisionRecord	$fromRev = null )

protected

Parameters

int	$pageId	the id of the page to load history for
RevisionRecord \| null	$fromRev

Returns: int the count

Definition at line 434 of file PageHistoryCountHandler.php.

◆ getBotCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getBotCount	(		$pageId,
		RevisionRecord	$fromRev = null )

protected

Parameters

int	$pageId	the id of the page to load history for
RevisionRecord \| null	$fromRev

Returns: int the count

Definition at line 463 of file PageHistoryCountHandler.php.

◆ getEditorsCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getEditorsCount	(		$pageId,
		RevisionRecord	$fromRev = null,
		RevisionRecord	$toRev = null )

protected

Parameters

int	$pageId	the id of the page to load history for
RevisionRecord \| null	$fromRev
RevisionRecord \| null	$toRev

Returns: int the count

Definition at line 504 of file PageHistoryCountHandler.php.

References getAuthority().

◆ getEditsCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getEditsCount	(		$pageId,
		RevisionRecord	$fromRev = null,
		RevisionRecord	$toRev = null )

protected

Parameters

int	$pageId	the id of the page to load history for
RevisionRecord \| null	$fromRev
RevisionRecord \| null	$toRev

Returns: int the count

Definition at line 588 of file PageHistoryCountHandler.php.

◆ getEtag()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getEtag ( )

protected

Choosing to not implement etags in this handler.

Generating an etag when getting revision counts must account for things like visibility settings (e.g. rev_deleted bit) which requires hitting the database anyway. The response for these requests are so small that we wouldn't be gaining much efficiency. Etags are strong validators and if provided would take precedence over last modified time, a weak validator. We want to ensure only last modified time is used since it is more efficient than using etags for this particular case.

Returns: null

Definition at line 373 of file PageHistoryCountHandler.php.

◆ getLastModified()

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

protected

Returns latest of 2 timestamps:

Current revision
OR entry from the DB logging table for the given page
Returns
int|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 319 of file PageHistoryCountHandler.php.

◆ getLastModifiedTimes()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getLastModifiedTimes ( )

protected

Returns array with 2 timestamps:

Current revision
OR entry from the DB logging table for the given page
Returns
array|null

Definition at line 333 of file PageHistoryCountHandler.php.

References wfTimestampOrNull().

◆ getMinorCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getMinorCount	(		$pageId,
		RevisionRecord	$fromRev = null )

protected

Parameters

int	$pageId	the id of the page to load history for
RevisionRecord \| null	$fromRev

Returns: int the count

Definition at line 560 of file PageHistoryCountHandler.php.

◆ getParamSettings()

MediaWiki\Rest\Handler\PageHistoryCountHandler::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 642 of file PageHistoryCountHandler.php.

◆ getRevertedCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getRevertedCount	(		$pageId,
		RevisionRecord	$fromRev = null )

protected

Parameters

int	$pageId	the id of the page to load history for
RevisionRecord \| null	$fromRev

Returns: int the count

Definition at line 518 of file PageHistoryCountHandler.php.

References ChangeTags\REVERT_TAGS.

◆ needsWriteAccess()

MediaWiki\Rest\Handler\PageHistoryCountHandler::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 638 of file PageHistoryCountHandler.php.

◆ run()

MediaWiki\Rest\Handler\PageHistoryCountHandler::run	(		$title,
			$type )

Parameters

string	$title	the title of the page to load history for
string	$type	the validated count type

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 141 of file PageHistoryCountHandler.php.

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

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

includes/Rest/Handler/PageHistoryCountHandler.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAnonCount()

◆ getBotCount()

◆ getEditorsCount()

◆ getEditsCount()

◆ getEtag()

◆ getLastModified()

◆ getLastModifiedTimes()

◆ getMinorCount()

◆ getParamSettings()

◆ getRevertedCount()

◆ needsWriteAccess()

◆ run()