Docs For Class RSS

Description

Located in /classes/rss/rss10.class.php (line 24)

Variable Summary

mixed $charset

mixed $_aChannel

mixed $_aImage

mixed $_aItems

Method Summary

RSS RSS ()

void addData (array $aItems)

void addItem (array $aItem)

string get ()

void send ()

void setChannel (string $sTitle, string $sDescr, string $sLink, string $sAbout, [array $aParams = array()])

void setImage (array $image)

string _escape (string $sStr)

string _getChannel ()

string _getImage ()

string _getItems ()

Variables

mixed $charset (line 32)

mixed $_aChannel (line 26)

mixed $_aImage (line 28)

mixed $_aItems (line 30)

Methods

Constructor RSS (line 35)

RSS RSS ()

addData (line 73)

Add items to feed. For imte format - see addItem().

see: RSS::addItem()

void addData (array $aItems)

array $aItems: items info (array of info arrays)

addItem (line 87)

Add single item to feed.

see: RSS::addData()

void addItem (array $aItem)

array $aItem
: single item info:
1. title - item title
2. descr - item description
3. link - link for item full version
4. dc:... - [optional] Dublin Core module params (see http://dublincore.org/documents/1999/07/02/dces/)

get (line 95)

Get source XML-code for RSS.

return: XML-code
see: RSS::send()

string get ()

send (line 110)

Send generated XML-code to output.

see: RSS::get()

void send ()

setChannel (line 47)

Set channel information

void setChannel (string $sTitle, string $sDescr, string $sLink, string $sAbout, [array $aParams = array()])

string $sTitle: channel's title
string $sDescr: channel's descripton
string $sLink: channel's link
string $sAbout: channel's url (url of RSS)
array $aParams
: additional parameters for different modules:
1. Syndication - 'sy:updatePeriod', 'sy:updateFrequency', 'sy:updateBase'

setImage (line 61)

Set image for channel

void setImage (array $image)

array $image
: image info:
1. title - image title
3. url - url of image file 2. link - url for image href

_escape (line 176)

Enclode string in <![CDATA[ ... ]]> if needed

return: enclosed string

string _escape (string $sStr)

string $sStr: source string

_getChannel (line 120)

Create channel part of code

return: source for channel part of RSS.

string _getChannel ()

_getImage (line 136)

Create image part of code

return: source for image part of RSS.

string _getImage ()

_getItems (line 153)

Create code for items

return: source code for items

string _getItems ()