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

Implements the php parser's renderImageGallery natively. More...

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

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 $content, array $args)
 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

 
 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.

 
 modifyArgDict (ParsoidExtensionAPI $extApi, object $argDict)
 Some extensions require the ability to modify the argument dictionary.
Parameters
ParsoidExtensionAPI$extApi
object$argDict

 
 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
 lintHandler (ParsoidExtensionAPI $extApi, Element $rootNode, callable $defaultHandler)
 Lint handler for this extension. More...
 

Detailed Description

Implements the php parser's renderImageGallery natively.

Params to support (on the extension tag):

  • showfilename
  • caption
  • mode
  • widths
  • heights
  • perrow

A proposed spec is at: https://phabricator.wikimedia.org/P2506


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