API Documentation
\

\Ansel_View_GalleryRenderer_Gallery

Ansel_View_GalleryRenderer_Gallery:: Class wraps display of the traditional Gallery View.

Copyright 2008-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Summary

Methods
Properties
Constants
__construct()
init()
fetchChildren()
getChildImageIds()
html()
$view
$galleryId
$gallerySlug
$page
$mode
$style
$perpage
$pagestart
$pageend
$numTiles
$children
$date
$title
No constants found
_init()
_getHordeView()
_getPagerUrl()
_setupPager()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$view

$view : \Ansel_View_Gallery

The Ansel_View_Gallery object that this Renderer belongs to.

Type

\Ansel_View_Gallery

$galleryId

$galleryId : integer

The gallery id for this view's gallery (Convenience instead of $this->view->gallery->id)

Type

integer

$gallerySlug

$gallerySlug : string

Gallery slug for current gallery.

Type

string

$page

$page : integer

The current page we are viewing

Type

integer

$mode

$mode : integer

The display mode of the current gallery.

0 == Normal 1 == Group by date

Type

integer

$style

$style : \Ansel_Style

The style definition.

Type

\Ansel_Style

$perpage

$perpage : integer

Holds number of tiles to display per page

Type

integer

$pagestart

$pagestart : integer

The tile number we are starting with on the current page.

Type

integer

$pageend

$pageend : integer

The last tile number on the current page.

Type

integer

$numTiles

$numTiles : integer

The total number of tiles that this view contains

Type

integer

$children

$children : array

The Ansel_Image or Ansel_DateGallery objects that appear on the current page in the current view.

Type

array — of Ansel_Image or Ansel_DateGallery objects.

$date

$date : array

If we are grouping by date, this holds the currently selected date parts.

Type

array — containing sufficient date parts for the current depth.

$title

$title : string

Human readable title for this view type

Type

string

Methods

__construct()

__construct(\Ansel_View_Gallery  $view = null)

Constructor

Parameters

\Ansel_View_Gallery $view

init()

init()

Initialize the renderer. This *must* be called before any attempt is made to display or otherwise interact with the renderer.

fetchChildren()

fetchChildren(boolean  $noauto)

Default implementation for fetching children/images for this view.

Other view classes can override this if they need anything special.

Parameters

boolean $noauto

Flag to indicate if we shouldn't automatically drill down on views that support this. E.g., DateMode.

getChildImageIds()

getChildImageIds() : array

Return the image ids contained in the gallery.

Returns

array —

An array of image ids.

html()

html() : string

Return the HTML representing this view.

Returns

string —

The HTML.

_init()

_init()

Stub to be overridden by child classes if needed.

_getHordeView()

_getHordeView() : \Horde_View

Return an initialized Horde_View instance, populated with all the values common to all Gallery views.

Returns

\Horde_View

_getPagerUrl()

_getPagerUrl() : \Horde_Url

Return the current pagerurl.

Returns

\Horde_Url —

The url

_setupPager()

_setupPager(\Horde_View  $view)

Populate the Horde_View with the $pager object.

Parameters

\Horde_View $view

The Horde_View object.