Class: DOMIT_CharacterData

Source Location: /libraries/domit/xml_domit_parser.php

Class DOMIT_CharacterData

Class Overview

A parent class for Text and CDATA Section nodes

Located in /libraries/domit/xml_domit_parser.php [line 2498]

DOMIT_Node
   |
   --DOMIT_CharacterData

Author(s):

John Heinstein <johnkarl@nbnet.nb.ca>

Information Tags:

Methods

[ Top ]

Descendants

Child Class	Description
DOMIT_TextNode	A class representing the DOM Text Node
DOMIT_Comment	A class representing the DOM Comment node

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DOMIT_Node

DOMIT_Node::$attributes

DOMIT_Node::$childCount

DOMIT_Node::$childNodes

DOMIT_Node::$firstChild

DOMIT_Node::$lastChild

DOMIT_Node::$localName

DOMIT_Node::$namespaceURI

DOMIT_Node::$nextSibling

DOMIT_Node::$nodeName

DOMIT_Node::$nodeType

DOMIT_Node::$nodeValue

DOMIT_Node::$ownerDocument

DOMIT_Node::$parentNode

DOMIT_Node::$prefix

DOMIT_Node::$previousSibling

DOMIT_Node::$uid

Inherited From DOMIT_Node

DOMIT_Node::DOMIT_Node()

Raises error if abstract class is directly instantiated

DOMIT_Node::appendChild()

Appends a node to the childNodes list of the current node

DOMIT_Node::clearReferences()

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

DOMIT_Node::cloneNode()

Copies a node and/or its children

DOMIT_Node::delete()

Removes the node from the document

DOMIT_Node::forHTML()

Formats a string for presentation as HTML

DOMIT_Node::getChildNodeIndex()

Returns the index of the specified node in a childNodes list

DOMIT_Node::getElementsByAttributePath()

Retrieves an element or DOMIT_NodeList of elements corresponding to an Xpath-like attribute expression (NOT YET IMPLEMENTED!)

DOMIT_Node::getElementsByPath()

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

DOMIT_Node::getNamedElements()

Adds elements with the specified tag name to a NodeList collection

DOMIT_Node::getText()

Returns the concatented text of the current node and its children

DOMIT_Node::getTypedNodes()

Adds all child nodes of the specified nodeType to the NodeList

DOMIT_Node::getValuedNodes()

Adds all child nodes of the specified nodeValue to the NodeList

DOMIT_Node::hasAttributes()

Determines whether a node has any attributes

DOMIT_Node::hasChildNodes()

Determines whether a node has any children

DOMIT_Node::insertBefore()

Inserts a node to the childNodes list of the current node

DOMIT_Node::isSupported()

Indicates whether the specified feature is supported by the DOM implementation and this node

DOMIT_Node::normalize()

Collapses adjacent text nodes in entire node subtree

DOMIT_Node::nvl()

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

DOMIT_Node::onLoad()

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

DOMIT_Node::removeChild()

Removes a node from the childNodes list of the current node

DOMIT_Node::replaceChild()

Replaces a node with another

DOMIT_Node::setOwnerDocument()

Sets the ownerDocument property of a node to the containing DOMIT_Document

DOMIT_Node::toArray()

Generates an array representation of the node and its children

DOMIT_Node::toNormalizedString()

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

DOMIT_Node::_constructor()

DOMIT_Node constructor, assigns a uid

[ Top ]

Method Summary

DOMIT_CharacterData	DOMIT_CharacterData()	Prevents direct instantiation of DOMIT_CharacterData class
void	appendData()	Appends the specified text to the current node text
void	deleteData()	Deletes a subset of the current node text
string	getData()	Gets the node value of the current text node
int	getLength()	Gets the length of the text in the current node
void	insertData()	Inserts text at the sepecified offset
void	replaceData()	Replaces a subset of the current node text with the specified text
void	setData()	Sets the text contained in the current node to $data.
string	substringData()	Gets a subset of the current node text

[ Top ]

Properties

Methods

Constructor DOMIT_CharacterData [line 2503]

DOMIT_CharacterData DOMIT_CharacterData(
)

Prevents direct instantiation of DOMIT_CharacterData class

API Tags:

Abstract:

[ Top ]

appendData [line 2558]

void appendData(
string
$arg 
)

Appends the specified text to the current node text

Parameters:

string

$arg:

The text to be appended

[ Top ]

deleteData [line 2590]

void deleteData(
int
$offset, int
$count 
)

Deletes a subset of the current node text

Parameters:

int	$offset:	The starting point of the deletion
int	$count:	The length of the deletion

[ Top ]

getData [line 2512]

string getData(
)

Gets the node value of the current text node

API Tags:

Return:

The node value of the current text node

[ Top ]

getLength [line 2529]

int getLength(
)

Gets the length of the text in the current node

API Tags:

Return:

The length of the text in the current node

[ Top ]

insertData [line 2567]

void insertData(
int
$offset, string
$arg 
)

Inserts text at the sepecified offset

Parameters:

int	$offset:	The insertion point
string	$arg:	The text to be inserted

[ Top ]

replaceData [line 2614]

void replaceData(
int
$offset, int
$count, string
$arg 
)

Replaces a subset of the current node text with the specified text

Parameters:

int	$offset:	The starting point of the replacement
int	$count:	The length of the replacement
string	$arg:	The replacement text

[ Top ]

setData [line 2520]

void setData(
string
$data 
)

Sets the text contained in the current node to $data.

Parameters:

string

$data:

The text data of the node

[ Top ]

substringData [line 2539]

string substringData(
int
$offset, int
$count 
)

Gets a subset of the current node text

Parameters:

int	$offset:	The starting point of the substring
int	$count:	The length of the substring

API Tags:

Return:

The subset of the current node text

[ 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:24:33 -0200 by phpDocumentor 1.4.3

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

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