MediaWiki  master
MediaWiki\Rest\Handler\UpdateHandler Class Reference

Core REST API endpoint that handles page updates (main slot only) More...

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

Public Member Functions

 getBodyValidator ( $contentType)
 Fetch the BodyValidator.
Stability: stable
to override
Parameters
string$contentTypeContent type of the request.
Returns
BodyValidator
More...
 
 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 validating parameters inside an application/x-www-form-urlencoded or multipart/form-data POST body (i.e. parameters which would be present in PHP's $_POST array). For validating other kinds of request bodies, override getBodyValidator().
Stability: stable
to override
Returns
array[] Associative array mapping parameter names to ParamValidator settings arrays
More...
 
 setJsonDiffFunction (callable $jsonDiffFunction)
 Sets the function to use for JSON diffs, for testing. More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler\EditHandler
 __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)
 Apply verifier headers to the response, per RFC 7231 ยง7.2. More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 checkSession ()
 Check the session (and session provider) More...
 
 getAuthority ()
 Get the current acting authority. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getSession ()
 Get the Session. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 requireSafeAgainstCsrf ()
 Indicates whether this route can be accessed only by session providers safe vs csrf. 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.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.
More...
 
 getTitleParameter ()
 Returns the requested title.
Returns
string
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.
Stability: 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\EditHandler
 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...
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler\ActionModuleBasedHandler
 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 state of the requested resource. 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 of the requested resource. 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...
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called. More...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

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...
 
- Protected Attributes inherited from MediaWiki\Rest\Handler\EditHandler
Config $config
 
IContentHandlerFactory $contentHandlerFactory
 
RevisionLookup $revisionLookup
 
TitleFormatter $titleFormatter
 
TitleParser $titleParser
 

Detailed Description

Core REST API endpoint that handles page updates (main slot only)

Definition at line 20 of file UpdateHandler.php.

Member Function Documentation

◆ getActionModuleParameters()

MediaWiki\Rest\Handler\UpdateHandler::getActionModuleParameters ( )
protected

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

Definition at line 94 of file UpdateHandler.php.

References $title, MediaWiki\Rest\Handler\UpdateHandler\getTitleParameter(), MediaWiki\Rest\Handler\ActionModuleBasedHandler\getUser(), and MediaWiki\Rest\Handler\getValidatedBody().

◆ getBodyValidator()

MediaWiki\Rest\Handler\UpdateHandler::getBodyValidator (   $contentType)

Fetch the BodyValidator.

Stability: stable
to override
Parameters
string$contentTypeContent type of the request.
Returns
BodyValidator

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 59 of file UpdateHandler.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_REQUIRED, and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.

◆ getParamSettings()

MediaWiki\Rest\Handler\UpdateHandler::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 validating parameters inside an application/x-www-form-urlencoded or multipart/form-data POST body (i.e. parameters which would be present in PHP's $_POST array). For validating other kinds of request bodies, override getBodyValidator().

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 46 of file UpdateHandler.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_REQUIRED, and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.

◆ getTitleParameter()

MediaWiki\Rest\Handler\UpdateHandler::getTitleParameter ( )
protected

◆ mapActionModuleResult()

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

Definition at line 135 of file UpdateHandler.php.

References $title, and MediaWiki\Rest\Handler\getValidatedParams().

◆ setJsonDiffFunction()

MediaWiki\Rest\Handler\UpdateHandler::setJsonDiffFunction ( callable  $jsonDiffFunction)

Sets the function to use for JSON diffs, for testing.

Parameters
callable$jsonDiffFunction

Definition at line 39 of file UpdateHandler.php.

◆ throwHttpExceptionForActionModuleError()

MediaWiki\Rest\Handler\UpdateHandler::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.

Stability: 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\EditHandler.

Definition at line 154 of file UpdateHandler.php.

References $title, IApiMessage\getApiCode(), MediaWiki\Rest\Handler\UpdateHandler\getTitleParameter(), and MediaWiki\Rest\Handler\ActionModuleBasedHandler\makeMessageValue().


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