Wikimedia\Dodo\Comment Class Reference

Comment node. More...

Inheritance diagram for Wikimedia\Dodo\Comment:

Public Member Functions
	__construct (Document $nodeDocument, $data)
	Create a new Comment node.
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[] &$markup accumulator for the result
Comment	clone ()
Public Member Functions inherited from Wikimedia\Dodo\CharacterData
string	getNodeValue ()
	Return the value for this node. See also https://dom.spec.whatwg.org/#dom-node-nodevalue Returns ?string
	setNodeValue (?string $value)
string	getTextContent ()
	Return the textContent for this node. See also https://dom.spec.whatwg.org/#dom-node-textcontent Returns ?string
	setTextContent (?string $value)
string	substringData (int $offset, int $count)
	DOMString substringData(unsigned long offset, unsigned long count);.
	appendData (string $data)
	void appendData(DOMString data);
	insertData (int $offset, string $data)
	void insertData(unsigned long offset, DOMString data);
	deleteData (int $offset, int $count)
	void deleteData(unsigned long offset, unsigned long count);
	replaceData (int $offset, int $count, string $data)
	void replaceData(unsigned long offset, unsigned long count, DOMString data);
int	getLength ()
	NOTE: see discussion of UTF-16 code units -vs- unicode code points in ::substringData() above.
string	getData ()
	setData (?string $value)
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.
int	count ()
	This is a non-standard extension, but it allows count() to be used on CharacterData nodes in the same way that .length is used on them in JavaScript – and makes some of our WPT test cases pass.
Public Member Functions inherited from Wikimedia\Dodo\Leaf
bool	hasChildNodes ()
Node	getFirstChild ()
	This should be overridden in ContainerNode and Leaf.
Node	getLastChild ()
	This should be overridden in ContainerNode and Leaf.
Node	insertBefore ( $node, $refChild=null)
	Insert $node as a child of $this, and insert it before $refChild in the document order.spec DOM-LSTHINGS TO KNOW FROM THE SPEC: If $node already exists in this Document, this function moves it from its current position to its new position ('move' means 'remove' followed by 're-insert'). If $refNode is NULL, then $node is added to the end of the list of children of $this. In other words, insertBefore($node, NULL) is equivalent to appendChild($node). If $node is a DocumentFragment, the children of the DocumentFragment are moved into the child list of $this, and the empty DocumentFragment is returned. THINGS TO KNOW IN LIFE:Despite its weird syntax (blame the spec), this is a real workhorse, used to implement all of the non-replacing insertion mutations. Parameters INode $node To be inserted ?INode $refNode Child of this node before which to insert $node Returns Node Newly inserted Node or empty DocumentFragment Exceptions DOMException "HierarchyRequestError" or "NotFoundError"
Node	replaceChild ( $node, $refChild)
Node	removeChild ( $node)
	_removeChildren ()
NodeList	getChildNodes ()
	This should be overridden in ContainerNode and Leaf.
Public Member Functions inherited from Wikimedia\Dodo\Node
	__construct (Document $nodeDocument)
	Create a Node whose node document is the given $nodeDocument.
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.
	appendChild ( $node)
Node	_unsafeAppendChild (Node $node)
	Does not check for insertion validity.
	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::ChildNode
void	before (... $nodes)
void	after (... $nodes)
void	replaceWith (... $nodes)
void	remove ()
Public Member Functions inherited from Wikimedia::IDLeDOM::NonDocumentTypeChildNode
Element null	getPreviousElementSibling ()
Element null	getNextElementSibling ()

Protected Member Functions
Comment	_subclassCloneNodeShallow ()
Protected Member Functions inherited from Wikimedia\Dodo\CharacterData
mixed	_getMissingProp (string $name)
	HACK! For compatibilty with W3C test suite, which assumes that an access to 'attributes' will return null.
	_setMissingProp (string $prop, $value)
	Implement _setMissingProp to allow $_charLength to be a dynamic property.
	__construct (Document $nodeDocument, string $data)
	Create a CharacterData with data (in UTF-8 encoding).
Protected Member Functions inherited from Wikimedia\Dodo\Node
bool	_subclassIsEqualNode (Node $node)
	Delegated subclass method called by Node::isEqualNode()

Additional Inherited Members
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.
Protected Attributes inherited from Wikimedia\Dodo\CharacterData
string	$_data

Detailed Description

Comment node.

Constructor & Destructor Documentation

__construct()

Wikimedia\Dodo\Comment::__construct	(	Document	$nodeDocument,
			$data )

Create a new Comment node.

Parameters

Document	$nodeDocument
string	$data

Member Function Documentation

_subclassCloneNodeShallow()

Comment Wikimedia\Dodo\Comment::_subclassCloneNodeShallow ( )

protected

Returns

Comment

Reimplemented from Wikimedia\Dodo\Node.

_xmlSerialize()

Wikimedia\Dodo\Comment::_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[]	&$markup	accumulator for the result

Reimplemented from Wikimedia\Dodo\Node.

getNodeName()

string Wikimedia\Dodo\Comment::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\Comment::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.

---

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

• src/Comment.php