PHP Класс Ansel_View_GalleryRenderer_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.
Автор: Michael J Rubinsky ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$children The Ansel_Image or Ansel_DateGallery objects that appear on the current page in the current view.
$date If we are grouping by date, this holds the currently selected date parts.
$galleryId integer The gallery id for this view's gallery (Convenience instead of $this->view->gallery->id)
$gallerySlug string Gallery slug for current gallery.
$mode integer 0 == Normal 1 == Group by date
$numTiles integer The total number of tiles that this view contains
$page integer The current page we are viewing
$pageend integer The last tile number on the current page.
$pagestart integer The tile number we are starting with on the current page.
$perpage integer Holds number of tiles to display per page
$style Ansel_Style The style definition.
$title string Human readable title for this view type
$view Ansel_View_Gallery The Ansel_View_Gallery object that this Renderer belongs to.

Открытые методы

Метод Описание
__construct ( Ansel_View_Gallery $view = null ) Constructor
fetchChildren ( boolean $noauto ) Default implementation for fetching children/images for this view.
getChildImageIds ( ) : array Return the image ids contained in the gallery.
html ( ) : string Return the HTML for this view. Done this way so we can override this in subclasses if desired.
init ( ) Initialize the renderer. This *must* be called before any attempt is made to display or otherwise interact with the renderer.

Защищенные методы

Метод Описание
_getHordeView ( ) : Horde_View Return an initialized Horde_View instance, populated with all the values common to all Gallery views.
_getPagerUrl ( ) : Horde_Url Return the current pagerurl.
_init ( ) Stub to be overridden by child classes if needed.
_setupPager ( Horde_View &$view ) Populate the Horde_View with the $pager object.

Описание методов

__construct() публичный Метод

Constructor
public __construct ( Ansel_View_Gallery $view = null )
$view Ansel_View_Gallery

_getHordeView() защищенный Метод

Return an initialized Horde_View instance, populated with all the values common to all Gallery views.
protected _getHordeView ( ) : Horde_View
Результат Horde_View

_getPagerUrl() защищенный Метод

Return the current pagerurl.
protected _getPagerUrl ( ) : Horde_Url
Результат Horde_Url The url

_init() защищенный Метод

Stub to be overridden by child classes if needed.
protected _init ( )

_setupPager() защищенный Метод

Populate the Horde_View with the $pager object.
protected _setupPager ( Horde_View &$view )
$view Horde_View The Horde_View object.

fetchChildren() публичный Метод

Other view classes can override this if they need anything special.
public fetchChildren ( boolean $noauto )
$noauto boolean Flag to indicate if we shouldn't automatically drill down on views that support this. E.g., DateMode.

getChildImageIds() публичный Метод

Return the image ids contained in the gallery.
public getChildImageIds ( ) : array
Результат array An array of image ids.

html() абстрактный публичный Метод

Return the HTML for this view. Done this way so we can override this in subclasses if desired.
abstract public html ( ) : string
Результат string

init() публичный Метод

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

Описание свойств

$children публичное свойство

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

$date публичное свойство

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

$galleryId публичное свойство

The gallery id for this view's gallery (Convenience instead of $this->view->gallery->id)
public int $galleryId
Результат integer

$gallerySlug публичное свойство

Gallery slug for current gallery.
public string $gallerySlug
Результат string

$mode публичное свойство

0 == Normal 1 == Group by date
public int $mode
Результат integer

$numTiles публичное свойство

The total number of tiles that this view contains
public int $numTiles
Результат integer

$page публичное свойство

The current page we are viewing
public int $page
Результат integer

$pageend публичное свойство

The last tile number on the current page.
public int $pageend
Результат integer

$pagestart публичное свойство

The tile number we are starting with on the current page.
public int $pagestart
Результат integer

$perpage публичное свойство

Holds number of tiles to display per page
public int $perpage
Результат integer

$style публичное свойство

The style definition.
public Ansel_Style $style
Результат Ansel_Style

$title публичное свойство

Human readable title for this view type
public string $title
Результат string

$view публичное свойство

The Ansel_View_Gallery object that this Renderer belongs to.
public Ansel_View_Gallery $view
Результат Ansel_View_Gallery