Parsoid
A bidirectional parser between wikitext and HTML5
Loading...
Searching...
No Matches
Wikimedia\Parsoid\Ext\Nowiki\Nowiki Class Reference

Nowiki treats anything inside it as plain text. More...

+ Inheritance diagram for Wikimedia\Parsoid\Ext\Nowiki\Nowiki:
+ Collaboration diagram for Wikimedia\Parsoid\Ext\Nowiki\Nowiki:

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}

 
 sourceToDom (ParsoidExtensionAPI $extApi, string $txt, array $extArgs)
 Convert an extension tag's content to "prepared and loaded" DOM.
Parameters
ParsoidExtensionAPI$extApi
string$srcExtension tag content
array$extArgsExtension 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

 
 domToWikitext (ParsoidExtensionAPI $extApi, Element $node, bool $wrapperUnmodified)
 Serialize a DOM node created by this extension to wikitext.
Parameters
ParsoidExtensionAPI$extApi
Element$nodeA node in a "prepared and loaded" document.
bool$wrapperUnmodified
Returns
string|false Return false to use the default serialization.

 
- 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).
 
 lintHandler (ParsoidExtensionAPI $extApi, Element $rootNode, callable $defaultHandler)
 Lint handler for this extension.
 
 diffHandler (ParsoidExtensionAPI $extApi, callable $domDiff, Element $origNode, Element $editedNode)
 XXX: Experimental.
 

Detailed Description

Nowiki treats anything inside it as plain text.

Member Function Documentation

◆ domToWikitext()

Wikimedia\Parsoid\Ext\Nowiki\Nowiki::domToWikitext ( ParsoidExtensionAPI $extApi,
Element $node,
bool $wrapperUnmodified )

Serialize a DOM node created by this extension to wikitext.

Parameters
ParsoidExtensionAPI$extApi
Element$nodeA node in a "prepared and loaded" document.
bool$wrapperUnmodified
Returns
string|false Return false to use the default serialization.

Reimplemented from Wikimedia\Parsoid\Ext\ExtensionTagHandler.

◆ getConfig()

Wikimedia\Parsoid\Ext\Nowiki\Nowiki::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.

◆ sourceToDom()

Wikimedia\Parsoid\Ext\Nowiki\Nowiki::sourceToDom ( ParsoidExtensionAPI $extApi,
string $txt,
array $extArgs )

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

Parameters
ParsoidExtensionAPI$extApi
string$srcExtension tag content
array$extArgsExtension 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: