MediaWiki  master
MediaWiki\Rest\Handler\ActionModuleBasedHandler Class Reference

Base class for REST handlers that are implemented by mapping to an existing ApiModule. More...

Inheritance diagram for MediaWiki\Rest\Handler\ActionModuleBasedHandler:
Collaboration diagram for MediaWiki\Rest\Handler\ActionModuleBasedHandler:

Public Member Functions

 execute ()
 Main execution method, implemented to delegate execution to ApiMain. More...
 
 getApiMain ()
 
 overrideActionModule (string $name, string $group, ApiBase $module)
 Overrides an action API module. More...
 
 setApiMain (ApiMain $apiMain)
 Set main action API entry point for testing. More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyConditionalResponseHeaders (ResponseInterface $response)
 Modify the response, adding Last-Modified and ETag headers as indicated the values previously returned by ETag and getLastModified(). More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, ResponseFactory $responseFactory, HookContainer $hookContainer)
 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...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Protected Member Functions

 getActionModuleParameters ()
 Maps a REST API request to an action API request. More...
 
 getSession ()
 
 getUser ()
 
 makeMessageValue (IApiMessage $msg)
 Constructs a MessageValue from an IApiMessage. More...
 
 mapActionModuleResponse (WebResponse $actionModuleResponse, array $actionModuleResult, Response $response)
 Transfers relevant information, such as header values, from the WebResponse constructed by the action API call to a REST Response object. More...
 
 mapActionModuleResult (array $data)
 Maps an action API result to a REST API result. More...
 
 throwHttpExceptionForActionModuleError (IApiMessage $msg, $statusCode=400)
 Throws a HttpException for a given IApiMessage that represents an error. 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 request. 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 for the current request. 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...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

Private Member Functions

 makeMessageParam ( $param)
 

Private Attributes

ApiMain null $apiMain = null
 
Session null $session = null
 

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. More...
 

Detailed Description

Base class for REST handlers that are implemented by mapping to an existing ApiModule.

Stable to extend

Definition at line 29 of file ActionModuleBasedHandler.php.

Member Function Documentation

◆ execute()

◆ getActionModuleParameters()

MediaWiki\Rest\Handler\ActionModuleBasedHandler::getActionModuleParameters ( )
abstractprotected

Maps a REST API request to an action API request.

Implementations typically use information returned by $this->getValidatedBody() and $this->getValidatedParams() to construct the return value.

The return value of this method controls which action module is called by execute().

Returns
array Emulated request parameters to be passed to the ApiModule.

Reimplemented in MediaWiki\Rest\Handler\UpdateHandler, and MediaWiki\Rest\Handler\CreationHandler.

Referenced by MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute().

◆ getApiMain()

◆ getSession()

MediaWiki\Rest\Handler\ActionModuleBasedHandler::getSession ( )
protected

◆ getUser()

MediaWiki\Rest\Handler\ActionModuleBasedHandler::getUser ( )
protected

◆ makeMessageParam()

MediaWiki\Rest\Handler\ActionModuleBasedHandler::makeMessageParam (   $param)
private
Parameters
mixed$param
Returns
MessageParam

Definition at line 266 of file ActionModuleBasedHandler.php.

References $type.

Referenced by MediaWiki\Rest\Handler\ActionModuleBasedHandler\makeMessageValue().

◆ makeMessageValue()

◆ mapActionModuleResponse()

MediaWiki\Rest\Handler\ActionModuleBasedHandler::mapActionModuleResponse ( WebResponse  $actionModuleResponse,
array  $actionModuleResult,
Response  $response 
)
protected

Transfers relevant information, such as header values, from the WebResponse constructed by the action API call to a REST Response object.

Subclasses may override this to provide special case handling for header fields. For mapping the response body, override mapActionModuleResult() instead.

Subclasses overriding this method should call this method in the parent class, to preserve baseline behavior.

Stable to override

Parameters
WebResponse$actionModuleResponse
array$actionModuleResult
Response$response

Reimplemented in MediaWiki\Rest\Handler\EditHandler, and MediaWiki\Rest\Handler\CreationHandler.

Definition at line 202 of file ActionModuleBasedHandler.php.

Referenced by MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute().

◆ mapActionModuleResult()

MediaWiki\Rest\Handler\ActionModuleBasedHandler::mapActionModuleResult ( array  $data)
abstractprotected

Maps an action API result to a REST API result.

Parameters
array$dataData structure retrieved from the ApiResult returned by the ApiModule
Returns
mixed Data structure to be converted to JSON and wrapped in a REST Response. Will be processed by ResponseFactory::createFromReturnValue().

Reimplemented in MediaWiki\Rest\Handler\EditHandler.

Referenced by MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute().

◆ overrideActionModule()

MediaWiki\Rest\Handler\ActionModuleBasedHandler::overrideActionModule ( string  $name,
string  $group,
ApiBase  $module 
)

Overrides an action API module.

Used for testing.

Parameters
string$name
string$group
ApiBase$module

Definition at line 98 of file ActionModuleBasedHandler.php.

References MediaWiki\Rest\Handler\ActionModuleBasedHandler\getApiMain().

◆ setApiMain()

MediaWiki\Rest\Handler\ActionModuleBasedHandler::setApiMain ( ApiMain  $apiMain)

Set main action API entry point for testing.

Parameters
ApiMain$apiMain

Definition at line 61 of file ActionModuleBasedHandler.php.

References MediaWiki\Rest\Handler\ActionModuleBasedHandler\$apiMain.

◆ throwHttpExceptionForActionModuleError()

MediaWiki\Rest\Handler\ActionModuleBasedHandler::throwHttpExceptionForActionModuleError ( IApiMessage  $msg,
  $statusCode = 400 
)
protected

Throws a HttpException for a given IApiMessage that represents an error.

Never returns normally.

Subclasses may override this to provide mappings for specific error codes, typically based on $msg->getApiCode(). Subclasses overriding this method must always either throw an exception, or call this method in the parent class, which then throws an exception.

Stable to override

Parameters
IApiMessage$msgA message object representing an error in an action module, typically from calling getStatusValue()->getErrorsByType( 'error' ) on an ApiUsageException.
int$statusCodeThe HTTP status indicated by the original exception
Exceptions
HttpExceptionalways.

Reimplemented in MediaWiki\Rest\Handler\UpdateHandler, and MediaWiki\Rest\Handler\EditHandler.

Definition at line 228 of file ActionModuleBasedHandler.php.

References IApiMessage\getApiCode(), and MediaWiki\Rest\Handler\ActionModuleBasedHandler\makeMessageValue().

Referenced by MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute().

Member Data Documentation

◆ $apiMain

◆ $session

Session null MediaWiki\Rest\Handler\ActionModuleBasedHandler::$session = null
private

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