Public Member Functions | |
| __construct (RevisionLookup $revisionLookup, Parser $parser) | |
| execute () | |
| Execute the handler. More... | |
| getParamSettings () | |
| Fetch ParamValidator settings for parameters. More... | |
 Public Member Functions inherited from MediaWiki\Rest\Handler | |
| applyCacheControl (ResponseInterface $response) | |
| Apply cache control to enforce privacy. More... | |
| applyConditionalResponseHeaders (ResponseInterface $response) | |
| Apply verifier headers to the response, per RFC 7231 ยง7.2. More... | |
| checkPreconditions () | |
| Check the conditional request headers and generate a response if appropriate. More... | |
| checkSession () | |
| Check the session (and session provider) More... | |
| getAuthority () | |
| Get the current acting authority. More... | |
| getBodyValidator ( $contentType) | |
| Fetch the BodyValidator. More... | |
| getConfig () | |
| Get the configuration array for the current route. More... | |
| getPath () | |
| Returns the path this handler is bound to, including path variables. More... | |
| getRequest () | |
| Get the current request. More... | |
| getResponseFactory () | |
| Get the ResponseFactory which can be used to generate Response objects. More... | |
| getSession () | |
| Get the Session. 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, Session $session) | |
| Initialise with dependencies from the Router. More... | |
| needsReadAccess () | |
| Indicates whether this route requires read rights. More... | |
| needsWriteAccess () | |
| Indicates whether this route requires write access. More... | |
| requireSafeAgainstCsrf () | |
| Indicates whether this route can be accessed only by session providers safe vs csrf. More... | |
| validate (Validator $restValidator) | |
| Validate the request parameters/attributes and body. More... | |
Additional Inherited Members | |
| Public Attributes inherited from MediaWiki\Rest\Handler | |
| trait | PageRedirectHandlerTrait |
| Important: this trait should be used for implementations of the Handler class. More... | |
| const | PARAM_SOURCE = 'rest-param-source' |
| (string) ParamValidator constant to specify the source of the parameter. More... | |
| Protected Member Functions inherited from MediaWiki\Rest\Handler | |
| getConditionalHeaderUtil () | |
| Get a ConditionalHeaderUtil object. More... | |
| getETag () | |
| The subclass should override this to provide an ETag for the current state of the requested resource. More... | |
| getHookContainer () | |
| Get a HookContainer, for running extension hooks or for hook metadata. More... | |
| getHookRunner () | |
| Get a HookRunner for running core hooks. More... | |
| getLastModified () | |
| The subclass should override this to provide the maximum last modified timestamp of the requested resource. 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... | |
Detailed Description
Definition at line 18 of file CompareHandler.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Rest\Handler\CompareHandler::__construct | ( | RevisionLookup | $revisionLookup, |
| Parser | $parser | ||
| ) |
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 187 of file CompareHandler.php.
References Wikimedia\ParamValidator\ParamValidator\PARAM_REQUIRED, MediaWiki\Rest\Handler\PARAM_SOURCE, and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.
The documentation for this class was generated from the following file:
- includes/Rest/Handler/CompareHandler.php
