Dodo
DOm DOcument implementation
Loading...
Searching...
No Matches
Wikimedia\Dodo\DocumentFragment Class Reference

DocumentFragment. More...

+ Inheritance diagram for Wikimedia\Dodo\DocumentFragment:

Public Member Functions

 __construct (Document $nodeDocument)
 
Parameters
Document$nodeDocument

 
int getNodeType ()
 Return the node type enumeration for this node.
See also
https://dom.spec.whatwg.org/#dom-node-nodetype
Returns
int

 
string getNodeName ()
 Return the nodeName for this node.
See also
https://dom.spec.whatwg.org/#dom-node-nodename
Returns
string

 
 _xmlSerialize (?string $namespace, NamespacePrefixMap $prefixMap, int &$prefixIndex, array $options, array &$markup)
 XML serialize the given node.This is overridden in subclasses. Note that this is effectively "outerHTML", due to a spec inconsistency: https://github.com/w3c/DOM-Parsing/issues/28 .
See also
https://w3c.github.io/DOM-Parsing/#dfn-xml-serialization
Parameters
?string$namespace
NamespacePrefixMap$prefixMap
int&$prefixIndex
array$options
string[]&$markupaccumulator for the result

 
 querySelectorAll (string $selectors)
 
 querySelector (string $selectors)
 
 getElementById (string $id)
 
array _getElementsById (string $id)
 
bool appendXML (string $data)
 Appends raw XML data to a DOMDocumentFragment.
 
string getInnerHTML ()
 
string getOuterHTML ()
 
- Public Member Functions inherited from Wikimedia\Dodo\ContainerNode
bool hasChildNodes ()
 Return true iff there are children of this node.
 
int _length ()
 
See also
https://dom.spec.whatwg.org/#concept-node-length
Returns
int The length of this node.

 
bool _empty ()
 
See also
https://dom.spec.whatwg.org/#concept-node-empty
Returns
bool Whether this node is considered empty.

 
NodeList getChildNodes ()
 Keeping child nodes as an array makes insertion/removal of nodes quite expensive.
 
Node getFirstChild ()
 Be careful to use this method in most cases rather than directly accessing _firstChildOrChildren.
 
Node getLastChild ()
 This should be overridden in ContainerNode and Leaf.
 
string getTextContent ()
 Generic implementation of ::getTextContent to be used by Element and DocumentFragment (but not Document!).
 
 setTextContent (?string $value)
 Generic implementation of ::setTextContent to be used by Element and DocumentFragment (but not Document!).
 
- Public Member Functions inherited from Wikimedia\Dodo\Node
string getNodeValue ()
 Return the value for this node.
 
 setNodeValue (?string $val)
 
Document getOwnerDocument ()
 The ownerDocument getter steps are to return null, if this is a document; otherwise this’s node document.
 
Node getParentNode ()
 Nodes might not have a parentNode.
 
Element getParentElement ()
 This value is the same as parentNode, except it puts an extra condition, that the parentNode must be an Element.
 
Wikimedia IDLeDOM Node getRootNode ($options=null)
 Return this' shadow-including root if options['composed'] is true; otherwise return this' root.
 
Node getPreviousSibling ()
 
Node getNextSibling ()
 
 _roothook ()
 <script> elements need to know when they're inserted into the document.
 
Node insertBefore ($node, $refNode=null)
 Insert $node as a child of $this, and insert it before $refChild in the document order.
 
 appendChild ( $node)
 
Node _unsafeAppendChild (Node $node)
 Does not check for insertion validity.
 
Node replaceChild ( $new, $old)
 
Node removeChild ( $node)
 
 normalize ()
 Puts $this and the entire subtree rooted at $this into "normalized" form.
 
int compareDocumentPosition ( $that)
 
bool contains ( $node)
 
bool isSameNode ( $node)
 
bool isEqualNode ( $node)
 Determine whether this node and $other are equal.
 
Node cloneNode (bool $deep=false)
 Clone this Node.
 
string lookupPrefix (?string $ns)
 Return DOMString containing prefix for given namespace URI.
 
string lookupNamespaceURI (?string $prefix)
 Return DOMString containing namespace URI for a given prefix.
 
bool isDefaultNamespace (?string $ns)
 Determine whether this is the default namespace.
 
string getNodePath ()
 Get an XPath for a node.
 
 _resetNodeDocument (Document $doc)
 Set the ownerDocument reference on a subtree rooted at $this.
 
bool getIsConnected ()
 Determine whether this Node is rooted (belongs to the tree rooted at the node document).
 
int _getSiblingIndex ()
 The index of this Node in its parent's childNodes list.
 
int _lastModTime ()
 Return the lastModTime value for this node.
 
 _modify ()
 Increment the owner document's modclock [and use the new value to update the lastModTime value for this node and all of its ancestors.
 
 _htmlSerialize (array &$result, array $options)
 Convert the children of a node to an HTML string.
 
mixed getExtensionData (string $key, $defaultValue=null)
 Get "extension data" associate with this node, using the given $key.
 
 setExtensionData (string $key, $value)
 Set "extension data" associate with this node, using the given $key.
 
- Public Member Functions inherited from Wikimedia::IDLeDOM::EventTarget
void addEventListener (string $type, $callback, $options=null)
 
void removeEventListener (string $type, $callback, $options=null)
 
bool dispatchEvent ( $event)
 
- Public Member Functions inherited from Wikimedia::IDLeDOM::Node
string getBaseURI ()
 
- Public Member Functions inherited from Wikimedia::IDLeDOM::ParentNode
HTMLCollection getChildren ()
 
Element null getFirstElementChild ()
 
Element null getLastElementChild ()
 
int getChildElementCount ()
 
void prepend (... $nodes)
 
void append (... $nodes)
 
void replaceChildren (... $nodes)
 

Protected Member Functions

mixed _getMissingProp (string $name)
 
DocumentFragment _subclassCloneNodeShallow ()
 
bool _subclassIsEqualNode (Node $node)
 Delegated subclass method called by Node::isEqualNode()
Parameters
Node$node
Returns
bool

 
- Protected Member Functions inherited from Wikimedia\Dodo\Node
 _setMissingProp (string $name, $value)
 

Additional Inherited Members

- Public Attributes inherited from Wikimedia\Dodo\ContainerNode
Node NodeList null $_firstChildOrChildren
 The first child (if we're using the linked list representation), or a NodeList (if we're using the array of children), or null (if there are no children).
 
- Public Attributes inherited from Wikimedia\Dodo\Node
Document $_nodeDocument
 The document this node is associated to.
 
Node null $_parentNode
 should be considered read-only
 
Node $_nextSibling
 The sibling list is stored as a circular linked list: the node "before" the first sibling is the last sibling, and the node "after" the last sibling is the first sibling.
 
Node $_previousSibling
 
int $_documentIndex = null
 DEVELOPERS NOTE: An index is assigned when a node is added to a Document (becomes rooted).
 
int $_cachedSiblingIndex = null
 DEVELOPERS NOTE: An index is assigned on INSERTION.
 

Detailed Description

DocumentFragment.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Dodo\DocumentFragment::__construct ( Document $nodeDocument)

Parameters
Document$nodeDocument

Reimplemented from Wikimedia\Dodo\ContainerNode.

Member Function Documentation

◆ _getMissingProp()

mixed Wikimedia\Dodo\DocumentFragment::_getMissingProp ( string $name)
protected
Parameters
string$name
Returns
mixed

Reimplemented from Wikimedia\Dodo\Node.

◆ _subclassCloneNodeShallow()

DocumentFragment Wikimedia\Dodo\DocumentFragment::_subclassCloneNodeShallow ( )
protected
Returns
DocumentFragment

Reimplemented from Wikimedia\Dodo\Node.

◆ _subclassIsEqualNode()

bool Wikimedia\Dodo\DocumentFragment::_subclassIsEqualNode ( Node $node)
protected

Delegated subclass method called by Node::isEqualNode()

Parameters
Node$node
Returns
bool

Reimplemented from Wikimedia\Dodo\Node.

◆ _xmlSerialize()

Wikimedia\Dodo\DocumentFragment::_xmlSerialize ( ?string $namespace,
NamespacePrefixMap $prefixMap,
int & $prefixIndex,
array $options,
array & $markup )

XML serialize the given node.This is overridden in subclasses. Note that this is effectively "outerHTML", due to a spec inconsistency: https://github.com/w3c/DOM-Parsing/issues/28 .

See also
https://w3c.github.io/DOM-Parsing/#dfn-xml-serialization
Parameters
?string$namespace
NamespacePrefixMap$prefixMap
int&$prefixIndex
array$options
string[]&$markupaccumulator for the result

Reimplemented from Wikimedia\Dodo\Node.

◆ appendXML()

bool Wikimedia\Dodo\DocumentFragment::appendXML ( string $data)

Appends raw XML data to a DOMDocumentFragment.

This method is not part of the DOM standard.

See also
https://www.php.net/manual/en/domdocumentfragment.appendxml.php
Parameters
string$dataXML to append.
Returns
bool true on success or false on failure.

Implements Wikimedia::IDLeDOM::DocumentFragment.

◆ getElementById()

Wikimedia\Dodo\DocumentFragment::getElementById ( string $id)

◆ getInnerHTML()

string Wikimedia\Dodo\DocumentFragment::getInnerHTML ( )
Returns
string the inner HTML of this DocumentFragment

◆ getNodeName()

string Wikimedia\Dodo\DocumentFragment::getNodeName ( )
final

Return the nodeName for this node.

See also
https://dom.spec.whatwg.org/#dom-node-nodename
Returns
string

Reimplemented from Wikimedia\Dodo\Node.

◆ getNodeType()

int Wikimedia\Dodo\DocumentFragment::getNodeType ( )
final

Return the node type enumeration for this node.

See also
https://dom.spec.whatwg.org/#dom-node-nodetype
Returns
int

Reimplemented from Wikimedia\Dodo\Node.

◆ getOuterHTML()

string Wikimedia\Dodo\DocumentFragment::getOuterHTML ( )
Returns
string the outer HTML of this DocumentFragment

◆ querySelector()

Wikimedia\Dodo\DocumentFragment::querySelector ( string $selectors)

◆ querySelectorAll()

Wikimedia\Dodo\DocumentFragment::querySelectorAll ( string $selectors)

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