Class xml_domit_rss_collection

Description

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

Located in /includes/domit/xml_domit_rss_shared.php (line 148)

xml_domit_rss_base
   |
   --xml_domit_rss_elementindexer
      |
      --xml_domit_rss_collection
Variable Summary
Method Summary
void addElement (Object &$node)
Object &getElement (int $index)
Object &getElementAt (int $index)
string getElementText ()
Variables
int $elementCount = 0 (line 152)
  • var: The number of custom elements in the collection
array $elements = array() (line 150)
  • var: An array holding the collection of custom elements

Inherited Variables

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
Methods
addElement (line 158)

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

void addElement (Object &$node)
  • Object &$node: A DOM node representing a custom RSS element
getElement (line 177)

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

  • return: The DOMIT node representing the requested element
Object &getElement (int $index)
  • int $index: The index of the requested custom RSS element

Redefinition of:
xml_domit_rss_elementindexer::getElement()
Gets a reference to an element with the specified name
getElementAt (line 168)

Retrieves the element at the specified index

  • return: The DOMIT node representing the requested element
Object &getElementAt (int $index)
  • int $index: The index of the requested custom RSS element

Redefinition of:
xml_domit_rss_elementindexer::getElementAt()
Gets a reference to an element at the specified index
getElementCount (line 185)

Returns the number of elements in the collection

  • return: The number of members in the collection
int getElementCount ()
getElementText (line 193)

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

  • return: The element text
string getElementText ()

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

Inherited Methods

Inherited From xml_domit_rss_elementindexer

xml_domit_rss_elementindexer::addIndexedElement()
xml_domit_rss_elementindexer::getElement()
xml_domit_rss_elementindexer::getElementAt()
xml_domit_rss_elementindexer::getElementList()
xml_domit_rss_elementindexer::getElementText()
xml_domit_rss_elementindexer::getElementTextAt()
xml_domit_rss_elementindexer::hasElement()
xml_domit_rss_elementindexer::indexNumerically()
xml_domit_rss_elementindexer::isCollection()
xml_domit_rss_elementindexer::isCustomRSSElement()
xml_domit_rss_elementindexer::isNode()
xml_domit_rss_elementindexer::_getElementText()
xml_domit_rss_elementindexer::_init()

Inherited From xml_domit_rss_base

xml_domit_rss_base::getAttribute()
xml_domit_rss_base::getNode()
xml_domit_rss_base::hasAttribute()
xml_domit_rss_base::isRSSDefined()
xml_domit_rss_base::isSimpleRSSElement()
xml_domit_rss_base::toNormalizedString()
xml_domit_rss_base::toString()

Documentation generated on Fri, 4 Mar 2005 13:57:59 +1000 by phpDocumentor 1.3.0RC3