Class Ansel_GalleryMode_Base

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

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

Direct known subclasses

Ansel_GalleryMode_Date, Ansel_GalleryMode_Normal

Abstract
Package: Ansel
Author: Michael J. Rubinsky mrubinsk@horde.org
Located at GalleryMode/Base.php

Methods summary
`public Ansel_GalleryMode_Base`	# `__construct( Ansel_Gallery $gallery )` Constructor Constructor Parameters `$gallery` The gallery to bind to. Returns `Ansel_GalleryMode_Base`
`public`	# `hasFeature( mixed $feature )`
`public`	# `setDate( array $date = array() )` Parameters `$date` Date parts array Todo: Figure out if we can get rid of this and only include it in the objects that actually need it.
`public array`	# `getDate( )` Returns `array` Date parts array.
`abstract public array`	# `getGalleryChildren( integer $perm = Horde_Perms::SHOW, integer $from = 0, integer $to = 0 )` Get the children of this gallery. Get the children of this gallery. Parameters `$perm` The permissions to limit to. `$from` The child to start at. `$to` $count The number of children to return. Returns `array` A mixed array of Ansel_Gallery and Ansel_Image objects that are children of this gallery.
`abstract public integer`	# `countGalleryChildren( integer $perm = Horde_Perms::SHOW, boolean $galleries_only = false )` Return the count this gallery's children Return the count this gallery's children Parameters `$perm` The permissions to require. `$galleries_only` Only include galleries, no images. Returns `integer` The count of this gallery's children.
`abstract public An`	# `getGalleryCrumbData( )` Get an array describing where this gallery is in a breadcrumb trail. Get an array describing where this gallery is in a breadcrumb trail. Returns `An` array of 'title' and 'navdata' hashes with the [0] element being the deepest part.
`abstract public array`	# `listImages( integer $from = 0, integer $count = 0 )` List a slice of the image ids in this gallery. List a slice of the image ids in this gallery. Parameters `$from` The image to start listing. `$count` The numer of images to list. Returns `array` An array of image_ids
`abstract public`	# `getImages( integer $from = 0, integer $count = 0 )` Gets a slice of the images in this gallery. Gets a slice of the images in this gallery. Parameters `$from` The image to start fetching. `$count` The numer of images to return.
`abstract public boolean`	# `moveImagesTo( array $images, Ansel_Gallery $gallery )` Move images from this gallery to another. Move images from this gallery to another. Parameters `$images` The image ids to move. `$gallery` The gallery to move images into. Returns `boolean` Throws `Ansel_Exception` Horde_Exception_PermissionDenied
`abstract public boolean`	# `removeImage( integer $image, boolean $isStack )` Remove an image from Ansel. Remove an image from Ansel. Parameters `$image` Ansel_Image $image The image id or object `$isStack` This represents a stack image Returns `boolean`
`abstract public boolean`	# `hasSubGalleries( )` Checks if the gallery has any subgallery Checks if the gallery has any subgallery Returns `boolean`
`abstract public integer`	# `countImages( boolean $subgalleries = false )` Returns the number of images in this gallery and, optionally, all sub-galleries. Returns the number of images in this gallery and, optionally, all sub-galleries. Parameters `$subgalleries` <p>Determine whether subgalleries should be counted or not.</p> Returns `integer` The number of images in this gallery

Packages

Classes

Class Ansel_GalleryMode_Base

Direct known subclasses

Parameters

Returns

Parameters

Todo:

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns