Core REST API endpoint that handles page updates (main slot only) More...
Public Member Functions | ||||
| getBodyValidator ( $contentType) | ||||
Fetch the BodyValidator.
| ||||
| 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().
| ||||
| 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 | ||||
| applyConditionalResponseHeaders (ResponseInterface $response) | ||||
| Modify the response, adding Last-Modified and ETag headers as indicated the values previously returned by ETag and getLastModified(). | ||||
| checkPreconditions () | ||||
| Check the conditional request headers and generate a response if appropriate. | ||||
| getAuthority () | ||||
| Get the current acting authority. | ||||
| getConfig () | ||||
| Get the configuration array for the current route. | ||||
| getRequest () | ||||
| Get the current request. | ||||
| getResponseFactory () | ||||
| Get the ResponseFactory which can be used to generate Response objects. | ||||
| getValidatedBody () | ||||
| Fetch the validated body. | ||||
| getValidatedParams () | ||||
| Fetch the validated parameters. | ||||
| init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer) | ||||
| Initialise with dependencies from the Router. | ||||
| needsReadAccess () | ||||
| Indicates whether this route requires read rights. | ||||
| 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.
| |||||||||
| 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\EditHandler | |||||||||
| getActionModuleToken () | |||||||||
| Determines the CSRF token to be passed to the action module. | |||||||||
| 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 | |||||||||
| getSession () | |||||||||
| getUser () | |||||||||
| makeMessageValue (IApiMessage $msg) | |||||||||
| Constructs a MessageValue from an IApiMessage. | |||||||||
| Protected Member Functions inherited from MediaWiki\Rest\Handler | |||||||||
| getConditionalHeaderUtil () | |||||||||
| Get a ConditionalHeaderUtil object. | |||||||||
| getETag () | |||||||||
| The subclass should override this to provide an ETag for the current request. | |||||||||
| 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 for the current request. | |||||||||
| 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. | |||||||||
Private Member Functions | |
| getConflictData () | |
| Returns an associative array to be used in the response in the event of edit conflicts. | |
| getDiff (TextContent $from, TextContent $to) | |
| Returns a text diff encoded as an array, to be included in the response data. | |
Private Attributes | |
| callable | $jsonDiffFunction |
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. | |
| 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()
|
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 100 of file UpdateHandler.php.
References $title, MediaWiki\Rest\Handler\EditHandler\getActionModuleToken(), MediaWiki\Rest\Handler\UpdateHandler\getTitleParameter(), and MediaWiki\Rest\Handler\getValidatedBody().
◆ getBodyValidator()
| MediaWiki\Rest\Handler\UpdateHandler::getBodyValidator | ( | $contentType | ) |
Fetch the BodyValidator.
- Stability: stable
- to override
- Parameters
-
string $contentType Content type of the request.
- Returns
- BodyValidator
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 59 of file UpdateHandler.php.
◆ getConflictData()
|
private |
Returns an associative array to be used in the response in the event of edit conflicts.
The resulting array contains the following keys:
- base: revision ID of the base revision
- current: revision ID of the current revision (new base after resolving the conflict)
- local: the difference between the content submitted and the base revision
- remote: the difference between the latest revision of the page and the base revision
If the differences cannot be determined, an empty array is returned.
- Returns
- array
Definition at line 193 of file UpdateHandler.php.
References $title, MediaWiki\Rest\Handler\getAuthority(), MediaWiki\Rest\Handler\UpdateHandler\getDiff(), MediaWiki\Rest\Handler\getValidatedBody(), and MediaWiki\Rest\Handler\getValidatedParams().
Referenced by MediaWiki\Rest\Handler\UpdateHandler\throwHttpExceptionForActionModuleError().
◆ getDiff()
|
private |
Returns a text diff encoded as an array, to be included in the response data.
- Parameters
-
TextContent $from TextContent $to
- Returns
- array|null
Definition at line 254 of file UpdateHandler.php.
References MediaWiki\Rest\Handler\UpdateHandler\$jsonDiffFunction, and TextContent\getText().
Referenced by MediaWiki\Rest\Handler\UpdateHandler\getConflictData().
◆ 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.
◆ getTitleParameter()
|
protected |
Returns the requested title.
- Returns
- string
Reimplemented from MediaWiki\Rest\Handler\EditHandler.
Definition at line 30 of file UpdateHandler.php.
References MediaWiki\Rest\Handler\getValidatedParams().
Referenced by MediaWiki\Rest\Handler\UpdateHandler\getActionModuleParameters(), and MediaWiki\Rest\Handler\UpdateHandler\throwHttpExceptionForActionModuleError().
◆ mapActionModuleResult()
|
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\EditHandler.
Definition at line 141 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.
References MediaWiki\Rest\Handler\UpdateHandler\$jsonDiffFunction.
◆ throwHttpExceptionForActionModuleError()
|
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()->getErrorsByType( 'error' ) on an ApiUsageException. int $statusCode The HTTP status indicated by the original exception
- Exceptions
-
HttpException always.
Reimplemented from MediaWiki\Rest\Handler\EditHandler.
Definition at line 160 of file UpdateHandler.php.
References $title, IApiMessage\getApiCode(), MediaWiki\Rest\Handler\UpdateHandler\getConflictData(), MediaWiki\Rest\Handler\UpdateHandler\getTitleParameter(), and MediaWiki\Rest\Handler\ActionModuleBasedHandler\makeMessageValue().
Member Data Documentation
◆ $jsonDiffFunction
|
private |
Definition at line 25 of file UpdateHandler.php.
Referenced by MediaWiki\Rest\Handler\UpdateHandler\getDiff(), and MediaWiki\Rest\Handler\UpdateHandler\setJsonDiffFunction().
The documentation for this class was generated from the following file:
- includes/Rest/Handler/UpdateHandler.php
