MediaWiki  master
MediaWiki\Rest\Handler\PageHistoryCountHandler Class Reference

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

Inheritance diagram for MediaWiki\Rest\Handler\PageHistoryCountHandler:
Collaboration diagram for MediaWiki\Rest\Handler\PageHistoryCountHandler:

Public Member Functions

 __construct (RevisionStore $revisionStore, NameTableStoreFactory $nameTableStoreFactory, GroupPermissionsLookup $groupPermissionsLookup, ILoadBalancer $loadBalancer, WANObjectCache $cache, PageLookup $pageLookup, ActorMigration $actorMigration)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 run ( $title, $type)
 
- Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
 execute ()
 Execute the handler. More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyCacheControl (ResponseInterface $response)
 Apply cache control to enforce privacy. More...
 
 applyConditionalResponseHeaders (ResponseInterface $response)
 Apply verifier headers to the response, per RFC 7231 ยง7.2. More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 checkSession ()
 Check the session (and session provider) More...
 
 getAuthority ()
 Get the current acting authority. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getSession ()
 Get the Session. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 requireSafeAgainstCsrf ()
 Indicates whether this route can be accessed only by session providers safe vs csrf. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

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. More...
 
 getLastModified ()
 Returns latest of 2 timestamps: More...
 
 getLastModifiedTimes ()
 Returns array with 2 timestamps: More...
 
 getMinorCount ( $pageId, RevisionRecord $fromRev=null)
 
 getRevertedCount ( $pageId, RevisionRecord $fromRev=null)
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object. More...
 
 getETag ()
 The subclass should override this to provide an ETag for the current state of the requested resource. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getRouter ()
 Get the Router. More...
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint. More...
 
 hasRepresentation ()
 The subclass should override this to indicate whether the resource exists. More...
 
 postInitSetup ()
 The handler can override this to do any necessary setup after init() is called to inject the dependencies. More...
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called. More...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

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

Detailed Description

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

Definition at line 28 of file PageHistoryCountHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\PageHistoryCountHandler::__construct ( RevisionStore  $revisionStore,
NameTableStoreFactory  $nameTableStoreFactory,
GroupPermissionsLookup  $groupPermissionsLookup,
ILoadBalancer  $loadBalancer,
WANObjectCache  $cache,
PageLookup  $pageLookup,
ActorMigration  $actorMigration 
)
Parameters
RevisionStore$revisionStore
NameTableStoreFactory$nameTableStoreFactory
GroupPermissionsLookup$groupPermissionsLookup
ILoadBalancer$loadBalancer
WANObjectCache$cache
PageLookup$pageLookup
ActorMigration$actorMigration

Definition at line 86 of file PageHistoryCountHandler.php.

References $cache, and MediaWiki\Storage\NameTableStoreFactory\getChangeTagDef().

Member Function Documentation

◆ getAnonCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getAnonCount (   $pageId,
RevisionRecord  $fromRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
Returns
int the count

Definition at line 425 of file PageHistoryCountHandler.php.

References $dbr, $revQuery, and DB_REPLICA.

◆ getBotCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getBotCount (   $pageId,
RevisionRecord  $fromRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
Returns
int the count

Definition at line 462 of file PageHistoryCountHandler.php.

References $dbr, $revQuery, and DB_REPLICA.

◆ getEditorsCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getEditorsCount (   $pageId,
RevisionRecord  $fromRev = null,
RevisionRecord  $toRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
RevisionRecord | null$toRev
Returns
int the count

Definition at line 510 of file PageHistoryCountHandler.php.

References getAuthority().

◆ getEditsCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getEditsCount (   $pageId,
RevisionRecord  $fromRev = null,
RevisionRecord  $toRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
RevisionRecord | null$toRev
Returns
int the count

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

◆ getLastModified()

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

Returns latest of 2 timestamps:

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 309 of file PageHistoryCountHandler.php.

◆ getLastModifiedTimes()

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

Returns array with 2 timestamps:

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

Definition at line 323 of file PageHistoryCountHandler.php.

References wfTimestampOrNull().

◆ getMinorCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getMinorCount (   $pageId,
RevisionRecord  $fromRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
Returns
int the count

Definition at line 580 of file PageHistoryCountHandler.php.

References $dbr, and DB_REPLICA.

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

◆ getRevertedCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getRevertedCount (   $pageId,
RevisionRecord  $fromRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
Returns
int the count

Definition at line 524 of file PageHistoryCountHandler.php.

References $dbr, DB_REPLICA, and 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 658 of file PageHistoryCountHandler.php.

◆ run()

MediaWiki\Rest\Handler\PageHistoryCountHandler::run (   $title,
  $type 
)
Parameters
string$titlethe title of the page to load history for
string$typethe validated count type
Returns
Response
Exceptions
LocalizedHttpException

Definition at line 143 of file PageHistoryCountHandler.php.

References $title, $type, MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\getResponseFactory().


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