Class Ansel_GalleryMode_Normal

Description

Ansel_Gallery_Mode_Normal:: Class for encapsulating gallery methods that depend on the current display mode of the gallery.

$Horde: ansel/lib/GalleryMode/Normal.php,v 1.2.2.14 2009/08/13 20:42:32 mrubinsk Exp $

Copyright 2008-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

Located in /lib/GalleryMode/Normal.php (line 16)


	
			
Variable Summary
Method Summary
 Ansel_Gallery_ModeNormal Ansel_GalleryMode_Normal ( &$gallery, Ansel_Gallery $gallery)
 integer countGalleryChildren ([integer $perm = PERMS_SHOW], [boolean $galleries_only = false])
 integer countImages ([boolean $subgalleries = false])
 void getDate ()
 A getGalleryChildren ([integer $perm = PERMS_SHOW], [integer $from = 0], [integer $to = 0])
 void getImages ([integer $from = 0], [integer $count = 0], mixed 2)
 void hasFeature ( $feature)
 boolean hasSubGalleries ()
 void init ()
 mixed listImages ([integer $from = 0], [integer $count = 0])
 void moveImagesTo ( $images,  $gallery)
 void removeImage ( $image,  $isStack)
 void setDate ([ $date = array()])
Variables
mixed $_features = array('subgalleries', 'stacks', 'sort_images',
'image_captions', 'faces', 'slideshow',
'zipdownload', 'upload')
(line 23)
Ansel_Gallery $_gallery (line 21)
Methods
Constructor Ansel_GalleryMode_Normal (line 34)

Constructor

Ansel_Gallery_ModeNormal Ansel_GalleryMode_Normal ( &$gallery, Ansel_Gallery $gallery)
countGalleryChildren (line 139)

Return the count this gallery's children

  • return: The count of this gallery's children.
integer countGalleryChildren ([integer $perm = PERMS_SHOW], [boolean $galleries_only = false])
  • integer $perm: The permissions to require.
  • boolean $galleries_only: Only include galleries, no images.
countImages (line 330)

Returns the number of images in this gallery and, optionally, all sub-galleries.

  • return: number of images in this gallery
integer countImages ([boolean $subgalleries = false])
  • boolean $subgalleries: Determines whether subgalleries should be counted or not.
getDate (line 126)
void getDate ()
getGalleryChildren (line 60)

Get the children of this gallery.

  • return: mixed array of Ansel_Gallery and Ansel_Image objects that are children of this gallery.
A getGalleryChildren ([integer $perm = PERMS_SHOW], [integer $from = 0], [integer $to = 0])
  • integer $perm: The permissions to limit to.
  • integer $from: The child to start at.
  • integer $to: The child to end with.
getGalleryCrumbData (line 101)

Get an array describing where this gallery is in a breadcrumb trail.

  • return: array of 'title' and 'navdata' hashes with the [0] element being the deepest part.
An getGalleryCrumbData ()
getImages (line 284)

Gets a slice of the images in this gallery.

void getImages ([integer $from = 0], [integer $count = 0], mixed 2)
  • integer $from: The image to start fetching.
  • integer $count: The numer of images to return.
  • mixed 2: An array of Ansel_Image objects | PEAR_Error
hasFeature (line 45)
void hasFeature ( $feature)
  • $feature
hasSubGalleries (line 316)

Checks if the gallery has any subgallery

boolean hasSubGalleries ()
init (line 39)
void init ()
listImages (line 164)

Lists a slice of the image ids in this gallery.

  • return: An array of image_ids | PEAR_Error
mixed listImages ([integer $from = 0], [integer $count = 0])
  • integer $from: The image to start listing.
  • integer $count: The numer of images to list.
moveImagesTo (line 171)
void moveImagesTo ( $images,  $gallery)
  • $images
  • $gallery
removeImage (line 205)
void removeImage ( $image,  $isStack)
  • $image
  • $isStack
setDate (line 121)
void setDate ([ $date = array()])
  • $date

Documentation generated on Sun, 30 Jan 2011 05:08:48 +0000 by phpDocumentor 1.4.3