Class xml_domit_rss_collection
Represents a collection of custom RSS elements, e.g. a set of dc:creator entries.

isPublic? no
isAbstract? yes

Inheritance tree:


xml_domit_rss_base
|
xml_domit_rss_elementindexer
|
xml_domit_rss_collection

Known subclasses:

None

Source file: xml_domit_rss_shared.php




Constructor



Public Constants



Private Constants



Public Fields



Private Fields
elements
An array holding the collection of custom elements.

Type: array

elementCount
The number of custom elements in the collection.

Type: int




Public Methods
getElementAt
Retrieves the element at the specified index.

Signature: &getElementAt($index)

Parameters:

int index - The index of the requested custom RSS element.

Returns:

DOMIT_Node - The DOMIT node representing the requested element.

Example:

Returns the second DOMIT node in the collection.

$myNode =& $myCollection->getElementAt(1);

getElement
Retrieves the element at the specified index (alias for getElementAt).

Signature: &getElement($index)

Parameters:

int index - The index of the requested custom RSS element.

Returns:

DOMIT_Node - The DOMIT node representing the requested element.

Example:

Returns the second DOMIT node in the collection.

$myNode =& $myCollection->getElement(1);

getElementCount
Returns the number of elements in the collection.

Signature: getElementCount()

Returns:

int - The number of elements in the collection.

Example:

Returns the number of elements in the collection.

$numItems =& $myCollection->getElementCount();

getElementText
Gets a text representation of the collection (applies the toString method to each member and concatenates).

Signature: getElementText()

Returns:

int - A text representation of the collection .

Example:

Returns a text representation of the collection .

$text =& $myCollection->getElementText();




Private Methods
addElement
Adds a custom RSS element to the collection.

Signature: addElement(&$node)

Parameters:

DOMIT_Node node - A DOMIT node representing a custom RSS element.


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