Class: SlideshowHelper

Source Location: /modules/slideshow/classes/SlideshowHelper.class

Class SlideshowHelper

Class Overview

Helper utilities for building slideshow data.

Located in /modules/slideshow/classes/SlideshowHelper.class [line 35]

Author(s):

Alan Harder <alan.harder@sun.com>
Bharat Mediratta <bharat@menalto.com>

Information Tags:

Version:

$Revision: 17603 $

Methods

[ Top ]

Method Summary

array	buildAlbumSlideshow()	Return item, image and thumbnail data specific to a given GalleryItem. If the item is a GalleryAlbumItem, then return slideshow data for the children of the album. Otherwise, return slideshow data for the parent album of the given item, and set the start of the slideshow to be the location of the item provided.
array	buildItemsSlideshow()	Return item, image and thumbnail data for a series of GalleryItem ids. The resulting data will only contain images that the user is permitted to see.
array	paginateItemSlideshow()	Return offsets for the prevous and next page of slideshow items

[ Top ]

Methods

buildAlbumSlideshow [line 53]

array buildAlbumSlideshow(
mixed
$item, [int
$startId = null], [int
$offset = 0] 
)

Return item, image and thumbnail data specific to a given GalleryItem. If the item is a GalleryAlbumItem, then return slideshow data for the children of the album. Otherwise, return slideshow data for the parent album of the given item, and set the start of the slideshow to be the location of the item provided.

Parameters:

int	$startId:	(optional) the id that the slideshow should start with
int	$offset:	(optional) number of items to skip

API Tags:

Return:

GalleryStatus a status code array an array of data for each item requested where containing item, image and thumbnail entities int the index into the data array where the slideshow should start. int the offset value for the previous page, null for no previous page int the offset value for the next page, null for no next page

[ Top ]

buildItemsSlideshow [line 111]

array buildItemsSlideshow(
array
$childIds, [int
$startId = null] 
)

Return item, image and thumbnail data for a series of GalleryItem ids. The resulting data will only contain images that the user is permitted to see.

Parameters:

array	$childIds:	ids of GalleryItem instances
int	$startId:	(optional) the id that the slideshow should start with

API Tags:

Return:

GalleryStatus a status code array an array of data for each item requested where containing item, image and thumbnail entities int the index into the data array where the slideshow should start.

[ Top ]

paginateItemSlideshow [line 224]

array paginateItemSlideshow(
int
$itemId, [int
$offset = 0] 
)

Return offsets for the prevous and next page of slideshow items

Parameters:

int	$itemId:	the id of the item to be paginated
int	$offset:	(optional) the current offset. Default 0.

API Tags:

Return:

GalleryStatus a status code int the offset value for the previous page, null for no previous page int the offset value for the next page, null for no next page

[ Top ]

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

	Slideshow Classes

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