Page MenuHomeWickedGov Phorge
Files F6037764

TransformWikitextToHtmlRevisionHandler.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

TransformWikitextToHtmlRevisionHandler.php
View Options

<?php
namespace MediaWiki\Rest\Handler;
use MediaWiki\Rest\Handler;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
/**
* Handler for transforming content given in the request.
*
* This class primarily deals with parameter validation and OpenAPI spec generation.
* Everything else is handled by the base class.
*
* TODO: reconsider the ParsoidHandler => TransformHandler hierarchy. Consider consolidating
* classes and moving more validation into functions like getParamSettings(),
* getBodyParamSettings(), etc.
*
* @unstable Pending consolidation of the Parsoid extension with core code.
*/
class TransformWikitextToHtmlRevisionHandler extends TransformHandler {
/** @inheritDoc */
public function getParamSettings() {
return [
'title' => [
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-transform-title' ),
],
'revision' => [
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-transform-revision' ),
],
];
}
/**
* The parent TransformHandler class accepts a variety of body parameters in different
* situations, some of which can accept values in multiple types and therefore cannot
* be described in getBodyParamSettings(). See TransformHandler::execute(), and notice
* that both "wikitext" and "html" can be either a string or an object.
*
* We therefore define a request body schema directly rather than the more common approach of
* generating it from definitions in getBodyParamSettings().
*/
protected function getRequestBodySchema( string $mediaType ): array {
return [
'oneOf' => [
[
'type' => 'object',
'properties' => [
'wikitext' => [
'type' => 'string',
]
]
],
[
'type' => 'object',
'properties' => [
'wikitext' => [
'type' => 'object',
'properties' => [
'headers' => [
'type' => 'object',
],
'body' => [
'type' => 'string',
]
]
]
]
]
],
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Oct 4 2026, 19:50 (5 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
5b/f1/74aac2d3459f65f83f97fe1e3227
Default Alt Text
TransformWikitextToHtmlRevisionHandler.php (2 KB)

Event Timeline