PHP Class Ansel_GalleryMode_Base, horde

Author: Michael J. Rubinsky ([email protected])

Protected Properties

Property	Type	Description
$_features	array
$_gallery	Ansel_Gallery

Method	Description
__construct ( Ansel_Gallery $gallery ) : Ansel_GalleryMode_Base	Constructor
countGalleryChildren ( integer $perm = Horde_Perms::SHOW, boolean $galleries_only = false ) : integer	Return the count this gallery's children
countImages ( boolean $subgalleries = false ) : integer	Returns the number of images in this gallery and, optionally, all sub-galleries.
getDate ( ) : array
getGalleryChildren ( integer $perm = Horde_Perms::SHOW, integer $from, $to ) : array	Get the children of this gallery.
getGalleryCrumbData ( ) : An	Get an array describing where this gallery is in a breadcrumb trail.
getImages ( integer $from, integer $count )	Gets a slice of the images in this gallery.
hasFeature ( $feature )
hasSubGalleries ( ) : boolean	Checks if the gallery has any subgallery
listImages ( integer $from, integer $count ) : array	List a slice of the image ids in this gallery.
moveImagesTo ( array $images, Ansel_Gallery $gallery ) : boolean	Move images from this gallery to another.
removeImage ( $image, boolean $isStack ) : boolean	Remove an image from Ansel.
setDate ( array $date = [] )

Constructor

public __construct ( Ansel_Gallery $gallery ) : Ansel_GalleryMode_Base
$gallery	Ansel_Gallery	The gallery to bind to.
return	Ansel_GalleryMode_Base

Return the count this gallery's children

abstract public countGalleryChildren ( integer $perm = Horde_Perms::SHOW, boolean $galleries_only = false ) : integer
$perm	integer	The permissions to require.
$galleries_only	boolean	Only include galleries, no images.
return	integer	The count of this gallery's children.

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

abstract public countImages ( boolean $subgalleries = false ) : integer
$subgalleries	boolean	Determine whether subgalleries should be counted or not.
return	integer	The number of images in this gallery

public getDate ( ) : array
return	array	Date parts array.

Get the children of this gallery.

abstract public getGalleryChildren ( integer $perm = Horde_Perms::SHOW, integer $from, $to ) : array
$perm	integer	The permissions to limit to.
$from	integer	The child to start at.
return	array	A mixed array of Ansel_Gallery and Ansel_Image objects that are children of this gallery.

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

abstract public getGalleryCrumbData ( ) : An
return	An	array of 'title' and 'navdata' hashes with the [0] element being the deepest part.

Gets a slice of the images in this gallery.

abstract public getImages ( integer $from, integer $count )
$from	integer	The image to start fetching.
$count	integer	The numer of images to return.

public hasFeature ( $feature )

Checks if the gallery has any subgallery

abstract public hasSubGalleries ( ) : boolean
return	boolean

List a slice of the image ids in this gallery.

abstract public listImages ( integer $from, integer $count ) : array
$from	integer	The image to start listing.
$count	integer	The numer of images to list.
return	array	An array of image_ids

Move images from this gallery to another.

abstract public moveImagesTo ( array $images, Ansel_Gallery $gallery ) : boolean
$images	array	The image ids to move.
$gallery	Ansel_Gallery	The gallery to move images into.
return	boolean

Remove an image from Ansel.

abstract public removeImage ( $image, boolean $isStack ) : boolean
$isStack	boolean	This represents a stack image
return	boolean

public setDate ( array $date = [] )
$date	array	Date parts array

protected array $_features
return	array

protected Ansel_Gallery $_gallery
return	Ansel_Gallery