Class: xml_domit_rss_collection

Source Location: /libraries/domit/xml_domit_rss_shared.php

Class xml_domit_rss_collection

Class Overview

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

Located in /libraries/domit/xml_domit_rss_shared.php [line 155]

xml_domit_rss_base
   |
   --xml_domit_rss_elementindexer
      |
      --xml_domit_rss_collection

Author(s):

John Heinstein <johnkarl@nbnet.nb.ca>

Information Tags:

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From xml_domit_rss_elementindexer

xml_domit_rss_elementindexer::$DOMIT_RSS_indexer

xml_domit_rss_elementindexer::$DOMIT_RSS_numericalIndexer

Inherited From xml_domit_rss_base

xml_domit_rss_base::$node

xml_domit_rss_base::$rssDefinedElements

Inherited From xml_domit_rss_elementindexer

xml_domit_rss_elementindexer::addIndexedElement()

Adds a custom element (one not defined by the RSS specs, e..g., dc:creator) to the indexer

xml_domit_rss_elementindexer::getElement()

Gets a reference to an element with the specified name

xml_domit_rss_elementindexer::getElementAt()

Gets a reference to an element at the specified index

xml_domit_rss_elementindexer::getElementList()

Gets a named list of existing elements as a child of the current element

xml_domit_rss_elementindexer::getElementText()

Gets the text of the specified element

xml_domit_rss_elementindexer::getElementTextAt()

Gets the text at the specified index

xml_domit_rss_elementindexer::hasElement()

Indicates whether a particular element exists

xml_domit_rss_elementindexer::indexNumerically()

Populates an integer-based index for elements if one isn't already present.

xml_domit_rss_elementindexer::isCollection()

Indicates whether the requested element is actually a collection of elements of the same type

xml_domit_rss_elementindexer::isCustomRSSElement()

Indicates whether the requested element is a DOMIT! node (alias for isNode)

xml_domit_rss_elementindexer::isNode()

Indicates whether the requested element is a DOMIT! node

xml_domit_rss_elementindexer::_getElementText()

Gets the text at the specified index

xml_domit_rss_elementindexer::_init()

Performs generic initialization of elements

Inherited From xml_domit_rss_base

xml_domit_rss_base::get()

Generates a string representation of the node and its children

xml_domit_rss_base::getAttribute()

Retrieves the text of the named attribute, checking first if the attribute exists

xml_domit_rss_base::getNode()

Retrieves the underlying DOMIT node

xml_domit_rss_base::hasAttribute()

Checks whether the named attribute exists

xml_domit_rss_base::isRSSDefined()

Tests whether the named element is predefined by the RSS spec

xml_domit_rss_base::isSimpleRSSElement()

Tests whether the named element has a single child text node

xml_domit_rss_base::toNormalizedString()

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

[ Top ]

Property Summary

int	$elementCount
array	$elements

[ Top ]

Method Summary

void	addElement()	Adds a custom RSS element (DOM node) to the collection
Object	&getElement()	Retrieves the element at the specified index (alias for getElementAt)
Object	&getElementAt()	Retrieves the element at the specified index
int	getElementCount()	Returns the number of elements in the collection
string	getElementText()	Gets a text representation of the collection (applies the toString method to each member and concatenates)

[ Top ]

Properties

int $elementCount = 0 [line 159]

[ Top ]

array $elements = array() [line 157]

[ Top ]

Methods

addElement [line 165]

void addElement(
Object
&$node 
)

Adds a custom RSS element (DOM node) to the collection

Parameters:

Object

&$node:

A DOM node representing a custom RSS element

[ Top ]

getElement [line 184]

Object &getElement(
int
$index 
)

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

Parameters:

int

$index:

The index of the requested custom RSS element

API Tags:

Return:

The DOMIT node representing the requested element

Redefinition of:

xml_domit_rss_elementindexer::getElement(): Gets a reference to an element with the specified name

[ Top ]

getElementAt [line 175]

Object &getElementAt(
int
$index 
)

Retrieves the element at the specified index

Parameters:

int

$index:

The index of the requested custom RSS element

API Tags:

Return:

The DOMIT node representing the requested element

Redefinition of:

xml_domit_rss_elementindexer::getElementAt(): Gets a reference to an element at the specified index

[ Top ]

getElementCount [line 192]

int getElementCount(
)

Returns the number of elements in the collection

API Tags:

Return:

The number of members in the collection

[ Top ]

getElementText [line 200]

string getElementText(
)

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

API Tags:

Return:

The element text

Redefinition of:

xml_domit_rss_elementindexer::getElementText(): Gets the text of the specified element

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

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

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