MediaWiki\Parser\Parsoid\ParsoidParser Class Reference

Parser implementation which uses Parsoid. More...

Public Member Functions
	__construct (private Parsoid $parsoid, private readonly PageConfigFactory $pageConfigFactory, private readonly LanguageConverterFactory $languageConverterFactory, private readonly DataAccess $dataAccess,)
	parse ( $text, PageReference $page, ParserOptions $options, bool $linestart=true, bool $clearState=true, ?int $revId=null, ?ParserOutput $previousOutput=null)
	Convert wikitext to HTML Do not call this function recursively.
	parseFakeRevision (RevisionRecord $fakeRev, PageReference $page, ParserOptions $options)

Public Attributes
const	PARSOID_TITLE_KEY = "parsoid:title-dbkey"

Detailed Description

Parser implementation which uses Parsoid.

Currently incomplete; see T236809 for the long-term plan.

Since

1.41

Stability: unstable

since 1.41; see T236809 for plan.

Definition at line 35 of file ParsoidParser.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Parser\Parsoid\ParsoidParser::__construct	(	private Parsoid	$parsoid,
		private readonly PageConfigFactory	$pageConfigFactory,
		private readonly LanguageConverterFactory	$languageConverterFactory,
		private readonly DataAccess	$dataAccess )

Definition at line 44 of file ParsoidParser.php.

Member Function Documentation

parse()

MediaWiki\Parser\Parsoid\ParsoidParser::parse	(		$text,
		PageReference	$page,
		ParserOptions	$options,
		bool	$linestart = true,
		bool	$clearState = true,
		?int	$revId = null,
		?ParserOutput	$previousOutput = null )

Convert wikitext to HTML Do not call this function recursively.

Parameters

string | TextContent	$text	Text we want to parse
PageReference	$page
ParserOptions	$options
bool	$linestart
bool	$clearState
int | null	$revId	ID of the revision being rendered. This is used to render REVISION* magic words. 0 means that any current revision will be used. Null means that {{REVISIONID}}/{{REVISIONUSER}} will be empty and {{REVISIONTIMESTAMP}} will use the current timestamp.
?ParserOutput	$previousOutput	The (optional) result of a previous parse of this page, which can be used for selective update.

Returns

ParserOutput

Stability: unstable

since 1.41

Definition at line 240 of file ParsoidParser.php.

parseFakeRevision()

MediaWiki\Parser\Parsoid\ParsoidParser::parseFakeRevision	(	RevisionRecord	$fakeRev,
		PageReference	$page,
		ParserOptions	$options )

Access: internal

Convert custom wikitext (stored in main slot of the $fakeRev arg) to HTML. Callers are expected NOT to stuff the result into ParserCache.

Parameters

RevisionRecord	$fakeRev	Revision to parse
PageReference	$page
ParserOptions	$options

Returns

ParserOutput

Stability: unstable

since 1.41

Definition at line 301 of file ParsoidParser.php.

Member Data Documentation

PARSOID_TITLE_KEY

const MediaWiki\Parser\Parsoid\ParsoidParser::PARSOID_TITLE_KEY = "parsoid:title-dbkey"

Stability: unstable

This should not be used widely right now since this may go away. This is being added to support DiscussionTools with Parsoid HTML and after initial exploration, this may be implemented differently.

Definition at line 42 of file ParsoidParser.php.

---

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

• includes/Parser/Parsoid/ParsoidParser.php