Class DOMIT_NamedNodeMap

Description

A DOM NamedNodeMap implementation

Located in /includes/domit/xml_domit_nodemaps.php (line 148)


	
			
Direct descendents
Class Description
DOMIT_NamedNodeMap_Attr A NamedNodeMap with specialized funtionality for Attribute nodes
Variable Summary
Array $arNodeMap
boolean $isDirty
Method Summary
Object &createClone ([boolean $deep = false])
string forHTML (string $str, [boolean $doPrint = false])
string getKeyNS (string $namespaceURI, string $localName)
int getLength ()
mixed &getNamedItem (string $name)
mixed &getNamedItemNS (string $namespaceURI, string $localName)
mixed &item (int $index)
void reindexNodeMap ()
mixed &removeNamedItem (string $name)
mixed &removeNamedItemNS (string $namespaceURI, string $localName)
Object &setNamedItem (Object &$arg)
Object &setNamedItemNS (Object &$arg)
Array toArray ()
string toString ([boolean $htmlSafe = false], [boolean $subEntities = false])
Variables
Array $arNodeMap = array() (line 150)
  • var: A container for the nodes in the map
Array $indexedNodeMap = array() (line 152)
  • var: A numerical index to the keys of the mapped nodes
boolean $isDirty = true (line 154)
  • var: True if the list has been modified and $indexedNodeMap needs reindexing
Methods
createClone (line 329)

Copies a node and/or its children

  • return: A copy of the node and/or its children
Object &createClone ([boolean $deep = false])
  • boolean $deep: True if all child nodes are also to be cloned
forHTML (line 311)

Formats a string for presentation as HTML

  • return: The HTML formatted string
string forHTML (string $str, [boolean $doPrint = false])
  • string $str: The string to be formatted
  • boolean $doPrint: True if the string is to be sent directly to output
getKeyNS (line 279)

Returns the key of the NamedNodeMap, given the namespaceURI and localName

  • return: The key of the NamedNodeMap
string getKeyNS (string $namespaceURI, string $localName)
  • string $namespaceURI: The namespaceURI of the node to be removed
  • string $localName: The localName of the node to be removed
getLength (line 301)

Returns the number of nodes in the map

  • return: The number of nodes in the map
int getLength ()
getNamedItem (line 161)

Gets a node with the specifed name

  • return: A reference to the requested node, or null
mixed &getNamedItem (string $name)
  • string $name: The name of the node
getNamedItemNS (line 224)

Gets a node with the specifed name, taking into account namespaces

  • return: A reference to the requested node, or null
mixed &getNamedItemNS (string $namespaceURI, string $localName)
  • string $namespaceURI: The namespaceURI of the node
  • string $localName: The localName of the node
item (line 292)

Return the node at the specified index

  • return: A reference to the requested node, or null
mixed &item (int $index)
  • int $index: The index of the requested node
reindexNodeMap (line 172)

Reindexes the numerical index for the named node map

void reindexNodeMap ()
removeNamedItem (line 206)

Removes a node from the list, by name

  • return: A reference to the removed node, or null
mixed &removeNamedItem (string $name)
  • string $name: The name of the node to be removed
removeNamedItemNS (line 260)

Removes a node from the list, by name, by local name and namespace URI

  • return: A reference to the removed node, or null
mixed &removeNamedItemNS (string $namespaceURI, string $localName)
  • string $namespaceURI: The namespaceURI of the node to be removed
  • string $localName: The localName of the node to be removed
setNamedItem (line 187)

Assigns a node to the list

  • return: A reference to the assigned node
Object &setNamedItem (Object &$arg)
  • Object &$arg: A reference to the node to be assigned
setNamedItemNS (line 239)

Assigns a node to the list, using its namespaceURI and localName

  • return: A reference to the assigned node
Object &setNamedItemNS (Object &$arg)
  • Object &$arg: A reference to the node to be assigned
toArray (line 320)

Generates an array representation of the node and its children

  • return: A representation of the node and its children
Array toArray ()

Redefined in descendants as:
toString (line 347)

Generates a string representation of the node and its children

  • return: The string representation
string toString ([boolean $htmlSafe = false], [boolean $subEntities = false])
  • boolean $htmlSafe: True if HTML readable output is desired
  • boolean $subEntities: True if illegal xml characters in text nodes and attributes should be converted to entities

Redefined in descendants as:

Documentation generated on Fri, 4 Mar 2005 13:57:42 +1000 by phpDocumentor 1.3.0RC3