MediaWiki master
MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper Class Reference

REST helper for converting HTML to page content source (e.g. More...

Public Member Functions

 __construct (StatsFactory $statsFactory, HtmlTransformFactory $htmlTransformFactory, ParsoidOutputStash $parsoidOutputStash, ParserOutputAccess $parserOutputAccess, PageLookup $pageLookup, RevisionLookup $revisionLookup, array $envOptions=[], ?PageIdentity $page=null, $body='', array $parameters=[], ?RevisionRecord $originalRevision=null, ?Bcp47Code $pageLanguage=null)
 
 getContent ()
 
 getParamSettings ()
 
 getTransform ()
 Return HTMLTransform object, so additional context can be provided by calling setters on it.
 
 init (PageIdentity $page, $body, array $parameters, ?RevisionRecord $originalRevision=null, ?Bcp47Code $pageLanguage=null)
 
 putContent (ResponseInterface $response)
 Creates a response containing the content derived from the input HTML.
 
 setMetrics (StatsFactory $statsFactory)
 Set metrics sink.
 
 setOriginal ( $rev, $originalRendering)
 Supply information about the revision and rendering that was the original basis of the input HTML.
 

Public Attributes

const CONSTRUCTOR_OPTIONS
 

Detailed Description

REST helper for converting HTML to page content source (e.g.

wikitext).

Since
1.40
Stability: unstable
Pending consolidation of the Parsoid extension with core code.

Definition at line 63 of file HtmlInputTransformHelper.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper::__construct ( StatsFactory $statsFactory,
HtmlTransformFactory $htmlTransformFactory,
ParsoidOutputStash $parsoidOutputStash,
ParserOutputAccess $parserOutputAccess,
PageLookup $pageLookup,
RevisionLookup $revisionLookup,
array $envOptions = [],
?PageIdentity $page = null,
$body = '',
array $parameters = [],
?RevisionRecord $originalRevision = null,
?Bcp47Code $pageLanguage = null )
Parameters
StatsFactory$statsFactory
HtmlTransformFactory$htmlTransformFactory
ParsoidOutputStash$parsoidOutputStash
ParserOutputAccess$parserOutputAccess
PageLookup$pageLookup
RevisionLookup$revisionLookup
array$envOptions
?PageIdentity$page
array | string$bodyBody structure, or an HTML string
array$parameters
RevisionRecord | null$originalRevision
Bcp47Code | null$pageLanguage

Definition at line 105 of file HtmlInputTransformHelper.php.

References wfDeprecated().

Member Function Documentation

◆ getContent()

MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper::getContent ( )
Returns
Content the content derived from the input HTML.
Exceptions
HttpException

Definition at line 599 of file HtmlInputTransformHelper.php.

◆ getParamSettings()

MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper::getParamSettings ( )

Definition at line 136 of file HtmlInputTransformHelper.php.

◆ getTransform()

MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper::getTransform ( )

Return HTMLTransform object, so additional context can be provided by calling setters on it.

Definition at line 442 of file HtmlInputTransformHelper.php.

◆ init()

MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper::init ( PageIdentity $page,
$body,
array $parameters,
?RevisionRecord $originalRevision = null,
?Bcp47Code $pageLanguage = null )
Parameters
PageIdentity$page
array | string$bodyBody structure, or an HTML string
array$parameters
RevisionRecord | null$originalRevision
Bcp47Code | null$pageLanguage
Exceptions
HttpException
Deprecated
since 1.43; pass arguments to constructor instead

Definition at line 305 of file HtmlInputTransformHelper.php.

References wfDeprecated().

◆ putContent()

MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper::putContent ( ResponseInterface $response)

Creates a response containing the content derived from the input HTML.

This will set the appropriate Content-Type header.

Definition at line 626 of file HtmlInputTransformHelper.php.

References MediaWiki\Rest\ResponseInterface\getBody(), and MediaWiki\Rest\ResponseInterface\setHeader().

◆ setMetrics()

MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper::setMetrics ( StatsFactory $statsFactory)

Set metrics sink.

Definition at line 449 of file HtmlInputTransformHelper.php.

◆ setOriginal()

MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper::setOriginal ( $rev,
$originalRendering )

Supply information about the revision and rendering that was the original basis of the input HTML.

This is used to apply selective serialization (selser), if possible.

Parameters
RevisionRecord | int | null$rev
ParsoidRenderID | PageBundle | ParserOutput | null$originalRendering

Definition at line 464 of file HtmlInputTransformHelper.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper::CONSTRUCTOR_OPTIONS
Initial value:
= [
]
const ParsoidCacheConfig
Name constant for the ParsoidCacheConfig setting, for use with Config::get()
Access: internal

Definition at line 67 of file HtmlInputTransformHelper.php.


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