Class xml_domit_rss_elementindexer

Description

Provides indexing functionality to RSS classes

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

xml_domit_rss_base
   |
   --xml_domit_rss_elementindexer
Direct descendents
Class Description
xml_domit_rss_channel Represents an RSS channel
xml_domit_rss_item Represents an RSS item
xml_domit_rss_category Represents an RSS category
xml_domit_rss_image Represents an RSS image
xml_domit_rss_textinput Represents an RSS text input form
xml_domit_rss_cloud Represents an RSS cloud
xml_domit_rss_enclosure Represents an RSS enclosure
xml_domit_rss_guid Represents an RSS guid
xml_domit_rss_source Represents an RSS source
xml_domit_rss_channel_lite Represents an RSS channel
xml_domit_rss_item_lite Represents an RSS item
xml_domit_rss_collection Represents a collection of custom RSS elements, e.g. a set of dc:creator entries
xml_domit_rss_base_document A base class for DOMIT! RSS and DOMIT! RSS Lite documents
xml_domit_rss_simpleelement Represents a simple RSS element, without attributes and only a single child text node
Variable Summary
Method Summary
void addIndexedElement (Object &$node)
mixed &getElement (string $elementName)
mixed &getElementAt (int $index)
array getElementList ()
string getElementText (string $elementName)
string getElementTextAt (int $index)
boolean hasElement (string $elementName)
boolean isCollection (string $elementName)
boolean isCustomRSSElement (string $elementName)
boolean isNode (string $elementName)
string _getElementText (mixed $index, array &$myArray)
void _init ()
Variables
Array $DOMIT_RSS_indexer = array() (line 214)
  • var: Name based index to RSS elements
Array $DOMIT_RSS_numericalIndexer (line 216)
  • var: Numerical index to RSS elements; for optimization purposes, only set if requested by getElementAt

Inherited Variables

Inherited from xml_domit_rss_base

xml_domit_rss_base::$node
xml_domit_rss_base::$rssDefinedElements
Methods
addIndexedElement (line 235)

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

void addIndexedElement (Object &$node)
  • Object &$node: A DOMIT! node representing the custom element
getElement (line 318)

Gets a reference to an element with the specified name

  • return: A reference to an element with the specified name, or the text of the element if it is a text node
mixed &getElement (string $elementName)
  • string $elementName: The name of the requested element

Redefined in descendants as:
getElementAt (line 335)

Gets a reference to an element at the specified index

  • return: A reference to an element at the specified index, or the text of the element if it is a text node
mixed &getElementAt (int $index)
  • int $index: The index of the requested element

Redefined in descendants as:
getElementList (line 300)

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

  • return: A named list of existing elements
array getElementList ()
getElementText (line 366)

Gets the text of the specified element

  • return: The element text, or an empty string
string getElementText (string $elementName)
  • string $elementName: The name of the requested element

Redefined in descendants as:
getElementTextAt (line 375)

Gets the text at the specified index

  • return: The element text, or an empty string
string getElementTextAt (int $index)
  • int $index: The index of the requested element
hasElement (line 309)

Indicates whether a particular element exists

  • return: True if an element with the specified name exists
boolean hasElement (string $elementName)
  • string $elementName: The name of the requested element
indexNumerically (line 350)

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

void indexNumerically ()
isCollection (line 260)

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

  • return: True if a collection of elements exists
boolean isCollection (string $elementName)
  • string $elementName: The name of the requested element
isCustomRSSElement (line 292)

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

  • return: True if the requested element is a DOMIT! node
boolean isCustomRSSElement (string $elementName)
  • string $elementName: The name of the requested element
isNode (line 276)

Indicates whether the requested element is a DOMIT! node

  • return: True if the requested element is a DOMIT! node
boolean isNode (string $elementName)
  • string $elementName: The name of the requested element
_getElementText (line 387)

Gets the text at the specified index

  • return: The element text, or an empty string
string _getElementText (mixed $index, array &$myArray)
  • mixed $index: The index or name of the requested element
  • array &$myArray: The indexing array from which to extract data
_init (line 221)

Performs generic initialization of elements

void _init ()

Redefined in descendants as:

Inherited Methods

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