TransformHtmlToWikitextHandler.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

TransformHtmlToWikitextHandler.php
View Options

	<?php

	namespace MediaWiki\Rest\Handler;

	/**
	* 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 TransformHtmlToWikitextHandler extends TransformHandler {

	/** @inheritDoc */
	public function getParamSettings() {
	return [];
	}

	/**
	* 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' => [
	'html' => [
	'type' => 'string',
	]
	]
	],
	[
	'type' => 'object',
	'properties' => [
	'html' => [
	'type' => 'object',
	'properties' => [
	'headers' => [
	'type' => 'object',
	],
	'body' => [
	'type' => 'string',
	]
	]
	]
	]
	]
	],
	];
	}
	}