MediaWiki REL1_37
|
Handler class for Core REST API endpoints that perform operations on revisions. More...
Public Member Functions | |
__construct (RevisionStore $revisionStore, NameTableStoreFactory $nameTableStoreFactory, GroupPermissionsLookup $groupPermissionsLookup, ILoadBalancer $loadBalancer, PageLookup $pageLookup, TitleFormatter $titleFormatter) | |
RevisionStore $revisionStore. | |
getParamSettings () | |
Fetch ParamValidator settings for parameters. | |
needsWriteAccess () | |
Indicates whether this route requires write access. | |
run ( $title) | |
At most one of older_than and newer_than may be specified. | |
![]() | |
execute () | |
Execute the 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. | |
getAuthority () | |
Get the current acting authority. | |
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, Authority $authority, 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 | |
getETag () | |
Returns an ETag representing a page's latest revision. | |
getLastModified () | |
Returns the time of the last change to the page. | |
hasRepresentation () | |
![]() | |
getConditionalHeaderUtil () | |
Get a ConditionalHeaderUtil object. | |
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. | |
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. | |
Private Member Functions | |
getBitmask () | |
Helper function for rev_deleted/user rights query conditions. | |
getDbResults (ExistingPageRecord $page, array $params, $relativeRevId, $ts, $tagIds) | |
getPage () | |
processDbResults ( $res, $page, $params) | |
Private Attributes | |
NameTableStore | $changeTagDefStore |
GroupPermissionsLookup | $groupPermissionsLookup |
ILoadBalancer | $loadBalancer |
ExistingPageRecord false null | $page = false |
PageLookup | $pageLookup |
RevisionStore | $revisionStore |
TitleFormatter | $titleFormatter |
const | ALLOWED_FILTER_TYPES = [ 'anonymous', 'bot', 'reverted', 'minor' ] |
const | REVISIONS_RETURN_LIMIT = 20 |
Additional Inherited Members | |
![]() | |
const | PARAM_SOURCE = 'rest-param-source' |
(string) ParamValidator constant to specify the source of the parameter. | |
Handler class for Core REST API endpoints that perform operations on revisions.
Definition at line 29 of file PageHistoryHandler.php.
MediaWiki\Rest\Handler\PageHistoryHandler::__construct | ( | RevisionStore | $revisionStore, |
NameTableStoreFactory | $nameTableStoreFactory, | ||
GroupPermissionsLookup | $groupPermissionsLookup, | ||
ILoadBalancer | $loadBalancer, | ||
PageLookup | $pageLookup, | ||
TitleFormatter | $titleFormatter | ||
) |
RevisionStore $revisionStore.
RevisionStore | $revisionStore | |
NameTableStoreFactory | $nameTableStoreFactory | |
GroupPermissionsLookup | $groupPermissionsLookup | |
ILoadBalancer | $loadBalancer | |
PageLookup | $pageLookup | |
TitleFormatter | $titleFormatter |
Definition at line 66 of file PageHistoryHandler.php.
References MediaWiki\Rest\Handler\PageHistoryHandler\$groupPermissionsLookup, MediaWiki\Rest\Handler\PageHistoryHandler\$loadBalancer, MediaWiki\Rest\Handler\PageHistoryHandler\$pageLookup, MediaWiki\Rest\Handler\PageHistoryHandler\$revisionStore, MediaWiki\Rest\Handler\PageHistoryHandler\$titleFormatter, and MediaWiki\Storage\NameTableStoreFactory\getChangeTagDef().
|
private |
Helper function for rev_deleted/user rights query conditions.
Definition at line 282 of file PageHistoryHandler.php.
References getAuthority().
|
private |
ExistingPageRecord | $page | object identifying the page to load history for |
array | $params | request parameters |
int | $relativeRevId | relative revision id for paging, or zero if none |
int | $ts | timestamp for paging, or zero if none |
array | $tagIds | validated tags ids, or empty array if not needed for this query |
Definition at line 186 of file PageHistoryHandler.php.
References $dbr, $res, $revQuery, DB_REPLICA, and MediaWiki\Page\ProperPageIdentity\getId().
|
protected |
Returns an ETag representing a page's latest revision.
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 454 of file PageHistoryHandler.php.
|
protected |
Returns the time of the last change to the page.
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 468 of file PageHistoryHandler.php.
|
private |
Definition at line 85 of file PageHistoryHandler.php.
References MediaWiki\Rest\Handler\getValidatedParams().
MediaWiki\Rest\Handler\PageHistoryHandler::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().
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 424 of file PageHistoryHandler.php.
|
protected |
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 481 of file PageHistoryHandler.php.
MediaWiki\Rest\Handler\PageHistoryHandler::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 420 of file PageHistoryHandler.php.
|
private |
IResultWrapper | bool | $res | database results, or false if no query was executed |
ExistingPageRecord | $page | object identifying the page to load history for |
array | $params | request parameters |
Definition at line 299 of file PageHistoryHandler.php.
References $res, getAuthority(), MediaWiki\Rest\Handler\getRouteUrl(), and wfTimestamp().
MediaWiki\Rest\Handler\PageHistoryHandler::run | ( | $title | ) |
At most one of older_than and newer_than may be specified.
Keep in mind that revision ids are not monotonically increasing, so a revision may be older than another but have a higher revision id.
string | $title |
LocalizedHttpException |
Definition at line 103 of file PageHistoryHandler.php.
References $res, $title, getAuthority(), MediaWiki\Rest\Handler\getResponseFactory(), MediaWiki\Rest\Handler\getValidatedParams(), and ChangeTags\REVERT_TAGS.
|
private |
Definition at line 37 of file PageHistoryHandler.php.
|
private |
Definition at line 40 of file PageHistoryHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryHandler\__construct().
|
private |
Definition at line 43 of file PageHistoryHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryHandler\__construct().
|
private |
Definition at line 54 of file PageHistoryHandler.php.
|
private |
Definition at line 46 of file PageHistoryHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryHandler\__construct().
|
private |
Definition at line 34 of file PageHistoryHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryHandler\__construct().
|
private |
Definition at line 49 of file PageHistoryHandler.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryHandler\__construct().
|
private |
Definition at line 31 of file PageHistoryHandler.php.
|
private |
Definition at line 30 of file PageHistoryHandler.php.