MediaWiki  master
MediaWiki\Rest\Handler\CreationHandler Class Reference

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

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

Public Member Functions

 getBodyValidator ( $contentType)
 Fetch the BodyValidator.Stable for overriding
Parameters
string$contentTypeContent type of the request.
Returns
BodyValidator
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)
 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...
 
 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

 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...
 
 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\EditHandler
 getActionModuleToken ()
 Determines the CSRF token to be passed to the action module. 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 for overriding
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
 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...
 

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 creation (main slot only)

Definition at line 16 of file CreationHandler.php.

Member Function Documentation

◆ getActionModuleParameters()

MediaWiki\Rest\Handler\CreationHandler::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 69 of file CreationHandler.php.

References $title, MediaWiki\Rest\Handler\EditHandler\getActionModuleToken(), MediaWiki\Rest\Handler\CreationHandler\getTitleParameter(), and MediaWiki\Rest\Handler\getValidatedBody().

◆ getBodyValidator()

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

Fetch the BodyValidator.Stable for overriding

Parameters
string$contentTypeContent type of the request.
Returns
BodyValidator

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 28 of file CreationHandler.php.

◆ getTitleParameter()

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

◆ mapActionModuleResponse()

MediaWiki\Rest\Handler\CreationHandler::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 for overriding

Parameters
WebResponse$actionModuleResponse
array$actionModuleResult
Response$response

Reimplemented from MediaWiki\Rest\Handler\EditHandler.

Definition at line 100 of file CreationHandler.php.

References $title, MediaWiki\Rest\Handler\getRouter(), MediaWiki\Rest\Handler\CreationHandler\getTitleParameter(), and MediaWiki\Rest\Response\setHeader().


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