MediaWiki master
MediaWiki\Rest\Handler\UpdateHandler Class Reference

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

Inherits MediaWiki\Rest\Handler\EditHandler.

Collaboration diagram for MediaWiki\Rest\Handler\UpdateHandler:

Public Member Functions

 getBodyParamSettings ()
 Fetch ParamValidator settings for body fields.Parameters defined by this method are used to validate the request body. The parameter values will become available through getValidatedBody().Subclasses may override this method to specify what fields they support in the request body. All parameter settings returned by this method must have self::PARAM_SOURCE set to 'body'.
Returns
array[]

 
 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 the request body as well, by setting self::PARAM_SOURCE to "post". Note that the values of "post" parameters will be accessible through getValidatedParams(). "post" parameters are used with form data (application/x-www-form-urlencoded or multipart/form-data).For "query" parameters, a PARAM_REQUIRED setting of "false" means the caller does not have to supply the parameter. For "path" parameters, the path matcher will always require the caller to supply all path parameters for a route, regardless of the PARAM_REQUIRED setting. However, "path" parameters may be specified in getParamSettings() as non-required to indicate that the handler services multiple routes, some of which may not supply the parameter.
Stability: stable
to override
Returns
array[] Associative array mapping parameter names to ParamValidator settings arrays

 
 setJsonDiffFunction (callable $jsonDiffFunction)
 Sets the function to use for JSON diffs, for testing.
 
- 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.
 
- Public Member Functions inherited from MediaWiki\Rest\Handler\ActionModuleBasedHandler
 execute ()
 Main execution method, implemented to delegate execution to ApiMain.
 
 getApiMain ()
 
 overrideActionModule (string $name, string $group, ApiBase $module)
 Overrides an action API module.
 
 setApiMain (ApiMain $apiMain)
 Set main action API entry point for testing.
 
- 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.
 
 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.
 
 getOpenApiSpec (string $method)
 Returns an OpenAPI Operation Object specification structure as an associative array.
 
 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)
 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.
 
 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.
 

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.

 
 getTitleParameter ()
 Returns the requested title.
Returns
string

 
 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().

 
 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.

 
- 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.
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler\ActionModuleBasedHandler
 getUser ()
 
 makeMessageValue (IApiMessage $msg)
 Constructs a MessageValue from an IApiMessage.
 
- 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 ()
 Returns an OpenAPI Responses Object specification structure as an associative array.
 
 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.
 
 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 ()
 Returns an OpenAPI Schema Object specification structure as an associative array.
 
 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 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.
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Rest\Handler
const KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES
 
const PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION
 
const PARAM_SOURCE = Validator::PARAM_SOURCE
 
- 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 19 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 $params, MediaWiki\Rest\getToken(), getUser(), MediaWiki\Rest\Handler\getValidatedBody(), and MediaWiki\Rest\needsToken().

◆ getBodyParamSettings()

MediaWiki\Rest\Handler\UpdateHandler::getBodyParamSettings ( )

Fetch ParamValidator settings for body fields.Parameters defined by this method are used to validate the request body. The parameter values will become available through getValidatedBody().Subclasses may override this method to specify what fields they support in the request body. All parameter settings returned by this method must have self::PARAM_SOURCE set to 'body'.

Returns
array[]

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 65 of file UpdateHandler.php.

◆ 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 the request body as well, by setting self::PARAM_SOURCE to "post". Note that the values of "post" parameters will be accessible through getValidatedParams(). "post" parameters are used with form data (application/x-www-form-urlencoded or multipart/form-data).For "query" parameters, a PARAM_REQUIRED setting of "false" means the caller does not have to supply the parameter. For "path" parameters, the path matcher will always require the caller to supply all path parameters for a route, regardless of the PARAM_REQUIRED setting. However, "path" parameters may be specified in getParamSettings() as non-required to indicate that the handler services multiple routes, some of which may not supply the parameter.

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 52 of file UpdateHandler.php.

◆ getTitleParameter()

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

Returns the requested title.

Returns
string

Reimplemented from MediaWiki\Rest\Handler\EditHandler.

Definition at line 36 of file UpdateHandler.php.

References MediaWiki\Rest\Handler\getValidatedParams().

◆ 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 138 of file UpdateHandler.php.

References 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 45 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 157 of file UpdateHandler.php.

References IApiMessage\getApiCode().


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