Class: DOMIT_Lite_Element

Source Location: /includes/domit/xml_domit_lite_parser.php

Class DOMIT_Lite_Element

Class Overview

A class representing the DOM Element

Located in /includes/domit/xml_domit_lite_parser.php [line 1299]

DOMIT_Lite_Node
   |
   --DOMIT_Lite_ChildNodes_Interface
      |
      --DOMIT_Lite_Element

Author(s):

John Heinstein <johnkarl@nbnet.nb.ca>

Information Tags:

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DOMIT_Lite_Node

DOMIT_Lite_Node::$attributes

DOMIT_Lite_Node::$childCount

DOMIT_Lite_Node::$childNodes

DOMIT_Lite_Node::$firstChild

DOMIT_Lite_Node::$lastChild

DOMIT_Lite_Node::$nextSibling

DOMIT_Lite_Node::$nodeName

DOMIT_Lite_Node::$nodeType

DOMIT_Lite_Node::$nodeValue

DOMIT_Lite_Node::$ownerDocument

DOMIT_Lite_Node::$parentNode

DOMIT_Lite_Node::$previousSibling

DOMIT_Lite_Node::$uid

Inherited From DOMIT_Lite_ChildNodes_Interface

DOMIT_Lite_ChildNodes_Interface::DOMIT_Lite_ChildNodes_Interface()

Raises error if abstract class is directly instantiated

DOMIT_Lite_ChildNodes_Interface::appendChild()

Appends a node to the childNodes list of the current node

DOMIT_Lite_ChildNodes_Interface::getElementsByAttribute()

Searches the element tree for an element with the specified attribute name and value.

DOMIT_Lite_ChildNodes_Interface::insertBefore()

Inserts a node to the childNodes list of the current node

DOMIT_Lite_ChildNodes_Interface::removeChild()

Removes a node from the childNodes list of the current node

DOMIT_Lite_ChildNodes_Interface::replaceChild()

Replaces a node with another

DOMIT_Lite_ChildNodes_Interface::_getElementsByAttribute()

Searches the element tree for an element with the specified attribute name and value.

Inherited From DOMIT_Lite_Node

DOMIT_Lite_Node::DOMIT_Lite_Node()

Raises error if abstract class is directly instantiated

DOMIT_Lite_Node::appendChild()

Appends a node to the childNodes list of the current node

DOMIT_Lite_Node::clearReferences()

Clears previousSibling, nextSibling, and parentNode references from a node that has been removed

DOMIT_Lite_Node::cloneNode()

Copies a node and/or its children

DOMIT_Lite_Node::forHTML()

Formats a string for presentation as HTML

DOMIT_Lite_Node::getChildNodeIndex()

Returns the index of the specified node in a childNodes list

DOMIT_Lite_Node::getElementsByPath()

Retrieves an element or DOMIT_NodeList of elements corresponding to an Xpath-like expression.

DOMIT_Lite_Node::getNamedElements()

Adds elements with the specified tag name to a NodeList collection

DOMIT_Lite_Node::getText()

Returns the concatented text of the current node and its children

DOMIT_Lite_Node::hasChildNodes()

Determines whether a node has any children

DOMIT_Lite_Node::insertBefore()

Inserts a node to the childNodes list of the current node

DOMIT_Lite_Node::nvl()

Tests whether a value is null, and if so, returns a default value

DOMIT_Lite_Node::onLoad()

A node event that can be set to fire upon document loading, used for node initialization

DOMIT_Lite_Node::removeChild()

Removes a node from the childNodes list of the current node

DOMIT_Lite_Node::replaceChild()

Replaces a node with another

DOMIT_Lite_Node::setOwnerDocument()

Sets the ownerDocument property of a node to the containing DOMIT_Document

DOMIT_Lite_Node::toArray()

Generates an array representation of the node and its children

DOMIT_Lite_Node::toNormalizedString()

Generates a normalized (formatted for readability) representation of the node and its children

DOMIT_Lite_Node::_constructor()

DOMIT_Lite_Node constructor, assigns a uid

[ Top ]

Method Summary

DOMIT_Lite_Element	DOMIT_Lite_Element()	DOM Element constructor
Object	&cloneNode()	Copies a node and/or its children
string	getAttribute()	Gets the value of the specified attribute, if it exists
mixed	&getElementsByPath()	Retrieves an element or DOMIT_NodeList of elements corresponding to an Xpath-like expression.
Object	&getElementsByTagName()	Retrieves a NodeList of child elements with the specified tag name
void	getNamedElements()	Adds elements with the specified tag name to a NodeList collection
string	getTagName()	Returns the tag name of the element
string	getText()	Returns the concatented text of the current node and its children
boolean	hasAttribute()	Determines whether an attribute with the specified name exists
void	normalize()	Collapses adjacent text nodes in entire element subtree
void	removeAttribute()	Removes the specified attribute
void	setAttribute()	Sets the value of the specified attribute; creates a new attribute if one doesn't exist
void	setText()	If a child text node exists, sets the nodeValue to $data. A child text node is created if none exists
Array	toArray()	Generates an array representation of the node and its children
string	toString()	Generates a string representation of the node and its children

[ Top ]

Properties

Methods

Constructor DOMIT_Lite_Element [line 1304]

DOMIT_Lite_Element DOMIT_Lite_Element(
string
$tagName 
)

DOM Element constructor

Parameters:

string

$tagName:

The tag name of the element

[ Top ]

cloneNode [line 1495]

Object &cloneNode(
[boolean
$deep = false] 
)

Copies a node and/or its children

Parameters:

boolean

$deep:

True if all child nodes are also to be cloned

API Tags:

Return:

A copy of the node and/or its children

Redefinition of:

DOMIT_Lite_Node::cloneNode(): Copies a node and/or its children

[ Top ]

getAttribute [line 1407]

string getAttribute(
string
$name 
)

Gets the value of the specified attribute, if it exists

Parameters:

string

$name:

The attribute name

API Tags:

Return:

The attribute value

[ Top ]

getElementsByPath [line 1393]

mixed &getElementsByPath(
string
$pattern, [int
$nodeIndex = 0] 
)

Retrieves an element or DOMIT_NodeList of elements corresponding to an Xpath-like expression.

Parameters:

string	$pattern:	The query pattern
int	$nodeIndex:	If a single node is to be returned (rather than the entire NodeList) the index of that node

API Tags:

Return:

A NodeList or single node that matches the pattern

Redefinition of:

DOMIT_Lite_Node::getElementsByPath(): Retrieves an element or DOMIT_NodeList of elements corresponding to an Xpath-like expression.

[ Top ]

getElementsByTagName [line 1380]

Object &getElementsByTagName(
string
$tagName 
)

Retrieves a NodeList of child elements with the specified tag name

Parameters:

string

$tagName:

The matching element tag name

API Tags:

Return:

A NodeList of found elements

[ Top ]

getNamedElements [line 1325]

void getNamedElements(
Object
&$nodeList, string
$tagName 
)

Adds elements with the specified tag name to a NodeList collection

Parameters:

Object	&$nodeList:	The NodeList collection
string	$tagName:	The tag name of matching elements

Redefinition of:

DOMIT_Lite_Node::getNamedElements(): Adds elements with the specified tag name to a NodeList collection

[ Top ]

getTagName [line 1316]

string getTagName(
)

Returns the tag name of the element

API Tags:

Return:

The tag name of the element

[ Top ]

getText [line 1341]

string getText(
)

Returns the concatented text of the current node and its children

API Tags:

Return:

The concatented text of the current node and its children

Redefinition of:

DOMIT_Lite_Node::getText(): Returns the concatented text of the current node and its children

[ Top ]

hasAttribute [line 1445]

boolean hasAttribute(
string
$name 
)

Determines whether an attribute with the specified name exists

Parameters:

string

$name:

The name of the attribute

API Tags:

Return:

True if the attribute exists

[ Top ]

normalize [line 1452]

void normalize(
)

Collapses adjacent text nodes in entire element subtree

[ Top ]

removeAttribute [line 1434]

void removeAttribute(
string
$name 
)

Removes the specified attribute

Parameters:

string

$name:

The name of the attribute to be removed

[ Top ]

setAttribute [line 1426]

void setAttribute(
string
$name, string
$value 
)

Sets the value of the specified attribute; creates a new attribute if one doesn't exist

Parameters:

string	$name:	The attribute name
string	$value:	The desired attribute value

[ Top ]

setText [line 1357]

void setText(
string
$data 
)

If a child text node exists, sets the nodeValue to $data. A child text node is created if none exists

Parameters:

string

$data:

The text data of the node

[ Top ]

toArray [line 1479]

Array toArray(
)

Generates an array representation of the node and its children

API Tags:

Return:

A representation of the node and its children

Redefinition of:

DOMIT_Lite_Node::toArray(): Generates an array representation of the node and its children

[ Top ]

toString [line 1519]

string toString(
[boolean
$htmlSafe = false], [boolean
$subEntities = false] 
)

Generates a string representation of the node and its children

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

API Tags:

Return:

The string representation

[ Top ]

The site fititnt.org is not affiliated with or endorsed by the Joomla! Project or Open Source Matters. If you are looking for official documentation, visit api.joomla.org and docs.joomla.org.

Documentation generated on Mon, 26 Oct 2009 22:56:40 -0200 by phpDocumentor 1.4.3

Visit fititnt.org, and look for some extension or more Joomla Framework info	domit-xmlparser domit-xmlparser-lite

[ class tree: domit-xmlparser ] [ index: domit-xmlparser ] [ all elements ]