MediaWiki\Rest\SimpleHandler Class Reference
Inherits MediaWiki\Rest\Handler.
Inherited by MediaWiki\Rest\Handler\LanguageLinksHandler, MediaWiki\Rest\Handler\MediaFileHandler, MediaWiki\Rest\Handler\MediaLinksHandler, MediaWiki\Rest\Handler\ModuleSpecHandler, MediaWiki\Rest\Handler\PageHTMLHandler, MediaWiki\Rest\Handler\PageHistoryCountHandler, MediaWiki\Rest\Handler\PageHistoryHandler, MediaWiki\Rest\Handler\PageLintHandler, MediaWiki\Rest\Handler\PageSourceHandler, MediaWiki\Rest\Handler\RevisionHTMLHandler, MediaWiki\Rest\Handler\RevisionLintHandler, and MediaWiki\Rest\Handler\RevisionSourceHandler.
Collaboration diagram for MediaWiki\Rest\SimpleHandler:
Public Member Functions | |
| 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.
| |
 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. | |
| applyDeprecationHeader (ResponseInterface $response) | |
| Apply Deprecation header per RFC 9745. | |
| 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. | |
| getParamSettings () | |
| Fetch ParamValidator settings for parameters. | |
| 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, array $openApiSpec=[]) | |
| 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. | |
| needsWriteAccess () | |
| Indicates whether this route requires write access to the wiki. | |
| 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 | OPENAPI_DESCRIPTION_KEY = 'description' |
| 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. | |
| generateResponseSpec (string $method) | |
| Returns an OpenAPI Responses Object specification structure as an associative array. | |
| getConditionalHeaderUtil () | |
| Get a ConditionalHeaderUtil object. | |
| getDeprecatedDate () | |
| Returns the timestamp at which this was or will be deprecated, or null if none. | |
| 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. | |
| getResponseBodySchemaFileName (string $method) | |
| Returns the path and name of a JSON file containing an OpenAPI Schema Object specification structure. | |
| getRouter () | |
| getRouteUrl ( $pathParams=[], $queryParams=[]) | |
| Get the URL of this handler's endpoint. | |
| hasRepresentation () | |
| The subclass should override this to indicate whether the resource exists. | |
| isDeprecated () | |
| Indicates whether this is deprecated. | |
| 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. | |
Detailed Description
Definition at line 17 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
- Returns
- mixed
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 19 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:
- includes/Rest/SimpleHandler.php
