Core REST API endpoint that handles page creation (main slot only) More...
Inherits MediaWiki\Rest\Handler\EditHandler.
Public Member Functions | |
| 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().For "query" and "body" 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.
| |
 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, including path variables. | |
| 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(). | |
| getValidatedBody () | |
| Fetch the validated body. | |
| getValidatedParams () | |
| Fetch the validated parameters. | |
| init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session) | |
| Initialise with dependencies from the Router. | |
| initContext (Router $router, array $routeConfig) | |
| Injects information about the handler's context in the Router. | |
| 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().
| |||||||||
| 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. | |||||||||
| Protected Member Functions inherited from MediaWiki\Rest\Handler\EditHandler | |||||||||
| mapActionModuleResult (array $data) | |||||||||
Maps an action API result to a REST API result.
| |||||||||
| 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.
| |||||||||
| 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. | |||||||||
| 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. | |||||||||
| getRequestSpec () | |||||||||
| Returns an OpenAPI Request Body Object specification structure as an associative array. | |||||||||
| getResponseBodySchema () | |||||||||
| Returns an OpenAPI Schema Object specification structure as an associative array. | |||||||||
| getResponseSpec () | |||||||||
| Returns an OpenAPI Responses 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 init() is called to inject the 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 creation (main slot only)
Definition at line 14 of file CreationHandler.php.
Member Function Documentation
◆ 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 63 of file CreationHandler.php.
References $params, MediaWiki\Rest\Handler\CreationHandler\getTitleParameter(), MediaWiki\Rest\getToken(), MediaWiki\Rest\Handler\ActionModuleBasedHandler\getUser(), MediaWiki\Rest\Handler\getValidatedBody(), and MediaWiki\Rest\needsToken().
◆ getParamSettings()
| MediaWiki\Rest\Handler\CreationHandler::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().For "query" and "body" 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
- Returns
- array
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 29 of file CreationHandler.php.
References MediaWiki\Rest\getTokenParamDefinition().
◆ getTitleParameter()
|
protected |
Returns the requested title.
- Returns
- string
Reimplemented from MediaWiki\Rest\Handler\EditHandler.
Definition at line 19 of file CreationHandler.php.
References MediaWiki\Rest\Handler\getValidatedBody().
Referenced by MediaWiki\Rest\Handler\CreationHandler\getActionModuleParameters().
◆ mapActionModuleResponse()
|
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\EditHandler.
Definition at line 97 of file CreationHandler.php.
References MediaWiki\Rest\Handler\getRouter(), MediaWiki\Rest\Response\setHeader(), and MediaWiki\Rest\Handler\urlEncodeTitle().
The documentation for this class was generated from the following file:
- includes/Rest/Handler/CreationHandler.php
