MediaWiki
master
|
Handler class for Core REST API endpoints that perform operations on revisions. More...
Public Member Functions | |
__construct (RevisionStore $revisionStore, NameTableStoreFactory $nameTableStoreFactory, PermissionManager $permissionManager, ILoadBalancer $loadBalancer, WANObjectCache $cache) | |
getParamSettings () | |
Fetch ParamValidator settings for parameters. More... | |
needsWriteAccess () | |
Indicates whether this route requires write access. More... | |
run ( $title, $type) | |
![]() | |
execute () | |
Execute the handler. More... | |
![]() | |
applyConditionalResponseHeaders (ResponseInterface $response) | |
Modify the response, adding Last-Modified and ETag headers as indicated the values previously returned by ETag and getLastModified(). More... | |
checkPreconditions () | |
Check the conditional request headers and generate a response if appropriate. 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... | |
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) | |
Initialise with dependencies from the Router. More... | |
needsReadAccess () | |
Indicates whether this route requires read rights. 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) | |
![]() | |
getConditionalHeaderUtil () | |
Get a ConditionalHeaderUtil object. More... | |
getETag () | |
The subclass should override this to provide an ETag for the current request. 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... | |
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. More... | |
normalizeType ( $type) | |
orderRevisions (RevisionRecord $fromRev=null, RevisionRecord $toRev=null) | |
Reorders revisions if they are present. More... | |
validateParameterCombination ( $type) | |
Validates that the provided parameter combination is supported. More... | |
Private Attributes | |
WANObjectCache | $cache |
NameTableStore | $changeTagDefStore |
array | $lastModifiedTimes |
ILoadBalancer | $loadBalancer |
PermissionManager | $permissionManager |
RevisionRecord bool | $revision |
RevisionStore | $revisionStore |
Title | $titleObject |
const | COUNT_LIMITS |
The maximum number of counts to return per type of revision. More... | |
const | DEPRECATED_COUNT_TYPES |
const | MAX_AGE_200 = 60 |
Additional Inherited Members | |
![]() | |
const | PARAM_SOURCE = 'rest-param-source' |
(string) ParamValidator constant to specify the source of the parameter. More... | |
Handler class for Core REST API endpoints that perform operations on revisions.
Definition at line 26 of file PageHistoryCountHandler.php.
MediaWiki\Rest\Handler\PageHistoryCountHandler::__construct | ( | RevisionStore | $revisionStore, |
NameTableStoreFactory | $nameTableStoreFactory, | ||
PermissionManager | $permissionManager, | ||
ILoadBalancer | $loadBalancer, | ||
WANObjectCache | $cache | ||
) |
RevisionStore | $revisionStore | |
NameTableStoreFactory | $nameTableStoreFactory | |
PermissionManager | $permissionManager | |
ILoadBalancer | $loadBalancer | |
WANObjectCache | $cache |
Definition at line 76 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().
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev |
Definition at line 407 of file PageHistoryCountHandler.php.
References $dbr, DB_REPLICA, Revision\RevisionRecord\DELETED_TEXT, and Revision\RevisionRecord\DELETED_USER.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev |
Definition at line 452 of file PageHistoryCountHandler.php.
References $dbr, DB_REPLICA, Revision\RevisionRecord\DELETED_TEXT, and Revision\RevisionRecord\DELETED_USER.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().
|
private |
string | $type | |
callable | $fetchCount |
Definition at line 357 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().
|
private |
string | $type | the validated count type |
LocalizedHttpException |
Definition at line 175 of file PageHistoryCountHandler.php.
References $type, MediaWiki\Rest\Handler\PageHistoryCountHandler\getAnonCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getBotCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getCachedCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getEditorsCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getEditsCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getMinorCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getRevertedCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getRevisionOrThrow(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getTitle(), and MediaWiki\Rest\Handler\getValidatedParams().
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\run().
|
private |
Definition at line 266 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().
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev | |
RevisionRecord | null | $toRev |
Definition at line 508 of file PageHistoryCountHandler.php.
References MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\orderRevisions().
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev | |
RevisionRecord | null | $toRev |
Definition at line 604 of file PageHistoryCountHandler.php.
References MediaWiki\Rest\Handler\PageHistoryCountHandler\orderRevisions().
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().
|
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.
Definition at line 348 of file PageHistoryCountHandler.php.
|
protected |
Returns latest of 2 timestamps:
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 294 of file PageHistoryCountHandler.php.
References MediaWiki\Rest\Handler\PageHistoryCountHandler\$lastModifiedTimes, and MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes().
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCachedCount().
|
protected |
Returns array with 2 timestamps:
Definition at line 307 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().
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev |
Definition at line 577 of file PageHistoryCountHandler.php.
References $dbr, DB_REPLICA, and Revision\RevisionRecord\DELETED_TEXT.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().
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().
Stable to override
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 658 of file PageHistoryCountHandler.php.
|
protected |
int | $pageId | the id of the page to load history for |
RevisionRecord | null | $fromRev |
Definition at line 522 of file PageHistoryCountHandler.php.
References $dbr, DB_REPLICA, Revision\RevisionRecord\DELETED_TEXT, and ChangeTags\REVERT_TAGS.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().
|
private |
int | $revId |
LocalizedHttpException |
Definition at line 623 of file PageHistoryCountHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().
|
private |
Definition at line 281 of file PageHistoryCountHandler.php.
References MediaWiki\Rest\Handler\PageHistoryCountHandler\$titleObject, MediaWiki\Rest\Handler\getValidatedParams(), and Title\newFromText().
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCachedCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getCurrentRevision(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\run().
|
private |
Return timestamp of latest entry in logging table for given page id.
int | $pageId |
Definition at line 328 of file PageHistoryCountHandler.php.
References $res, DB_REPLICA, and wfTimestamp().
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes().
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
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 654 of file PageHistoryCountHandler.php.
|
private |
Definition at line 90 of file PageHistoryCountHandler.php.
References $type.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\run().
|
private |
Reorders revisions if they are present.
RevisionRecord | null | $fromRev | |
RevisionRecord | null | $toRev |
Definition at line 641 of file PageHistoryCountHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getEditorsCount(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\getEditsCount().
MediaWiki\Rest\Handler\PageHistoryCountHandler::run | ( | $title, | |
$type | |||
) |
Title | $title | the title of the page to load history for |
string | $type | the validated count type |
LocalizedHttpException |
Definition at line 129 of file PageHistoryCountHandler.php.
References $title, $type, MediaWiki\Rest\Handler\getAuthority(), 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().
|
private |
Validates that the provided parameter combination is supported.
string | $type |
LocalizedHttpException |
Definition at line 100 of file PageHistoryCountHandler.php.
References $type, and MediaWiki\Rest\Handler\getValidatedParams().
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\run().
|
private |
Definition at line 58 of file PageHistoryCountHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\__construct().
|
private |
Definition at line 49 of file PageHistoryCountHandler.php.
|
private |
Definition at line 64 of file PageHistoryCountHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModified(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes().
|
private |
Definition at line 55 of file PageHistoryCountHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\__construct().
|
private |
Definition at line 52 of file PageHistoryCountHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\__construct().
|
private |
Definition at line 61 of file PageHistoryCountHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCurrentRevision().
|
private |
Definition at line 46 of file PageHistoryCountHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\__construct().
|
private |
Definition at line 67 of file PageHistoryCountHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getTitle().
|
private |
The maximum number of counts to return per type of revision.
Definition at line 28 of file PageHistoryCountHandler.php.
|
private |
Definition at line 37 of file PageHistoryCountHandler.php.
|
private |
Definition at line 43 of file PageHistoryCountHandler.php.