MediaWiki REL1_39
MediaWiki\Rest\SimpleHandler Class Reference
Inheritance diagram for MediaWiki\Rest\SimpleHandler:
Collaboration diagram for MediaWiki\Rest\SimpleHandler:

Public Member Functions

 execute ()
 Execute the handler.
- Public Member Functions inherited from MediaWiki\Rest\Handler
 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.
 getParamSettings ()
 Fetch ParamValidator settings for parameters.
 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.
 needsWriteAccess ()
 Indicates whether this route requires write access.
 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 PARAM_SOURCE = 'rest-param-source'
 (string) ParamValidator constant to specify the source of the parameter.
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 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.
 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 15 of file SimpleHandler.php.

Member Function Documentation

◆ execute()

MediaWiki\Rest\SimpleHandler::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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 16 of file SimpleHandler.php.

References $source, MediaWiki\Rest\Handler\getParamSettings(), MediaWiki\Rest\Handler\getRequest(), MediaWiki\Rest\Handler\getValidatedParams(), and MediaWiki\Rest\Handler\PARAM_SOURCE.

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