Class xml_domit_rss_channel

Description

Represents an RSS channel

Located in /includes/domit/xml_domit_rss.php (line 202)

xml_domit_rss_base
   |
   --xml_domit_rss_elementindexer
      |
      --xml_domit_rss_channel
Variable Summary
Method Summary
xml_domit_rss_channel xml_domit_rss_channel (Object &$channel, [boolean $externalElements = false])
Object &getCategory (int $index)
string getDescription ()
Object &getItem (int $index)
int getItemCount ()
string getLink ()
string getTitle ()
void _init ()
Variables
array $domit_rss_categories = array() (line 206)
  • var: A list of references to category items
array $domit_rss_items = array() (line 204)
  • var: A list of references to channel items

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
Constructor xml_domit_rss_channel (line 213)

Constructor

xml_domit_rss_channel xml_domit_rss_channel (Object &$channel, [boolean $externalElements = false])
  • Object &$channel: A DOM node containing channel data
  • boolean $externalElements: True if channel elements are siblings of the channel rather than children
getCategory (line 339)

Returns a reference to the category at the specified index

  • return: A reference to the category at the specified index
Object &getCategory (int $index)
  • int $index: The index of the requested category
getCategoryCount (line 330)

Returns the number of categories in the channel

  • return: The number of categories in the channel
int getCategoryCount ()
getDescription (line 305)

Returns a description of the channel

  • return: A description of the channel, or an empty string
string getDescription ()
getItem (line 322)

Returns a reference to the item at the specified index

  • return: A reference to the item at the specified index
Object &getItem (int $index)
  • int $index: The index of the requested item
getItemCount (line 313)

Returns the number of items in the channel

  • return: The number of items in the channel
int getItemCount ()
getLink (line 297)

Returns the url of the channel

  • return: The url of the channel, or an empty string
string getLink ()
getTitle (line 289)

Returns the title of the channel

  • return: The title of the channel, or an empty string
string getTitle ()
_init (line 226)

Performs initialization of the RSS channel element

void _init ()

Redefinition of:
xml_domit_rss_elementindexer::_init()
Performs generic initialization of elements

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:52 +1000 by phpDocumentor 1.3.0RC3