\Ansel_View_Ansel

Abstract Ansel_View class for Ansel UI specific views.

Copyright 2011-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()
__get()
__set()
__isset()
getParams()
json()
addWidget()
renderWidgets()
countWidgets()
viewType()
getGalleryCrumbData()
getTitle()
html()
$resource
$gallery
No constants found
_getGallery()
_renderWidgets()
$_params
$_widgets
N/A
No private methods found
No private properties found
N/A

Properties

$resource

$resource : mixed

The ansel resource this view is for.

Type

mixed — Either an Ansel_Gallery or Ansel_Image

$gallery

$gallery : \Ansel_Gallery

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

Type

\Ansel_Gallery

$_params

$_params : 

Type

$_widgets

$_widgets : array

Collection of Ansel_Widgets to display in this view.

Type

array

Methods

__construct()

__construct(array  $params = array()) 

Const'r

Any javascript files needed by the (non-api) view should be included within this method. Additionally, any redirects need to be done in the cont'r since when ::html() is called, headers will have already been sent.

Parameters

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.

__get()

__get(  $property) 

Parameters

$property

__set()

__set(  $property,   $value) 

Parameters

$property
$value

__isset()

__isset(  $property) 

Parameters

$property

getParams()

getParams() : \unknown_type

Getter for the view parameters.

Returns

\unknown_type

json()

json(\Ansel_Gallery  $gallery, array  $params = array()) : string

JSON representation of this gallery's images. We don't use Ansel_Gallery::toJson() on purpose since that is a general jsonification of the gallery data. This method is specific to the view, paging, links etc.

..

Parameters

\Ansel_Gallery $gallery

The gallery to represent in this view

array $params

An array of parameters for this method:

     full       - Should a full URL be generated? [false]
     from       - Starting image count [0]
     count      - The number of images to include (starting at from) [0]
     image_view - The type of ImageGenerator to obtain the src url for. [screen]
     view_links - Should the JSON include links to the Image and/or Gallery View? [false]
     perpage    - Number of images per page [from user prefs]
  

Returns

string —

A serialized JSON array.

addWidget()

addWidget(\Ansel_Widget  $widget) 

Add an Ansel_Widget to be displayed in this view.

Parameters

\Ansel_Widget $widget

The Ansel_Widget to display

renderWidgets()

renderWidgets() 

Output any widgets associated with this view.

countWidgets()

countWidgets() : integer

Count the number of widgets we have attached.

Returns

integer —

The number of widgets attached to this view.

viewType()

viewType() 

getGalleryCrumbData()

getGalleryCrumbData() 

getTitle()

getTitle() 

html()

html() 

_getGallery()

_getGallery(integer  $galleryId = null, string  $slug = '') : \Ansel_Gallery

Todo

Parameters

integer $galleryId

The gallery id

string $slug

The gallery slug

Throws

\Horde_Exception
\InvalidArgumentException

Returns

\Ansel_Gallery

The requested Ansel_Gallery object

_renderWidgets()

_renderWidgets() 

Default widget rendering, can be overridden by any subclass.