Wikimedia\Parsoid\Ext\Indicator\Indicator Class Reference

Implements the php parser's indicator hook natively. More...

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

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

Public Member Functions
	getConfig ()
	Return information about this extension module.FIXME: Add more expected fields or create a class for this FIXME: The 'name' is expected to be the same as the name defined at the top level of extension.json. Returns array{name:string}
	processAttributeEmbeddedHTML (ParsoidExtensionAPI $extApi, Element $elt, Closure $proc)
	Extensions might embed HTML in attributes in their own custom representation (whether in data-mw or elsewhere).Core Parsoid will need a way to traverse such content. This method is a way for extension tag handlers to provide this functionality. Parsoid will only call this method if the tag's config sets the options['wt2html']['embedsHTMLInAttributes'] property to true. Parameters ParsoidExtensionAPI $extApi Element $elt The node whose data attributes need to be examined Closure $proc The processor that will process the embedded HTML Signature: (string) -> string This processor will be provided the HTML string as input and is expected to return a possibly modified string.
	sourceToDom (ParsoidExtensionAPI $extApi, string $content, array $args)
	Convert an extension tag's content to "prepared and loaded" DOM. Parameters ParsoidExtensionAPI $extApi string $src Extension tag content array $extArgs 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
Public Member Functions inherited from Wikimedia\Parsoid\Ext\ExtensionTagHandler
	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

Implements the php parser's indicator hook natively.

Member Function Documentation

getConfig()

Wikimedia\Parsoid\Ext\Indicator\Indicator::getConfig

(

)

Return information about this extension module.FIXME: Add more expected fields or create a class for this FIXME: The 'name' is expected to be the same as the name defined at the top level of extension.json.

Returns

array{name:string}

Implements Wikimedia\Parsoid\Ext\ExtensionModule.

processAttributeEmbeddedHTML()

Wikimedia\Parsoid\Ext\Indicator\Indicator::processAttributeEmbeddedHTML	(	ParsoidExtensionAPI	$extApi,
		Element	$elt,
		Closure	$proc )

Extensions might embed HTML in attributes in their own custom representation (whether in data-mw or elsewhere).Core Parsoid will need a way to traverse such content. This method is a way for extension tag handlers to provide this functionality. Parsoid will only call this method if the tag's config sets the options['wt2html']['embedsHTMLInAttributes'] property to true.

Parameters

ParsoidExtensionAPI	$extApi
Element	$elt	The node whose data attributes need to be examined
Closure	$proc	The processor that will process the embedded HTML Signature: (string) -> string This processor will be provided the HTML string as input and is expected to return a possibly modified string.

Reimplemented from Wikimedia\Parsoid\Ext\ExtensionTagHandler.

sourceToDom()

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

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

Parameters

ParsoidExtensionAPI	$extApi
string	$src	Extension tag content
array	$extArgs	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

Reimplemented from Wikimedia\Parsoid\Ext\ExtensionTagHandler.

---

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

• src/Ext/Indicator/Indicator.php