Docs For Class Ansel

Description

Class to abstract the creation of various image views.

$Horde: ansel/lib/ImageView.php,v 1.7.2.1 2009/01/06 15:22:28 jan Exp $

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

author: Michael J. Rubinsky <mrubinsk@horde.org>

Located in /lib/ImageView.php (line 22)

Direct descendents

Class	Description
Ansel_ImageView_mini	ImageView to create the mini view.
Ansel_ImageView_plainstack	ImageView to create the gallery image stacks.
Ansel_ImageView_polaroidstack	ImageView to create the gallery polaroid stacks.
Ansel_ImageView_polaroidthumb	ImageView to create the shadowsharpthumb view (sharp corners, shadowed)
Ansel_ImageView_prettythumb	ImageView to create the prettythumb view (rounded, shadowed thumbnails).
Ansel_ImageView_roundedstack	ImageView to create the gallery image stacks.
Ansel_ImageView_screen	ImageView to create the screen view - image sized for slideshow view.
Ansel_ImageView_shadowsharpthumb	ImageView to create the shadowsharpthumb view (sharp corners, shadowed)
Ansel_ImageView_thumb	ImageView to create the thumb view (plain, resized thumbnails).

Variable Summary

mixed $need

array $_dimensions

Ansel_Image $_image

array $_params

mixed $_style

Method Summary

Ansel_ImageView Ansel_ImageView ( $params)

void create ()

void factory ( $type, [ $params = array()])

An _getGalleryWithImages (Ansel_Gallery $parent)

void _getStackImages ()

Variables

mixed $need = array() (line 47)

Redefined in descendants as:

array $_dimensions = array() (line 43)

Image dimensions

Ansel_Image $_image = null (line 29)

Ansel_Image object that this view is created from.

array $_params = array() (line 36)

Parameters for this view

mixed $_style = array() (line 45)

Methods

Constructor Ansel_ImageView (line 52)

Constructor

Ansel_ImageView Ansel_ImageView ( $params)

$params

create (line 64)

Function to actually create and cache the view.

void create ()

factory (line 76)

void factory ( $type, [ $params = array()])

$type
$params

_getGalleryWithImages (line 111)

Utility function to make every effort to find a subgallery that contains images.

return: Ansel_Gallery object that has images, or the original $parent

An _getGalleryWithImages (Ansel_Gallery $parent)

Ansel_Gallery $parent: The gallery to start looking in

_getStackImages (line 136)

Utility function to return an array of Ansel_Images to use in building a polaroid stack. Returns a random set of 5 images from the gallery, or the explicitly set default image plus 4 others.

void _getStackImages ()