Docs For Class RssHelper

Methods

addComment [line 391]

GalleryStatus addComment(

&$generator, GalleryComment
$item, array
$param, RssGenerator
$generator 
)

This function adds a comment item to the feed generator

Parameters:

[ Top ]

addItem [line 257]

GalleryStatus addItem(

&$generator, GalleryEntity
$item, array
$param, RssGenerator
$generator 
)

This function adds an item to the feed generator

Parameters:

[ Top ]

addPhotoOrAlbum [line 276]

GalleryStatus addPhotoOrAlbum(

&$generator, GalleryItem
$item, array
$param, RssGenerator
$generator 
)

This function adds a photo or an album item to the feed generator

Parameters:

[ Top ]

fetchAlbumTree [line 475]

array fetchAlbumTree(
int
$itemId, int
$limit, boolean
$newOnly, boolean
$allowPhotos, [int
$perAlbumLimit = 0], [
$random = false] 
)

This function fetches albums or items inside a root album

Parameters:

int	$itemId:	the root album Id
int	$limit:	the maximum number of items to fetch from the DB
boolean	$newOnly:	if true, only select new items (not changed)
boolean	$allowPhotos:	if true, returns photos; if false, albums
int	$perAlbumLimit:	the maximum number of pictures to return from a single album
	$random:

API Tags:

Return:

GalleryStatus array of item Ids

copied and modified from GalleryItemHelper_simple

[ Top ]

getFeed [line 57]

GalleryStatus getFeed(

&$generator, int
$id, 
$param, RssGenerator
$generator, array
$params 
)

This function takes an RssGenerator as a pass-by-reference variable and adds gallery item data to it, so that an rss feed can be generated.

Parameters:

RssGenerator	$generator:	object that will get the data.
int	$id:	Id of the album from where the photoitems shall be retrieved.
array	$params:	Additional parameters.
	&$generator:
	$param:

[ Top ]

getFeedTypeTranslation [line 618]

array getFeedTypeTranslation(
)

This provides a translation of the feed type codes

API Tags:

Return:

GalleryStatus array of feedType => translation

[ Top ]

getPhotoFeed [line 429]

array getPhotoFeed(
GalleryAlbumItem
$entity, 
$newOnly, 
$random 
)

This function retrieves photos and put them in an array.

Parameters:

GalleryAlbumItem	$entity:	Album that we shall retrieve photos/comments from. boolean whether to get only new items, or also updated items boolean whether to use random order, or dates
	$newOnly:
	$random:

API Tags:

Return:

GalleryStatus array creationTimeStamp => GalleryItem

[ Top ]

	Rss Classes

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

Class: RssHelper