Class xml_domit_rss_channel
Represents an RSS channel.

isPublic? yes
isAbstract? no

Inheritance tree:


xml_domit_rss_base
|
xml_domit_rss_elementindexer
|
xml_domit_rss_channel

Known subclasses:

None

Source file: xml_domit_rss.php




Constructor
Instantiates a new xml_domit_rss_channel.

Signature: xml_domit_rss_channel(&$channel, $externalElements = false)

isPublic? yes




Public Constants



Private Constants



Public Fields



Private Fields
domit_rss_items
A list of references to channel items.

Type: Array

domit_rss_categories
A list of references to category items.

Type: Array




Public Methods
getTitle
Returns the title of the channel.

Signature: getTitle()

Returns:

String - The title of the channel, or an empty string.

Example:

Returns the title of the channel.

$title = $myChannel->getTitle();

getLink
Returns the url of the channel.

Signature: getLink()

Returns:

String - The url of the channel, or an empty string.

Example:

Returns the url of the channel.

$link = $myChannel->getLink();

getDescription
Returns the description of the channel.

Signature: getDescription()

Returns:

String - The description of the channel, or an empty string.

Example:

Returns the description of the channel.

$description = $myChannel->getDescription();

getItemCount
Returns the item count of the channel.

Signature: getItemCount()

Returns:

int - The item count of the channel.

Example:

Returns the item count of the channel.

$itemCount = $myChannel->getItemCount();

getItem
Returns a reference to the item at the specified index.

Signature: &getItem($index)

Parameters:

int index - The index of the requested item.

Returns:

xml_domit_rss_item - The item at the specified index.

Example:

Returns the item at the specified index.

$myItem =& $myChannel->getItem(0);

getCategoryCount
Returns the category count of the channel.

Signature: getCategoryCount()

Returns:

int - The category count of the channel.

Example:

Returns the category count of the channel.

$catCount = $myChannel->getCategoryCount();

getCategory
Returns a reference to the category at the specified index.

Signature: &getCategory($index)

Parameters:

int index - The index of the requested category.

Returns:

xml_domit_rss_category - The category at the specified index.

Example:

Returns the category at the specified index.

$myCategory =& $myChannel->getCategory(0);




Private Methods
_init
Performs initialization of the RSS channel.

Signature: _init()


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