Parsoid
A bidirectional parser between wikitext and HTML5
Loading...
Searching...
No Matches
Wikimedia\Parsoid\NodeData\DataMw Class Reference
+ Inheritance diagram for Wikimedia\Parsoid\NodeData\DataMw:
+ Collaboration diagram for Wikimedia\Parsoid\NodeData\DataMw:

Public Member Functions

 __construct (array $initialVals=[])
 
 fromWellBalancedTemplate ()
 
 isEmpty ()
 Returns true iff there are no dynamic properties of this object.
 
 getExtAttribs ()
 Helper method to facilitate renaming the 'attrs' property to 'extAttribs' (T367616).
 
 getExtAttrib (string $name)
 Helper method to facilitate renaming the 'attrs' property to 'extAttribs' (T367616).
 
 setExtAttrib (string $name, $value)
 Helper method to facilitate renaming the 'attrs' property to 'extAttribs' (T367616).
 
 equalsWithComparator (DataMw $other, callable $docFragEquals)
 
 __clone ()
 
 flatten ()
 Provide a flattened "plain string" form of this data for use as the value of a compatibility attribute to implement HTML semantics.
Returns
?string a plain string, or null to omit the compatibility attribute

 
 embeddedDocumentFragments ()
 Iterate over any DocumentFragments embedded in this attribute.
Returns
\Iterator<DocumentFragment>

 
 toJsonArray (JsonCodecInterface $codec)
 

Static Public Member Functions

static hint ()
 
static defaultValue ()
 Provide a constructor for a default value for objects of this type.
Returns
?self

 
static jsonClassHintFor (string $keyname)
 

Member Function Documentation

◆ defaultValue()

static Wikimedia\Parsoid\NodeData\DataMw::defaultValue ( )
static

Provide a constructor for a default value for objects of this type.

Returns
?self

Implements Wikimedia\Parsoid\Utils\RichCodecable.

◆ embeddedDocumentFragments()

Wikimedia\Parsoid\NodeData\DataMw::embeddedDocumentFragments ( )

Iterate over any DocumentFragments embedded in this attribute.

Returns
\Iterator<DocumentFragment>

Implements Wikimedia\Parsoid\Utils\RichCodecable.

◆ flatten()

Wikimedia\Parsoid\NodeData\DataMw::flatten ( )

Provide a flattened "plain string" form of this data for use as the value of a compatibility attribute to implement HTML semantics.

Returns
?string a plain string, or null to omit the compatibility attribute

Implements Wikimedia\Parsoid\Utils\RichCodecable.

◆ getExtAttrib()

Wikimedia\Parsoid\NodeData\DataMw::getExtAttrib ( string $name)

Helper method to facilitate renaming the 'attrs' property to 'extAttribs' (T367616).

Parameters
string$name
Returns
string|array<Token|string>|null

◆ getExtAttribs()

Wikimedia\Parsoid\NodeData\DataMw::getExtAttribs ( )

Helper method to facilitate renaming the 'attrs' property to 'extAttribs' (T367616).

Note
that numeric key values will be converted from string to int by PHP when they are used as array keys
Returns
?array<string|int,string|array<Token|string>>

◆ hint()

static Wikimedia\Parsoid\NodeData\DataMw::hint ( )
static
Returns
Hint<DataMw>

Implements Wikimedia\Parsoid\Utils\RichCodecable.

◆ setExtAttrib()

Wikimedia\Parsoid\NodeData\DataMw::setExtAttrib ( string $name,
$value )

Helper method to facilitate renaming the 'attrs' property to 'extAttribs' (T367616).

Parameters
string$name
string|array<Token|string>|null$value Setting to null will unset it from the array.

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