Docs For Class RssMapHelper

Class RssMapHelper

Method Summary

array	canConfigureFeed()	Check whether configuring feeds is allowed.
GalleryStatus	createFeed()	Create a feed
GalleryStatus	deleteFeed()	Delete a feed
GalleryStatus	fetchFeed()	Fetch a feed
array	fetchFeedNames()	Return all the feed names
array	fetchFeedsForItem()	Return the feeds defined for a given item
GalleryStatus	updateFeed()	Update a feed

[ Top ]

Methods

canConfigureFeed [line 255]

array canConfigureFeed(
GalleryItem
$item, array
$params, int
$userId, [boolean
$assert = false] 
)

Check whether configuring feeds is allowed.

Parameters:

GalleryItem	$item:
array	$params:	module parameters
int	$userId:
boolean	$assert:	(optional) if true, throw error if not allowed

API Tags:

Return:

GalleryStatus a status code boolean true if allowed

[ Top ]

createFeed [line 186]

GalleryStatus createFeed(
string
$feedName, array
$params 
)

Create a feed

Parameters:

string	$feedName:
array	$params:	parameters

API Tags:

Return:

a status code

[ Top ]

deleteFeed [line 236]

GalleryStatus deleteFeed(
string
$feedName 
)

Delete a feed

Parameters:

string

$feedName:

API Tags:

Return:

a status code

[ Top ]

fetchFeed [line 145]

GalleryStatus fetchFeed(
string
$feedName 
)

Fetch a feed

Parameters:

string

$feedName:

API Tags:

Return:

a status code

[ Top ]

fetchFeedNames [line 111]

array fetchFeedNames(
[int
$limit = 0] 
)

Return all the feed names

Parameters:

int

$limit:

optional limit to the number of feeds

API Tags:

Return:

GalleryStatus a status code array of feed names

[ Top ]

fetchFeedsForItem [line 47]

array fetchFeedsForItem(
[int
$itemId = null] 
)

Return the feeds defined for a given item

Parameters:

int

$itemId:

(optional) item id or null for all feeds

API Tags:

Return:

GalleryStatus a status code array of array 'name' => feed name 'itemId' => item associated with the feed 'ownerId' => owner of the feed 'params' => feed definition

[ Top ]

updateFeed [line 217]

GalleryStatus updateFeed(
string
$feedName, array
$params 
)

Update a feed

Parameters:

string	$feedName:
array	$params:	parameters

API Tags:

Return:

a status code

[ Top ]

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

	Rss Classes

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

Class: RssMapHelper

Class RssMapHelper