Class DOMIT_NamedNodeMap_Attr
Provides a container for an unordered list of Attr nodes that can be accessed by their nodeNames.

isPublic? yes
isAbstract? no

Inheritance tree:


DOMIT_NamedNodeMap
|
DOMIT_NamedNodeMap_Attr

Known subclasses:

None

Source file: xml_domit_nodemaps.php




Constructor



Public Constants



Private Constants



Public Fields



Private Fields
arNodeMap
An associative array containing the list of DOMIT_Nodes.

Type: array




Public Methods
item
Returns the node at the specified index (0-based).

Signature: &item($index)

Parameters:

int index - The index of the DOMIT_Node to be returned.

Returns:

DOMIT_Node - The DOMIT_Node at the index specified, or null if nothing is found at that location.

Example:

The third node in the node list is returned:

$thirdNode =& myNodeList->item(2);

getLength
Returns the number of nodes in the node map.

Signature: getLength()

Returns:

int - The number of nodes in the node map.

Example:

The number of nodes in the node map are returned:

$numNodes = myNodeMap->getLength();

getNamedItem
Gets the node with the specified nodeName from the list, or returns null.

Signature: &getNamedItem($name)

Parameters:

String node - The name of the node to be retrieved.

Returns:

DOMIT_Node - The node to be returned.

Example:

A node named "param" is returned from $myNodeMap:

$returnedNode =& myNodeMap->getNamedItem("param");

setNamedItem
Adds the specified node to the node map, using its nodeName as key. Overwrites an existing named item.

Signature: &setNamedItem(&$arg)

Parameters:

DOMIT_Node arg - The node to be added.

Returns:

DOMIT_Node - Null, or the node that was overwritten if this is the case.

Example:

A node is added to $myNodeMap:

myNodeMap->setNamedItem($aNode);

removeNamedItem
Removes the node with the specified nodeName from the node map.

Signature: &removeNamedItem($name)

Parameters:

String name - The nodeName of the node to be removed.

Returns:

DOMIT_Node - The node that was just removed, or null if it wasn't found.

Example:

A node named "param" is removed from $myNodeMap:

$returnedNode =& myNodeMap->removeNamedItem("param");

toArray
Returns an associative array representing the attributes list.

Signature: toArray()

Returns:

array - An associative array representing the attributes list.

Example:

Prints out an associative array representing the attributes list.

print_r($myElement->attributes->toArray());

forHTML
Formats a string for presentation as HTML.

Signature: forHTML($str, $doPrint = false)

Parameters:

String str - The string to be formatted.

boolean doPrint - True if the string is to be sent directly to output.

Returns:

String - The HTML formatted string.

toString
Generates an unformatted (single line, no whitespace) string representation of the NamedNodeMap.

Signature: toString($htmlSafe = false, $subEntities=false)

Parameters:

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.

Returns:

String - An unformatted (single line, no whitespace) string representation of the NamedNodeMap.

Example:

An unformatted string representation of the NamedNodeMap will be printed here:

echo (htmlentities($myNodeMap->toString());




Private Methods
createClone
Used by cloneNode() to generate a new instance of a DOMIT_NamedNodeMap containing the same data as the original.

Signature: &createClone($deep)

Parameters:

boolean deep - True if all subnodes are to be cloned.

Returns:

DOMIT_NamedNodeMap - A new DOMIT_NamedNodeMap


Documentation generated by ClassyDoc, using the DOMIT! and SAXY parsers.
Please visit Engage Interactive to download free copies.