MediaWiki master
MediaWiki\Rest\Handler\CompareHandler Class Reference

Inherits MediaWiki\Rest\Handler.

Collaboration diagram for MediaWiki\Rest\Handler\CompareHandler:

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 to the wiki.Handlers may override this method to return false if and only if the operation they implement is "safe" per RFC 7231 section 4.2.1. A handler's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.Handlers for GET, HEAD, OPTIONS, and TRACE requests should each implement a "safe" operation. Handlers of PUT and DELETE requests should each implement a non-"safe" operation. Note that handlers of POST requests can implement a "safe" operation, particularly in the case where large input parameters are required.The information provided by this method is used to perform basic authorization checks and to determine whether cross-origin requests are safe.
Stability: stable
to override
Returns
bool

 
- 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, string $path, 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

 generateResponseSpec (string $method)
 Returns an OpenAPI Responses Object specification structure as an associative array.
 
 getResponseBodySchemaFileName (string $method)
 Returns the path and name of a JSON file containing an OpenAPI Schema Object specification structure.
 
- 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.
 
 getJsonLocalizer ()
 Get a JsonLocalizer object.
 
 getLastModified ()
 The subclass should override this to provide the maximum last modified timestamp of the requested resource.
 
 getModule ()
 Get the Module this handler belongs to.
 
 getRequestBodySchema (string $mediaType)
 Returns a content schema per the OpenAPI spec.
 
 getRequestSpec (string $method)
 Returns an OpenAPI Request Body Object specification structure as an associative array.
 
 getResponseBodySchema (string $method)
 Returns an OpenAPI Schema Object specification structure as an associative array.
 
 getRouter ()
 
 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 the init functions are called to inject 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 OPENAPI_DESCRIPTION_KEY = 'description'
 
const PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION
 
const PARAM_SOURCE = Validator::PARAM_SOURCE
 

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 28 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 36 of file CompareHandler.php.

References MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\getResponseFactory().

◆ generateResponseSpec()

MediaWiki\Rest\Handler\CompareHandler::generateResponseSpec ( string $method)
protected

Returns an OpenAPI Responses Object specification structure as an associative array.

See also
https://swagger.io/specification/#responses-object

By default, this will contain basic information response for status 200, 400, and 500. The getResponseBodySchema() method is used to determine the structure of the response for status 200.

Subclasses may override this to provide additional information about the structure of responses.

Parameters
string$methodThe HTTP method to produce a spec for ("get", "post", etc).
Stability: stable
to override
Returns
array

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 195 of file CompareHandler.php.

◆ 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 the request body as well, by setting self::PARAM_SOURCE to "post". Note that 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" 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.

Stability: stable
to override
Returns
array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 202 of file CompareHandler.php.

◆ getResponseBodySchemaFileName()

MediaWiki\Rest\Handler\CompareHandler::getResponseBodySchemaFileName ( string $method)
protected

Returns the path and name of a JSON file containing an OpenAPI Schema Object specification structure.

See also
https://swagger.io/specification/#schema-object

Returns null by default. Subclasses with a suitable JSON file should implement this method.

Parameters
string$methodThe HTTP method to produce a spec for ("get", "post", etc).
Stability: stable
to override
Since
1.43
Returns
?string

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 191 of file CompareHandler.php.

◆ needsWriteAccess()

MediaWiki\Rest\Handler\CompareHandler::needsWriteAccess ( )

Indicates whether this route requires write access to the wiki.Handlers may override this method to return false if and only if the operation they implement is "safe" per RFC 7231 section 4.2.1. A handler's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.Handlers for GET, HEAD, OPTIONS, and TRACE requests should each implement a "safe" operation. Handlers of PUT and DELETE requests should each implement a non-"safe" operation. Note that handlers of POST requests can implement a "safe" operation, particularly in the case where large input parameters are required.The information provided by this method is used to perform basic authorization checks and to determine whether cross-origin requests are safe.

Stability: stable
to override
Returns
bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 187 of file CompareHandler.php.


The documentation for this class was generated from the following file: