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

Inheritance diagram for MediaWiki\Rest\Handler\PageHistoryCountHandler:

[legend]

Collaboration diagram for MediaWiki\Rest\Handler\PageHistoryCountHandler:

[legend]

Public Member Functions
	__construct (RevisionStore $revisionStore, NameTableStoreFactory $nameTableStoreFactory, PermissionManager $permissionManager, ILoadBalancer $loadBalancer, WANObjectCache $cache)

	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
	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
	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
	getConditionalHeaderUtil ()
	Get a ConditionalHeaderUtil object.

	getETag ()
	The subclass should override this to provide an ETag for the current request.

	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.

	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.

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

Private Member Functions
	getCachedCount ( $type, callable $fetchCount)

	getCount ( $type)

	getCurrentRevision ()

	getRevisionOrThrow ( $revId)

	getTitle ()

	loggingTableTime ( $pageId)
	Return timestamp of latest entry in logging table for given page id.

	normalizeType ( $type)

	orderRevisions (RevisionRecord $fromRev=null, RevisionRecord $toRev=null)
	Reorders revisions if they are present.

	validateParameterCombination ( $type)
	Validates that the provided parameter combination is supported.

Private Attributes
WANObjectCache	$cache

NameTableStore	$changeTagDefStore

array	$lastModifiedTimes

ILoadBalancer	$loadBalancer

PermissionManager	$permissionManager

RevisionRecord bool	$revision

RevisionStore	$revisionStore

Title	$titleObject

User	$user

const	COUNT_LIMITS
	The maximum number of counts to return per type of revision.

const	DEPRECATED_COUNT_TYPES

const	MAX_AGE_200 = 60

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

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 27 of file PageHistoryCountHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

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

Definition at line 82 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\PageHistoryCountHandler\$cache, MediaWiki\Rest\Handler\PageHistoryCountHandler\$loadBalancer, MediaWiki\Rest\Handler\PageHistoryCountHandler\$permissionManager, MediaWiki\Rest\Handler\PageHistoryCountHandler\$revisionStore, and 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 416 of file PageHistoryCountHandler.php.

References $dbr, and DB_REPLICA.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ 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 461 of file PageHistoryCountHandler.php.

References $dbr, and DB_REPLICA.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getCachedCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getCachedCount	(		$type,
		callable	$fetchCount
	)

private

Parameters

string	$type
callable	$fetchCount

Returns: int

Definition at line 366 of file PageHistoryCountHandler.php.

References $type, MediaWiki\Rest\Handler\PageHistoryCountHandler\getCurrentRevision(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModified(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\getTitle().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getCount ( $type )

private

Parameters

string $type the validated count type

Returns: int the article count

Exceptions

LocalizedHttpException

Definition at line 184 of file PageHistoryCountHandler.php.

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

◆ getCurrentRevision()

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

private

Returns: RevisionRecord|bool current revision or false if unable to retrieve revision

Definition at line 275 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\PageHistoryCountHandler\$revision, $title, and MediaWiki\Rest\Handler\PageHistoryCountHandler\getTitle().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCachedCount(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes().

◆ 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 517 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\PageHistoryCountHandler\orderRevisions().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ 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 613 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\PageHistoryCountHandler\orderRevisions().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ 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 precendence 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 357 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 303 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\PageHistoryCountHandler\$lastModifiedTimes, and MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCachedCount().

◆ 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

Definition at line 316 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\PageHistoryCountHandler\$lastModifiedTimes, MediaWiki\Rest\Handler\PageHistoryCountHandler\getCurrentRevision(), MediaWiki\Rest\Handler\PageHistoryCountHandler\loggingTableTime(), and wfTimestampOrNull().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCachedCount(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModified().

◆ 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 586 of file PageHistoryCountHandler.php.

References $dbr, and DB_REPLICA.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

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

Stable to override

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 667 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 531 of file PageHistoryCountHandler.php.

References $dbr, and DB_REPLICA.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getRevisionOrThrow()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getRevisionOrThrow ( $revId )

private

Parameters

int $revId

Returns: RevisionRecord

Exceptions

LocalizedHttpException

Definition at line 632 of file PageHistoryCountHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getTitle()

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

private

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

Definition at line 290 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\PageHistoryCountHandler\$titleObject, and MediaWiki\Rest\Handler\getValidatedParams().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCachedCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getCurrentRevision(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\run().

◆ loggingTableTime()

MediaWiki\Rest\Handler\PageHistoryCountHandler::loggingTableTime ( $pageId )

private

Return timestamp of latest entry in logging table for given page id.

Parameters

int $pageId

Returns: int|null

Definition at line 337 of file PageHistoryCountHandler.php.

References $res, DB_REPLICA, and wfTimestamp().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes().

◆ 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 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 663 of file PageHistoryCountHandler.php.

◆ normalizeType()

MediaWiki\Rest\Handler\PageHistoryCountHandler::normalizeType ( $type )

private

Definition at line 99 of file PageHistoryCountHandler.php.

References $type.

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

◆ orderRevisions()

MediaWiki\Rest\Handler\PageHistoryCountHandler::orderRevisions	(	RevisionRecord	$fromRev = `null`,
		RevisionRecord	$toRev = `null`
	)

private

Reorders revisions if they are present.

Parameters

RevisionRecord \| null	$fromRev
RevisionRecord \| null	$toRev

Returns: array -return array{0:RevisionRecord|null,1:RevisionRecord|null}

Definition at line 650 of file PageHistoryCountHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getEditorsCount(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\getEditsCount().

◆ run()

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

Parameters

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

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 138 of file PageHistoryCountHandler.php.

References $title, $type, MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount(), MediaWiki\Rest\Handler\getResponseFactory(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getTitle(), MediaWiki\Rest\Handler\PageHistoryCountHandler\normalizeType(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\validateParameterCombination().

◆ validateParameterCombination()

MediaWiki\Rest\Handler\PageHistoryCountHandler::validateParameterCombination ( $type )

private

Validates that the provided parameter combination is supported.

Parameters

string $type

Exceptions

LocalizedHttpException

Definition at line 109 of file PageHistoryCountHandler.php.

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

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

Member Data Documentation

◆ $cache

WANObjectCache MediaWiki\Rest\Handler\PageHistoryCountHandler::$cache

private

Definition at line 61 of file PageHistoryCountHandler.php.

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

◆ $changeTagDefStore

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

private

Definition at line 52 of file PageHistoryCountHandler.php.

◆ $lastModifiedTimes

array MediaWiki\Rest\Handler\PageHistoryCountHandler::$lastModifiedTimes

private

Definition at line 70 of file PageHistoryCountHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModified(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes().

◆ $loadBalancer

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

private

Definition at line 58 of file PageHistoryCountHandler.php.

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

◆ $permissionManager

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

private

Definition at line 55 of file PageHistoryCountHandler.php.

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

◆ $revision

RevisionRecord bool MediaWiki\Rest\Handler\PageHistoryCountHandler::$revision

private

Definition at line 67 of file PageHistoryCountHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCurrentRevision().

◆ $revisionStore

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

private

Definition at line 49 of file PageHistoryCountHandler.php.

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

◆ $titleObject

Title MediaWiki\Rest\Handler\PageHistoryCountHandler::$titleObject

private

Definition at line 73 of file PageHistoryCountHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getTitle().

◆ $user

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

private

Definition at line 64 of file PageHistoryCountHandler.php.

◆ COUNT_LIMITS

const MediaWiki\Rest\Handler\PageHistoryCountHandler::COUNT_LIMITS

private

Initial value:

= [
        'anonymous' => 10000,
        'bot' => 10000,
        'editors' => 25000,
        'edits' => 30000,
        'minor' => 1000,
        'reverted' => 30000
    ]

The maximum number of counts to return per type of revision.

Definition at line 29 of file PageHistoryCountHandler.php.

◆ DEPRECATED_COUNT_TYPES

const MediaWiki\Rest\Handler\PageHistoryCountHandler::DEPRECATED_COUNT_TYPES

private

Initial value:

= [
        'anonedits' => 'anonymous',
        'botedits' => 'bot',
        'revertededits' => 'reverted'
    ]

Definition at line 38 of file PageHistoryCountHandler.php.

◆ MAX_AGE_200

const MediaWiki\Rest\Handler\PageHistoryCountHandler::MAX_AGE_200 = 60

private

Definition at line 44 of file PageHistoryCountHandler.php.

◆ REVERTED_TAG_NAMES

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

private

Definition at line 46 of file PageHistoryCountHandler.php.

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

includes/Rest/Handler/PageHistoryCountHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAnonCount()

◆ getBotCount()

◆ getCachedCount()

◆ getCount()

◆ getCurrentRevision()

◆ getEditorsCount()

◆ getEditsCount()

◆ getEtag()

◆ getLastModified()

◆ getLastModifiedTimes()

◆ getMinorCount()

◆ getParamSettings()

◆ getRevertedCount()

◆ getRevisionOrThrow()

◆ getTitle()

◆ loggingTableTime()

◆ needsWriteAccess()

◆ normalizeType()

◆ orderRevisions()

◆ run()

◆ validateParameterCombination()

Member Data Documentation

◆ $cache

◆ $changeTagDefStore

◆ $lastModifiedTimes

◆ $loadBalancer

◆ $permissionManager

◆ $revision

◆ $revisionStore

◆ $titleObject

◆ $user

◆ COUNT_LIMITS

◆ DEPRECATED_COUNT_TYPES

◆ MAX_AGE_200

◆ REVERTED_TAG_NAMES