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, PageLookup $pageLookup, TitleFormatter $titleFormatter, PageRestHelperFactory $helperFactory) | |
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. | |
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 | |
getETag () | |
Returns an ETag representing a page's latest revision. | |
getLastModified () | |
Returns the time of the last change to the page. | |
hasRepresentation () | |
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. | |
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. | |
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 31 of file PageHistoryHandler.php.
MediaWiki\Rest\Handler\PageHistoryHandler::__construct | ( | RevisionStore | $revisionStore, |
NameTableStoreFactory | $nameTableStoreFactory, | ||
GroupPermissionsLookup | $groupPermissionsLookup, | ||
IConnectionProvider | $dbProvider, | ||
PageLookup | $pageLookup, | ||
TitleFormatter | $titleFormatter, | ||
PageRestHelperFactory | $helperFactory ) |
RevisionStore $revisionStore.
RevisionStore | $revisionStore | |
NameTableStoreFactory | $nameTableStoreFactory | |
GroupPermissionsLookup | $groupPermissionsLookup | |
IConnectionProvider | $dbProvider | |
PageLookup | $pageLookup | |
TitleFormatter | $titleFormatter | |
PageRestHelperFactory | $helperFactory |
Definition at line 60 of file PageHistoryHandler.php.
References MediaWiki\Storage\NameTableStoreFactory\getChangeTagDef().
|
protected |
Returns an ETag representing a page's latest revision.
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 456 of file PageHistoryHandler.php.
|
protected |
Returns the time of the last change to the page.
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 470 of file PageHistoryHandler.php.
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 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 426 of file PageHistoryHandler.php.
|
protected |
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 483 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 422 of file PageHistoryHandler.php.
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 108 of file PageHistoryHandler.php.
References $params, getAuthority(), and ChangeTags\REVERT_TAGS.