Class: DOMIT_TextNode

Source Location: /libraries/domit/xml_domit_parser.php

Class DOMIT_TextNode

Class Overview

A class representing the DOM Text Node

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

DOMIT_Node
   |
   --DOMIT_CharacterData
      |
      --DOMIT_TextNode

Author(s):

John Heinstein <johnkarl@nbnet.nb.ca>

Information Tags:

Methods

[ Top ]

Descendants

Child Class	Description
DOMIT_CDATASection	A class representing the DOM CDATA Section

[ 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_CharacterData

DOMIT_CharacterData::DOMIT_CharacterData()

Prevents direct instantiation of DOMIT_CharacterData class

DOMIT_CharacterData::appendData()

Appends the specified text to the current node text

DOMIT_CharacterData::deleteData()

Deletes a subset of the current node text

DOMIT_CharacterData::getData()

Gets the node value of the current text node

DOMIT_CharacterData::getLength()

Gets the length of the text in the current node

DOMIT_CharacterData::insertData()

Inserts text at the sepecified offset

DOMIT_CharacterData::replaceData()

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

DOMIT_CharacterData::setData()

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

DOMIT_CharacterData::substringData()

Gets a subset of the current node text

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_TextNode	DOMIT_TextNode()	DOM Text Node constructor
Object	&cloneNode()	Copies a node and/or its children
string	getText()	Returns the text contained in the current node
void	setText()	Sets the text contained in the current node to $data.
Object	&splitText()	Splits a single node into multiple nodes, based on the specified offset
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_TextNode [line 2645]

DOMIT_TextNode DOMIT_TextNode(
string
$data 
)

DOM Text Node constructor

Parameters:

string

$data:

The text of the node

[ Top ]

cloneNode [line 2718]

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_Node::cloneNode(): Copies a node and/or its children

[ Top ]

getText [line 2656]

string getText(
)

Returns the text contained in the current node

API Tags:

Return:

The text of the current node

Redefinition of:

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

[ Top ]

setText [line 2664]

void setText(
string
$data 
)

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

Parameters:

string

$data:

The text data of the node

[ Top ]

splitText [line 2673]

Object &splitText(
int
$offset 
)

Splits a single node into multiple nodes, based on the specified offset

Parameters:

int

$offset:

The offset point for the split

API Tags:

Return:

The newly created text node

[ Top ]

toArray [line 2709]

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_Node::toArray(): Generates an array representation of the node and its children

[ Top ]

toString [line 2731]

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 should be converted to entities

API Tags:

Return:

The string representation

Redefined in descendants as:

DOMIT_CDATASection::toString() : Generates a string representation of the node and its children

[ 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:39 -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 ]