Class DOMIT_Attr
A class representing the DOM Attribute (not present in DOMIT! Lite).

isPublic? yes
isAbstract? no

Inheritance tree:


DOMIT_Node
|
DOMIT_Attr

Known subclasses:

None

Source file: xml_domit_parser.php



Constructor
Initializes DOMIT_Attr variables and those of the superclass.

Signature: &DOMIT_Attr($name)

isPublic? no



Public Constants



Private Constants



Public Fields
nodeName
The key of the current node.

Type: String
nodeValue
The value of the current node. For DOMIT_Attr, this represents the text contained in the node.

Type: String
nodeType
An integer representing the type of the current node. For DOMIT_Attr, nodeType is 4.

Type: int
parentNode
A reference to the node of which the current node is a child.

Type: DOMIT_Node
previousSibling
A reference to the node prior to the current node in the childNodes list. Null if the current node is the first child.

Type: DOMIT_Node
nextSibling
A reference to the node after the current node in the childNodes list. Null if the current node is the last child.

Type: DOMIT_Node
ownerDocument
A reference to the DOMIT_Document. Null if the node has not yet been added to the document.

Type: DOMIT_Document



Private Fields
uid
A unique id assigned to each node. Note that this id is non-persistent.

Type: int



Public Methods
getName
Returns the Attribute key.

Signature: getName()

Returns:

String - The Attribute key.

Example:

The key of the attribute is returned:

$myKey = $myAttr->getName();
getValue
Returns the Attribute value.

Signature: getValue()

Returns:

String - The Attribute value.

Example:

The value of the attribute is returned:

$myValue = $myAttr->getValue();
setValue
Sets the Attribute value.

Signature: setValue($value)

Parameters:

String value - The new value for the Attribute.

Example:

The attribute is given a new value of "12345":

$myAttr->setValue("12345");
cloneNode
Returns a copy of the specified node, and if $deep is set to true, all nodes below it in the hierarchy.

Signature: &cloneNode($deep)

Parameters:

boolean deep - True if the children below the cloned node are also to be cloned.

Returns:

DOMIT_Node - The cloned node, with a clone of all subnodes if $deep is set to true.

Example:

In the following example, a node named $styleTemplate is cloned, presumably so the user can create a new style based on the characteristics of the original node.

$newStyle =& styleTemplate->cloneNode(false);
toString
Generates an unformatted (single line, no whitespace) string representation of the attribute.

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

Parameters:

boolean htmlSafe - If true, returns an html formatted representation of the string.

boolean subEntities - True if illegal xml characters should be converted to entities.

Returns:

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

Example:

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

echo ($myAttr->toString(true);



Private Methods
toArray
Returns an array representation of the attributes.

Signature: toArray()

Returns:

array - An array of name / value pairs.

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