Class Ansel_View_Gallery

Description

The Ansel_View_Gallery:: class wraps display of individual images.

Located in /lib/Views/Gallery.php (line 29)

Ansel_View_Abstract
   |
   --Ansel_View_Gallery
Direct descendents
Class Description
 class Ansel_View_EmbeddedRenderer_Carousel Ansel_View_EmbeddedRenderer_Carousel
 class Ansel_View_EmbeddedRenderer_GalleryLink Ansel_View_EmbeddedRenderer_GalleryLink
 class Ansel_View_EmbeddedRenderer_Mini Ansel_View_EmbeddedRenderer_Mini
 class Ansel_View_EmbeddedRenderer_Slideshow Ansel_View_EmbeddedRenderer_Slideshow
Variable Summary
 mixed $_renderer
Method Summary
 static void makeView ([array $params = array()])
 string getTitle ()
 void html ()
 string viewType ()
Variables
mixed $_renderer (line 32)

Holds the object that does the actual rendering *

Inherited Variables

Inherited from Ansel_View_Abstract

Ansel_View_Abstract::$gallery
Ansel_View_Abstract::$resource
Ansel_View_Abstract::$_params
Ansel_View_Abstract::$_widgets
Methods
static makeView (line 88)
  • TODO: use exceptions from the constructor instead of static instance-getting.
static void makeView ([array $params = array()])
  • array $params: Any parameters that the view might need.
     gallery_id              The gallery id this view is for. If omitted, it
                             looks for a query parameter called 'gallery'
    
     gallery_slug            Same as above, but a slug
    
     gallery_view_url        If set, this is used as the link to a gallery
                             view. %g is replaced by the gallery_id and %s is
                             replaced by the gallery_slug.
    
     gallery_view            The specific Renderer to use, if needed.
                             (GalleryLightbox, Gallery etc...).
    
     image_view_url          If this is set, the image tiles will use this url
                             for the image view link. %i and %g will be
                             replaced by image_id and gallery_id respectively.
                             %s will be replaced by the gallery_slug
    
     image_view_src          If this is set to true, the image view link will go
                             directly to the actual image. This overrides any
                             setting of image_view_url.
    
     image_view_attributes   An optional array of attribute => value pairs
                             that are used as attributes of the image view
                             link.
    
     image_view_title        Specifies which property of the image object
                             to use as the image caption.
    
     image_onclick           Specifies a onclick handler for the image tile
                             links.
    
     style                   Force the use of this named style.
    
     api                     If set, we are being called from the external api
    
     page                    The gallery page number to display if not the
                             default value of the first page (page = 0)
    
     day, month, year        Numeric date part values to describe the gallery
                             date grouping to view in date mode.
    
     force_date_grouping     Do not auto navigate to the first date grouping
                             with more then one resource. Used from the api
                             when clicking on breadcrumb links, for example.

Redefined in descendants as:
getGalleryCrumbData (line 183)
void getGalleryCrumbData ()
getTitle (line 193)

Get this gallery's title.

  • return: The gallery's title.
string getTitle ()
html (line 211)
void html ()

Redefined in descendants as:
viewType (line 206)

Return the HTML representing this view.

  • return: The HTML.
string viewType ()

Redefinition of:
Ansel_View_Abstract::viewType()

Inherited Methods

Inherited From Ansel_View_Abstract

 Ansel_View_Abstract::addWidget()
 Ansel_View_Abstract::countWidgets()
 Ansel_View_Abstract::getGallery()
 Ansel_View_Abstract::json()
 Ansel_View_Abstract::renderWidgets()
 Ansel_View_Abstract::viewType()
 Ansel_View_Abstract::_renderWidgets()

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