Parsoid
A bidirectional parser between wikitext and HTML5
Wikimedia\Parsoid\Ext\Cite\Ref Class Reference

Simple token transform version of the Ref extension tag. More...

+ Inheritance diagram for Wikimedia\Parsoid\Ext\Cite\Ref:
+ Collaboration diagram for Wikimedia\Parsoid\Ext\Cite\Ref:

Public Member Functions

 sourceToDom (ParsoidExtensionAPI $extApi, string $txt, array $extArgs)
 Convert an extension tag's content to 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

 
 lintHandler (ParsoidExtensionAPI $extApi, Element $ref, callable $defaultHandler)
 Lint handler for this extension.If the extension has lints it wants to expose, it should use $extApi to register those lints. Alternatively, the extension might simply inspect its DOM and invoke the default lint handler on a DOM tree that it wants inspected. For example, <ref> nodes often only have a pointer (the id attribute) to its content, and is lint handler would look up the DOM tree and invoke the default lint handler on that tree.FIXME: There is probably no reason for the lint handler to return anything. The caller should simply proceed with the next sibling of $rootNode after the lint handler returns.
Parameters
ParsoidExtensionAPI$extApi
Element$rootNodeExtension content's root node
callable$defaultHandlerDefault lint handler
  • Default lint handler has signature $defaultHandler( Element $elt ): void
Returns
Node|null|false Return false to indicate that this extension has no special lint handler (the default lint handler will be used. Return null to indicate linting should proceed with the next sibling. (Deprecated) A Node can be returned to indicate the point in the tree where linting should resume.

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

 
 diffHandler (ParsoidExtensionAPI $extApi, callable $domDiff, Element $origNode, Element $editedNode)
 XXX: Experimental.Call $domDiff on corresponding substrees of $origNode and $editedNode
Parameters
ParsoidExtensionAPI$extApi
callable$domDiff
Element$origNode
Element$editedNode
Returns
bool

 
- Public Member Functions inherited from Wikimedia\Parsoid\Ext\ExtensionTagHandler
 modifyArgDict (ParsoidExtensionAPI $extApi, object $argDict)
 Some extensions require the ability to modify the argument dictionary. More...
 

Detailed Description

Simple token transform version of the Ref extension tag.


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