Wikimedia\Parsoid\Ext\Pre\Pre Class Reference

The <pre> extension tag shadows the html pre tag, but has different semantics. More...

Inheritance diagram for Wikimedia\Parsoid\Ext\Pre\Pre:

Collaboration diagram for Wikimedia\Parsoid\Ext\Pre\Pre:

Public Member Functions
	getConfig ()
	Return information about this extension module.The structure of the return value is enforced by moduleconfig.schema.json, in this directory. See also https://www.mediawiki.org/wiki/Parsoid/Internals/Module_Configuration_Schema Returns array{name:string}
	sourceToDom (ParsoidExtensionAPI $extApi, string $content, array $args)
	Convert an extension tag's content to "prepared and loaded" DOM. Parameters ParsoidExtensionAPI $extApi string $content Extension tag content array $args Extension tag arguments The extension tag arguments should be treated as opaque objects and any necessary inspection should be handled through the API. Returns DocumentFragment|false|null DocumentFragment if returning some parsed content false to fallback to the default handler for the content null to drop the instance completely Exceptions ExtensionError
Public Member Functions inherited from Wikimedia\Parsoid\Ext\ExtensionTagHandler
	processAttributeEmbeddedHTML (ParsoidExtensionAPI $extApi, Element $elt, Closure $proc)
	Extensions might embed HTML in attributes in their own custom representation (whether in data-mw or elsewhere).
	processAttributeEmbeddedDom (ParsoidExtensionAPI $extApi, Element $elt, callable $proc)
	Extensions might embed HTML in attributes in their own custom representation (whether in data-mw or elsewhere).
	lintHandler (ParsoidExtensionAPI $extApi, Element $rootNode, callable $defaultHandler)
	Lint handler for this extension.
	domToWikitext (ParsoidExtensionAPI $extApi, Element $node, bool $wrapperUnmodified)
	Serialize a DOM node created by this extension to wikitext.
	diffHandler (ParsoidExtensionAPI $extApi, callable $domDiff, Element $origNode, Element $editedNode)
	XXX: Experimental.

Detailed Description

The <pre> extension tag shadows the html pre tag, but has different semantics.

It treats anything inside it as plaintext.

Member Function Documentation

getConfig()

Wikimedia\Parsoid\Ext\Pre\Pre::getConfig

(

)

Return information about this extension module.The structure of the return value is enforced by moduleconfig.schema.json, in this directory.

See also

https://www.mediawiki.org/wiki/Parsoid/Internals/Module_Configuration_Schema

Returns

array{name:string}

Implements Wikimedia\Parsoid\Ext\ExtensionModule.

sourceToDom()

Wikimedia\Parsoid\Ext\Pre\Pre::sourceToDom	(	ParsoidExtensionAPI	$extApi,
		string	$content,
		array	$args )

Convert an extension tag's content to "prepared and loaded" DOM.

Parameters

ParsoidExtensionAPI	$extApi
string	$content	Extension tag content
array	$args	Extension tag arguments The extension tag arguments should be treated as opaque objects and any necessary inspection should be handled through the API.

Returns

DocumentFragment|false|null DocumentFragment if returning some parsed content false to fallback to the default handler for the content null to drop the instance completely

Exceptions

ExtensionError

Reimplemented from Wikimedia\Parsoid\Ext\ExtensionTagHandler.

---

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

• src/Ext/Pre/Pre.php