Ansel_GalleryMode_Date:: Class for encapsulating gallery methods that
depend on the current display mode of the gallery being Date.
Copyright 2008-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.horde.org/licenses/gpl.
Methods summary
public
boolean
|
#
hasFeature( string $feature )
See if a feature is supported.
See if a feature is supported.
Parameters
Returns
boolean
Overrides
|
public
array
|
#
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
arrayAn array of 'title' and 'navdata' hashes with the [0]
element being the deepest part.
|
public
array
|
#
getDate( )
Getter for date
Returns
array
A date parts array.
Overrides
|
public
|
#
setDate( array $date = array() )
Setter for date
Parameters
Overrides
|
public
array
|
#
getGalleryChildren( integer $perm = Horde_Perms::SHOW, integer $from = 0, integer $to = 0, boolean $noauto = false )
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
- The child to end with.
- $noauto
- <p>Whether or not to automatically drill down to the
first grouping with more then one group.</p>
Returns
arrayA mixed array of Ansel_Gallery_Decorator_Date and
Ansel_Image objects.
|
public
integer
|
#
countGalleryChildren( integer $perm = Horde_Perms::SHOW, boolean $galleries_only = false, boolean $noauto = true )
Return the count of this gallery's children
Return the count of this gallery's children
Parameters
- $perm
- The permissions to require.
- $galleries_only
- <p>Only include galleries, no images.
(Ignored since this makes no sense for a
gallery grouped by dates).</p>
- $noauto
- <p>Auto navigate down to the first populated
date grouping.</p>
Returns
integerThe count of this gallery's children. The count is either
a count of of the number of date groupings (months, days,
etc..) that need to be displayed, or a count of all the
images in the current date grouping (for a specific day).
|
public
array
|
#
listImages( integer $from = 0, integer $count = 0 )
Lists a slice of the image ids in this gallery.
In Date mode, this only makes sense if we are currently viewing a
specific day, otherwise we return 0.
Lists a slice of the image ids in this gallery.
In Date mode, this only makes sense if we are currently viewing a
specific day, otherwise we return 0.
Parameters
- $from
- The image to start listing.
- $count
- The numer of images to list.
Returns
array
An array of image_ids
|
public
boolean
|
#
moveImagesTo( array $images, Ansel_Gallery $gallery )
Moves images from one gallery to another. Since we're viewing by date
some images might belong to a subgallery so we need to take care to
udate the appropriate gallery data.
Moves images from one gallery to another. Since we're viewing by date
some images might belong to a subgallery so we need to take care to
udate the appropriate gallery data.
Parameters
- $images
- An array of image_ids to move.
- $gallery
- The Ansel_Gallery to move them to.
Returns
boolean
Throws
|
public
boolean
|
#
removeImage( mixed $image, boolean $isStack )
Remove an image from this gallery. Note that the image might actually
belong to a subgallery of this gallery since we are viewing by date.
Need to take care of updating correct subgallery's image count etc...
Remove an image from this gallery. Note that the image might actually
belong to a subgallery of this gallery since we are viewing by date.
Need to take care of updating correct subgallery's image count etc...
Parameters
- $image
- An image_id or Ansel_Image object to delete.
- $isStack
- Image is a stack image (doesn't update count).
Returns
boolean
Throws
Horde_Exception_NotFound,
Ansel_Exception
|
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.
|
public
boolean
|
#
hasSubGalleries( )
Checks if the gallery has any subgalleries. This will always be false
for a gallery in date view.
Checks if the gallery has any subgalleries. This will always be false
for a gallery in date view.
Returns
boolean
|
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>Determines whether subgalleries should
be counted or not.</p>
Returns
integer
number of images in this gallery
|
Ansel_GalleryMode_Date