MediaWiki master
|
Handler class for Core REST API endpoints that perform operations on revisions. More...
Inherits MediaWiki\Rest\SimpleHandler.
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. | |
getBodyParamSettings () | |
Fetch ParamValidator settings for body fields. | |
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 relative to the module prefix. | |
getRequest () | |
Get the current request. | |
getResponseFactory () | |
Get the ResponseFactory which can be used to generate Response objects. | |
getSession () | |
Get the Session. | |
getSupportedPathParams () | |
Get a list of parameter placeholders present in the route's path as returned by getPath(). | |
getSupportedRequestTypes () | |
Returns the content types that should be accepted by parseBodyData(). | |
getValidatedBody () | |
Fetch the validated body. | |
getValidatedParams () | |
Fetch the validated parameters. | |
initContext (Module $module, array $routeConfig) | |
Injects information about the handler's context in the Module. | |
initForExecute (RequestInterface $request) | |
Initialise for execution based on the given request. | |
initServices (Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer) | |
Inject service objects. | |
initSession (Session $session) | |
Inject session information. | |
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. | |
getModule () | |
Get the Module this handler belongs to. | |
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 |
Handler class for Core REST API endpoints that perform operations on revisions.
Definition at line 29 of file PageHistoryCountHandler.php.
MediaWiki\Rest\Handler\PageHistoryCountHandler::__construct | ( | RevisionStore | $revisionStore, |
NameTableStoreFactory | $nameTableStoreFactory, | ||
GroupPermissionsLookup | $groupPermissionsLookup, | ||
IConnectionProvider | $dbProvider, | ||
WANObjectCache | $cache, | ||
PageLookup | $pageLookup, | ||
PageRestHelperFactory | $helperFactory ) |
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().
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev |
Definition at line 434 of file PageHistoryCountHandler.php.
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev |
Definition at line 463 of file PageHistoryCountHandler.php.
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev | |
RevisionRecord | null | $toRev |
Definition at line 504 of file PageHistoryCountHandler.php.
References getAuthority().
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev | |
RevisionRecord | null | $toRev |
Definition at line 588 of file PageHistoryCountHandler.php.
|
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.
Definition at line 373 of file PageHistoryCountHandler.php.
|
protected |
Returns latest of 2 timestamps:
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 319 of file PageHistoryCountHandler.php.
|
protected |
Returns array with 2 timestamps:
Definition at line 333 of file PageHistoryCountHandler.php.
References wfTimestampOrNull().
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev |
Definition at line 560 of file PageHistoryCountHandler.php.
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 the request body as well, by setting self::PARAM_SOURCE to "post" or "body". Note that the values of "body" parameters will become accessible through getValidatedBody(), while the values of "post" parameters will be accessible through getValidatedParams(). "post" parameters are used with form data (application/x-www-form-urlencoded or multipart/form-data).
For "query" and "body" parameters, a PARAM_REQUIRED setting of "false" means the caller does not have to supply the parameter. For "path" parameters, the path matcher will always require the caller to supply all path parameters for a route, regardless of the PARAM_REQUIRED setting. However, "path" parameters may be specified in getParamSettings() as non-required to indicate that the handler services multiple routes, some of which may not supply the parameter.
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 642 of file PageHistoryCountHandler.php.
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev |
Definition at line 518 of file PageHistoryCountHandler.php.
References ChangeTags\REVERT_TAGS.
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.
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 638 of file PageHistoryCountHandler.php.
MediaWiki\Rest\Handler\PageHistoryCountHandler::run | ( | $title, | |
$type ) |
string | $title | the title of the page to load history for |
string | $type | the validated count type |
LocalizedHttpException |
Definition at line 141 of file PageHistoryCountHandler.php.
References $params, getAuthority(), MediaWiki\Rest\Handler\getResponseFactory(), and MediaWiki\Rest\Handler\getValidatedParams().