MediaWiki  master
MediaWiki\Rest\Handler\EditHandler Class Reference

Base class for REST API handlers that perform page edits (main slot only). More...

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

Public Member Functions

 __construct (Config $config, IContentHandlerFactory $contentHandlerFactory, TitleParser $titleParser, TitleFormatter $titleFormatter, RevisionLookup $revisionLookup)
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler\ActionModuleBasedHandler
 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...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Protected Member Functions

 getActionModuleToken ()
 Determines the CSRF token to be passed to the action module. More...
 
 getTitleParameter ()
 Returns the requested title. 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.
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().
More...
 
 throwHttpExceptionForActionModuleError (IApiMessage $msg, $statusCode=400)
 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.
More...
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler\ActionModuleBasedHandler
 getActionModuleParameters ()
 Maps a REST API request to an action API request. More...
 
 getSession ()
 
 getUser ()
 
 makeMessageValue (IApiMessage $msg)
 Constructs a MessageValue from an IApiMessage. 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...
 

Protected Attributes

Config $config
 
IContentHandlerFactory $contentHandlerFactory
 
RevisionLookup $revisionLookup
 
TitleFormatter $titleFormatter
 
TitleParser $titleParser
 

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 API handlers that perform page edits (main slot only).

Definition at line 21 of file EditHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\EditHandler::__construct ( Config  $config,
IContentHandlerFactory  $contentHandlerFactory,
TitleParser  $titleParser,
TitleFormatter  $titleFormatter,
RevisionLookup  $revisionLookup 
)

Member Function Documentation

◆ getActionModuleToken()

MediaWiki\Rest\Handler\EditHandler::getActionModuleToken ( )
protected

Determines the CSRF token to be passed to the action module.

This could be taken from a request parameter, or a known-good token can be computed, if the request has been determined to be safe against CSRF attacks, e.g. when an OAuth Authentication header is present.

Most return an empty string if the request isn't known to be safe and no token was supplied by the client.

Returns
string

Definition at line 166 of file EditHandler.php.

References MediaWiki\Rest\Handler\ActionModuleBasedHandler\getSession(), MediaWiki\Rest\Handler\ActionModuleBasedHandler\getUser(), and MediaWiki\Rest\Handler\getValidatedBody().

Referenced by MediaWiki\Rest\Handler\CreationHandler\getActionModuleParameters(), and MediaWiki\Rest\Handler\UpdateHandler\getActionModuleParameters().

◆ getTitleParameter()

MediaWiki\Rest\Handler\EditHandler::getTitleParameter ( )
abstractprotected

Returns the requested title.

Returns
string

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

◆ mapActionModuleResponse()

MediaWiki\Rest\Handler\EditHandler::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 from MediaWiki\Rest\Handler\ActionModuleBasedHandler.

Reimplemented in MediaWiki\Rest\Handler\CreationHandler.

Definition at line 184 of file EditHandler.php.

References MediaWiki\Rest\Response\setStatus().

◆ mapActionModuleResult()

MediaWiki\Rest\Handler\EditHandler::mapActionModuleResult ( array  $data)
protected

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 from MediaWiki\Rest\Handler\ActionModuleBasedHandler.

Definition at line 81 of file EditHandler.php.

References $content, and $title.

◆ needsWriteAccess()

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

Indicates whether this route requires write access.

The handler should override this if the route does not need to write to the database.

This should return true for routes that may require synchronous database writes. Modules that do not need such writes should also not rely on master database access, since only read queries are needed and each master DB is a single point of failure.

Stable to override

Returns
bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 67 of file EditHandler.php.

◆ throwHttpExceptionForActionModuleError()

MediaWiki\Rest\Handler\EditHandler::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 from MediaWiki\Rest\Handler\ActionModuleBasedHandler.

Reimplemented in MediaWiki\Rest\Handler\UpdateHandler.

Definition at line 123 of file EditHandler.php.

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

Member Data Documentation

◆ $config

Config MediaWiki\Rest\Handler\EditHandler::$config
protected

Definition at line 24 of file EditHandler.php.

Referenced by MediaWiki\Rest\Handler\EditHandler\__construct().

◆ $contentHandlerFactory

IContentHandlerFactory MediaWiki\Rest\Handler\EditHandler::$contentHandlerFactory
protected

Definition at line 29 of file EditHandler.php.

Referenced by MediaWiki\Rest\Handler\EditHandler\__construct().

◆ $revisionLookup

RevisionLookup MediaWiki\Rest\Handler\EditHandler::$revisionLookup
protected

Definition at line 44 of file EditHandler.php.

Referenced by MediaWiki\Rest\Handler\EditHandler\__construct().

◆ $titleFormatter

TitleFormatter MediaWiki\Rest\Handler\EditHandler::$titleFormatter
protected

Definition at line 39 of file EditHandler.php.

Referenced by MediaWiki\Rest\Handler\EditHandler\__construct().

◆ $titleParser

TitleParser MediaWiki\Rest\Handler\EditHandler::$titleParser
protected

Definition at line 34 of file EditHandler.php.

Referenced by MediaWiki\Rest\Handler\EditHandler\__construct().


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