This class allows HTML to be transformed to a page content source format such as wikitext. More...

Collaboration diagram for Parser\Parsoid\HtmlToContentTransform:

Public Member Functions
	__construct (string $modifiedHTML, PageIdentity $page, Parsoid $parsoid, array $parsoidSettings, PageConfigFactory $pageConfigFactory, IContentHandlerFactory $contentHandlerFactory)

	getContentModel ()

	getModifiedDocument ()

	getModifiedHtmlSize ()
	The size of the modified HTML in characters. More...

	getOffsetType ()

	getOriginalBody ()
	NOTE: The return value of this method depends on setOriginalData() having been called first. More...

	getOriginalHtml ()
	Returns the original HTML, with any necessary processing applied. More...

	getOriginalRevisionId ()

	getOriginalSchemaVersion ()

	getSchemaVersion ()
	NOTE: The return value of this method depends on setOriginalData() having been called first. More...

	hasOriginalDataParsoid ()
	NOTE: The return value of this method depends on setOriginalData() having been called first. More...

	hasOriginalHtml ()
	NOTE: The return value of this method depends on setOriginalData() having been called first. More...

	htmlToContent ()
	Returns a Content object derived from the supplied HTML. More...

	knowsOriginalContent ()

	setContentLanguage (Bcp47Code $lang)

	setMetrics (StatsdDataFactoryInterface $metrics)

	setModifiedDataMW (array $modifiedDataMW)

	setOptions (array $options)

	setOriginalContent (Content $content)
	Sets the original content (such as wikitext). More...

	setOriginalDataMW (array $originalDataMW)

	setOriginalDataParsoid (array $originalDataParsoid)

	setOriginalHtml (string $originalHtml)

	setOriginalRevision (RevisionRecord $rev)

	setOriginalRevisionId (int $oldid)

	setOriginalSchemaVersion (string $originalSchemaVeraion)

	setOriginalText (string $text)
	Sets the original source text (usually wikitext). More...

Protected Member Functions
	parseHTML (string $html, bool $validateXMLNames=false)

Protected Attributes
StatsdDataFactoryInterface	$metrics = null
	A statistics aggregator. More...

Detailed Description

This class allows HTML to be transformed to a page content source format such as wikitext.

Since: 1.40

Stability: unstable: should be stable before 1.40 release

Definition at line 38 of file HtmlToContentTransform.php.

Constructor & Destructor Documentation

◆ __construct()

Parser\Parsoid\HtmlToContentTransform::__construct	(	string	$modifiedHTML,
		PageIdentity	$page,
		Parsoid	$parsoid,
		array	$parsoidSettings,
		PageConfigFactory	$pageConfigFactory,
		IContentHandlerFactory	$contentHandlerFactory
	)

Parameters

string	$modifiedHTML
PageIdentity	$page
Parsoid	$parsoid
array	$parsoidSettings
PageConfigFactory	$pageConfigFactory
IContentHandlerFactory	$contentHandlerFactory

Definition at line 102 of file HtmlToContentTransform.php.

Member Function Documentation

◆ getContentModel()

Parser\Parsoid\HtmlToContentTransform::getContentModel ( )

Definition at line 499 of file HtmlToContentTransform.php.

◆ getModifiedDocument()

Parser\Parsoid\HtmlToContentTransform::getModifiedDocument ( )

Definition at line 350 of file HtmlToContentTransform.php.

◆ getModifiedHtmlSize()

Parser\Parsoid\HtmlToContentTransform::getModifiedHtmlSize ( )

The size of the modified HTML in characters.

Returns: int

Definition at line 337 of file HtmlToContentTransform.php.

◆ getOffsetType()

Parser\Parsoid\HtmlToContentTransform::getOffsetType ( )

Definition at line 503 of file HtmlToContentTransform.php.

◆ getOriginalBody()

Parser\Parsoid\HtmlToContentTransform::getOriginalBody ( )

NOTE: The return value of this method depends on setOriginalData() having been called first.

Returns: Element

Exceptions

ClientError

Definition at line 431 of file HtmlToContentTransform.php.

◆ getOriginalHtml()

Parser\Parsoid\HtmlToContentTransform::getOriginalHtml ( )

Returns the original HTML, with any necessary processing applied.

Todo:: Make this method redundant, nothing should operate on HTML strings.

Returns: string

Definition at line 389 of file HtmlToContentTransform.php.

◆ getOriginalRevisionId()

Parser\Parsoid\HtmlToContentTransform::getOriginalRevisionId ( )

Definition at line 491 of file HtmlToContentTransform.php.

◆ getOriginalSchemaVersion()

Parser\Parsoid\HtmlToContentTransform::getOriginalSchemaVersion ( )

Definition at line 467 of file HtmlToContentTransform.php.

◆ getSchemaVersion()

Parser\Parsoid\HtmlToContentTransform::getSchemaVersion ( )

NOTE: The return value of this method depends on setOriginalData() having been called first.

Returns: string

Definition at line 477 of file HtmlToContentTransform.php.

◆ hasOriginalDataParsoid()

Parser\Parsoid\HtmlToContentTransform::hasOriginalDataParsoid ( )

NOTE: The return value of this method depends on setOriginalData() having been called first.

Returns: bool

Definition at line 378 of file HtmlToContentTransform.php.

◆ hasOriginalHtml()

Parser\Parsoid\HtmlToContentTransform::hasOriginalHtml ( )

NOTE: The return value of this method depends on setOriginalData() having been called first.

Returns: bool

Definition at line 368 of file HtmlToContentTransform.php.

◆ htmlToContent()

Parser\Parsoid\HtmlToContentTransform::htmlToContent ( )

Returns a Content object derived from the supplied HTML.

Returns: Content

Definition at line 647 of file HtmlToContentTransform.php.

◆ knowsOriginalContent()

Parser\Parsoid\HtmlToContentTransform::knowsOriginalContent ( )

Definition at line 495 of file HtmlToContentTransform.php.

◆ parseHTML()

Parser\Parsoid\HtmlToContentTransform::parseHTML	(	string	$html,
		bool	$validateXMLNames = `false`
	)

protected

Parameters

string	$html
bool	$validateXMLNames

Returns: Document

Exceptions

ClientError

Definition at line 420 of file HtmlToContentTransform.php.

◆ setContentLanguage()

Parser\Parsoid\HtmlToContentTransform::setContentLanguage ( Bcp47Code $lang )

Parameters

Bcp47Code $lang

Definition at line 178 of file HtmlToContentTransform.php.

◆ setMetrics()

Parser\Parsoid\HtmlToContentTransform::setMetrics ( StatsdDataFactoryInterface $metrics )

Parameters

StatsdDataFactoryInterface $metrics

Definition at line 122 of file HtmlToContentTransform.php.

◆ setModifiedDataMW()

Parser\Parsoid\HtmlToContentTransform::setModifiedDataMW ( array $modifiedDataMW )

Note: Call this after all original data has been set!

Parameters

array $modifiedDataMW

Definition at line 229 of file HtmlToContentTransform.php.

◆ setOptions()

Parser\Parsoid\HtmlToContentTransform::setOptions ( array $options )

Definition at line 142 of file HtmlToContentTransform.php.

◆ setOriginalContent()

Parser\Parsoid\HtmlToContentTransform::setOriginalContent ( Content $content )

Sets the original content (such as wikitext).

Parameters

Content $content

Definition at line 201 of file HtmlToContentTransform.php.

◆ setOriginalDataMW()

Parser\Parsoid\HtmlToContentTransform::setOriginalDataMW ( array $originalDataMW )

Parameters

array $originalDataMW

Definition at line 261 of file HtmlToContentTransform.php.

◆ setOriginalDataParsoid()

Parser\Parsoid\HtmlToContentTransform::setOriginalDataParsoid ( array $originalDataParsoid )

Parameters

array $originalDataParsoid

Definition at line 278 of file HtmlToContentTransform.php.

◆ setOriginalHtml()

Parser\Parsoid\HtmlToContentTransform::setOriginalHtml ( string $originalHtml )

Parameters

string $originalHtml

Definition at line 249 of file HtmlToContentTransform.php.

◆ setOriginalRevision()

Parser\Parsoid\HtmlToContentTransform::setOriginalRevision ( RevisionRecord $rev )

Parameters

RevisionRecord $rev

Definition at line 149 of file HtmlToContentTransform.php.

◆ setOriginalRevisionId()

Parser\Parsoid\HtmlToContentTransform::setOriginalRevisionId ( int $oldid )

Parameters

int $oldid

Definition at line 164 of file HtmlToContentTransform.php.

◆ setOriginalSchemaVersion()

Parser\Parsoid\HtmlToContentTransform::setOriginalSchemaVersion ( string $originalSchemaVeraion )

Parameters

string $originalSchemaVeraion

Definition at line 242 of file HtmlToContentTransform.php.

◆ setOriginalText()

Parser\Parsoid\HtmlToContentTransform::setOriginalText ( string $text )

Sets the original source text (usually wikitext).

Parameters

string $text

Definition at line 191 of file HtmlToContentTransform.php.

Member Data Documentation

◆ $metrics

StatsdDataFactoryInterface Parser::Parsoid\HtmlToContentTransform::$metrics = null

protected

A statistics aggregator.

Definition at line 68 of file HtmlToContentTransform.php.

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

includes/parser/Parsoid/HtmlToContentTransform.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getContentModel()

◆ getModifiedDocument()

◆ getModifiedHtmlSize()

◆ getOffsetType()

◆ getOriginalBody()

◆ getOriginalHtml()

◆ getOriginalRevisionId()

◆ getOriginalSchemaVersion()

◆ getSchemaVersion()

◆ hasOriginalDataParsoid()

◆ hasOriginalHtml()

◆ htmlToContent()

◆ knowsOriginalContent()

◆ parseHTML()

◆ setContentLanguage()

◆ setMetrics()

◆ setModifiedDataMW()

◆ setOptions()

◆ setOriginalContent()

◆ setOriginalDataMW()

◆ setOriginalDataParsoid()

◆ setOriginalHtml()

◆ setOriginalRevision()

◆ setOriginalRevisionId()

◆ setOriginalSchemaVersion()

◆ setOriginalText()

Member Data Documentation

◆ $metrics