Inherits MediaWiki\Rest\Handler.
Public Member Functions | |
| __construct (RevisionLookup $revisionLookup, ParserFactory $parserFactory) | |
| execute () | |
| Execute the handler. | |
| getParamSettings () | |
| Fetch ParamValidator settings for parameters. | |
| 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.
| |
 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. | |
| 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, including path variables. | |
| getRequest () | |
| Get the current request. | |
| getResponseFactory () | |
| Get the ResponseFactory which can be used to generate Response objects. | |
| getSession () | |
| Get the Session. | |
| getValidatedBody () | |
| Fetch the validated body. | |
| getValidatedParams () | |
| Fetch the validated parameters. | |
| init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session) | |
| Initialise with dependencies from the Router. | |
| 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. | |
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 |
| 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. | |
| getLastModified () | |
| The subclass should override this to provide the maximum last modified timestamp of the requested resource. | |
| 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. | |
Detailed Description
Definition at line 18 of file CompareHandler.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Rest\Handler\CompareHandler::__construct | ( | RevisionLookup | $revisionLookup, |
| ParserFactory | $parserFactory ) |
Definition at line 31 of file CompareHandler.php.
Member Function Documentation
◆ execute()
| MediaWiki\Rest\Handler\CompareHandler::execute | ( | ) |
Execute the handler.
This is called after parameter validation. The return value can either be a Response or any type accepted by ResponseFactory::createFromReturnValue().
To automatically construct an error response, execute() should throw a \MediaWiki\Rest\HttpException. Such exceptions will not be logged like a normal exception.
If execute() throws any other kind of exception, the exception will be logged and a generic 500 error page will be shown.
- Stability: stable
- to override
- Returns
- mixed
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 39 of file CompareHandler.php.
References MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\getResponseFactory().
◆ getParamSettings()
| MediaWiki\Rest\Handler\CompareHandler::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 194 of file CompareHandler.php.
References MediaWiki\Rest\Handler\PARAM_SOURCE.
◆ needsWriteAccess()
| MediaWiki\Rest\Handler\CompareHandler::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 190 of file CompareHandler.php.
The documentation for this class was generated from the following file:
- includes/Rest/Handler/CompareHandler.php
