PHP Class Ansel_GalleryMode_Base, horde

Copyright 2008-2016 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.
Author: Michael J. Rubinsky ([email protected])
Afficher le fichier Open project: horde/horde Class Usage Examples

Protected Properties

Свойство Type Description
$_features array
$_gallery Ansel_Gallery

Méthodes publiques

Méthode 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 = [] )

Method Details

__construct() public méthode

Constructor
public __construct ( Ansel_Gallery $gallery ) : Ansel_GalleryMode_Base
$gallery Ansel_Gallery The gallery to bind to.
Résultat Ansel_GalleryMode_Base

countGalleryChildren() abstract public méthode

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.
Résultat integer The count of this gallery's children.

countImages() abstract public méthode

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.
Résultat integer The number of images in this gallery

getDate() public méthode

public getDate ( ) : array
Résultat array Date parts array.

getGalleryChildren() abstract public méthode

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.
Résultat array A mixed array of Ansel_Gallery and Ansel_Image objects that are children of this gallery.

getGalleryCrumbData() abstract public méthode

Get an array describing where this gallery is in a breadcrumb trail.
abstract public getGalleryCrumbData ( ) : An
Résultat An array of 'title' and 'navdata' hashes with the [0] element being the deepest part.

getImages() abstract public méthode

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.

hasFeature() public méthode

public hasFeature ( $feature )

hasSubGalleries() abstract public méthode

Checks if the gallery has any subgallery
abstract public hasSubGalleries ( ) : boolean
Résultat boolean

listImages() abstract public méthode

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.
Résultat array An array of image_ids

moveImagesTo() abstract public méthode

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.
Résultat boolean

removeImage() abstract public méthode

Remove an image from Ansel.
abstract public removeImage ( $image, boolean $isStack ) : boolean
$isStack boolean This represents a stack image
Résultat boolean

setDate() public méthode

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

Property Details

$_features protected_oe property

protected array $_features
Résultat array