Class Ansel_View_Abstract

Description

The Ansel_View_Abstract:: Parent class for the various Ansel_View classes

$Horde: ansel/lib/Views/Abstract.php,v 1.35.2.6 2009/06/19 22:45:19 mrubinsk Exp $

Located in /lib/Views/Abstract.php (line 11)


	
			
Direct descendents
Class Description
 class Ansel_View_Gallery The Ansel_View_Gallery:: class wraps display of individual images.
 class Ansel_View_List The Ansel_View_Gallery:: class wraps display of individual images.
 class Ansel_View_Slideshow The Ansel_View_Abstract:: Parent class for the various Ansel_View classes
 class Ansel_View_Results The Ansel_View_Results:: class wraps display of images/galleries from multiple parent sources..
 class Ansel_View_Image The Ansel_View_Abstract:: Parent class for the various Ansel_View classes
Variable Summary
Method Summary
 void addWidget (Ansel_Widget $widget)
 integer countWidgets ()
 void &getGallery ([ $galleryId = null], [ $slug = ''])
 string json ([array $images = null], [ $full = false], [integer $from = 0], [integer $count = 0], [ $image_view = 'screen'], [ $view_links = false])
 void renderWidgets ()
 unknown_type viewType ()
 void _renderWidgets ()
Variables
Ansel_Gallery $gallery (line 27)

The gallery object (will be eq to $resource in a gallery view

mixed $resource (line 20)

The ansel resource this view is for.

  • var: Either an Ansel_Gallery or Ansel_Image
mixed $_params = array() (line 13)
array $_widgets = array() (line 34)

Collection of Ansel_Widgets to display in this view.

Methods
addWidget (line 78)

Add an Ansel_Widget to be displayed in this view.

void addWidget (Ansel_Widget $widget)
countWidgets (line 101)

Count the number of widgets we have attached.

  • return: The number of widgets attached to this view.
integer countWidgets ()
getGallery (line 36)
void &getGallery ([ $galleryId = null], [ $slug = ''])
  • $galleryId
  • $slug
json (line 133)

JSON representation of this gallery's images.

  • return: A serialized JSON array.
string json ([array $images = null], [ $full = false], [integer $from = 0], [integer $count = 0], [ $image_view = 'screen'], [ $view_links = false])
  • array $images: An array of Ansel_Image objects. If this is null the images are fetched based on $from and $count.
  • integer $from: Image to start at.
  • integer $count: Number of images to get.
  • $full
  • $image_view
  • $view_links
renderWidgets (line 91)

Output any widgets associated with this view.

void renderWidgets ()
viewType (line 187)
  • abstract:
unknown_type viewType ()

Redefined in descendants as:
_renderWidgets (line 110)

Default widget rendering, can be overridden by any subclass.

void _renderWidgets ()

Documentation generated on Sun, 30 Jan 2011 05:08:42 +0000 by phpDocumentor 1.4.3