Class: RssGenerator

Source Location: /modules/rss/classes/RssGenerator.class

Class RssGenerator

Class Overview

Located in /modules/rss/classes/RssGenerator.class [line 33]

Property Summary

array	$_items	An array of all the items (in the RSS sense of the term) in the feed
array	$_properties	An array of global properties for the feed

[ Top ]

Method Summary

void	addItem()	Add an item to the RSS feed that will be generated
void	addProperty()	Add a channel property to the feed that will be generated
string	cdata()	Wrap a text element in <![CDATA .. ]]>
string	generate()	Generate the RSS data string of the items added by addItem()
string	generate091()	Generate RSS 0.91 data
string	generate200()	Generate RSS 2.0 data
void	setItems()	Function to set the items array that will be used when generated the feed
void	setProperties()	Set the channel properties of the feed that will be generated
void	sliceItems()	Removes all items except the first $count items
void	sortItems()	Change the order of the items in the $_items array (useful if $key variable is used when items are added)

[ Top ]

Properties

array $_items = array() [line 40]

An array of all the items (in the RSS sense of the term) in the feed

API Tags:

Access:

private

[ Top ]

array $_properties = array() [line 48]

An array of global properties for the feed

API Tags:

Access:

private

[ Top ]

Methods

addItem [line 56]

void addItem(
array
$properties, [string
$key = ''] 
)

Add an item to the RSS feed that will be generated

Parameters:

array	$properties:	item properties array
string	$key:	optional key for the item array

[ Top ]

addProperty [line 79]

void addProperty(
string
$name, string
$value 
)

Add a channel property to the feed that will be generated

Parameters:

string	$name:	property name
string	$value:	property value

[ Top ]

cdata [line 349]

string cdata(
string
$text 
)

Wrap a text element in <![CDATA .. ]]>

Parameters:

string

$text:

API Tags:

Return:

wrapped text

[ Top ]

generate [line 121]

string generate(
string
$version 
)

Generate the RSS data string of the items added by addItem()

Parameters:

string

$version:

the rss version number

API Tags:

Return:

rss stream

[ Top ]

generate091 [line 137]

string generate091(
)

Generate RSS 0.91 data

API Tags:

Return:

rss stream

[ Top ]

generate200 [line 203]

string generate200(
)

Generate RSS 2.0 data

API Tags:

Return:

rss stream

[ Top ]

setItems [line 69]

void setItems(
array
$items 
)

Function to set the items array that will be used when generated the feed

Parameters:

array

$items:

[ Top ]

setProperties [line 88]

void setProperties(
array
$properties 
)

Set the channel properties of the feed that will be generated

Parameters:

array

$properties:

properties

[ Top ]

sliceItems [line 111]

void sliceItems(
int
$count 
)

Removes all items except the first $count items

Parameters:

int

$count:

[ Top ]

sortItems [line 98]

void sortItems(
string
$order 
)

Change the order of the items in the $_items array (useful if $key variable is used when items are added)

Parameters:

string

$order:

Can either be ASC or DESC

[ Top ]

Documentation generated on Fri, 08 Oct 2010 05:52:26 -0700 by phpDocumentor 1.3.0RC6

	Rss Classes

[ class tree: Rss ] [ index: Rss ] [ all elements ]