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

Inherits MediaWiki\Rest\Handler\ActionModuleBasedHandler.

Inherited by MediaWiki\Rest\Handler\CreationHandler, and MediaWiki\Rest\Handler\UpdateHandler.

Collaboration diagram for MediaWiki\Rest\Handler\EditHandler:

[legend]

Public Member Functions
	__construct (Config $config, IContentHandlerFactory $contentHandlerFactory, TitleParser $titleParser, TitleFormatter $titleFormatter, RevisionLookup $revisionLookup)

	needsWriteAccess ()
	Indicates whether this route requires write access to the wiki.

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.

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

getTitleParameter ()

Returns the requested title.

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.

mapActionModuleResult (array $data)

Maps an action API result to a REST API result.

Parameters

array $data Data 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	$msg	A message object representing an error in an action module, typically from calling getStatusValue()->getMessages( 'error' ) on an ApiUsageException.
int	$statusCode	The HTTP status indicated by the original exception

Exceptions

HttpException always.

Protected Member Functions inherited from MediaWiki\Rest\Handler\ActionModuleBasedHandler

getActionModuleParameters ()

Maps a REST API request to an action API request.

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.

Protected Attributes
Config	$config

IContentHandlerFactory	$contentHandlerFactory

RevisionLookup	$revisionLookup

TitleFormatter	$titleFormatter

TitleParser	$titleParser

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

Detailed Description

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

Definition at line 23 of file EditHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 32 of file EditHandler.php.

References MediaWiki\Rest\Handler\EditHandler\$config, MediaWiki\Rest\Handler\EditHandler\$contentHandlerFactory, MediaWiki\Rest\Handler\EditHandler\$revisionLookup, MediaWiki\Rest\Handler\EditHandler\$titleFormatter, and MediaWiki\Rest\Handler\EditHandler\$titleParser.

Member Function Documentation

◆ getTitleParameter()

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

abstractprotected

Returns the requested title.

Returns: string

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

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

Stability: 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 136 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 $data Data 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.

Reimplemented in MediaWiki\Rest\Handler\UpdateHandler.

Definition at line 60 of file EditHandler.php.

References MediaWiki\MainConfigNames\RightsText, and MediaWiki\MainConfigNames\RightsUrl.

◆ needsWriteAccess()

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

Indicates whether this route requires write access to the wiki.

Handlers may override this method to return false if and only if the operation they implement is "safe" per RFC 7231 section 4.2.1. A handler's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

Handlers for GET, HEAD, OPTIONS, and TRACE requests should each implement a "safe" operation. Handlers of PUT and DELETE requests should each implement a non-"safe" operation. Note that handlers of POST requests can implement a "safe" operation, particularly in the case where large input parameters are required.

The information provided by this method is used to perform basic authorization checks and to determine whether cross-origin requests are safe.

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 46 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.

Stability: stable: to override

Parameters

IApiMessage	$msg	A message object representing an error in an action module, typically from calling getStatusValue()->getMessages( 'error' ) on an ApiUsageException.
int	$statusCode	The HTTP status indicated by the original exception

Exceptions

HttpException always.

Reimplemented from MediaWiki\Rest\Handler\ActionModuleBasedHandler.

Reimplemented in MediaWiki\Rest\Handler\UpdateHandler.

Definition at line 105 of file EditHandler.php.

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