API Documentation
\

\Ansel_Widget_SimilarPhotos

Horde_Widget_SimilarPhotos:: class to display a widget containing mini thumbnails of images that are similar, based on tags.

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()
attach()
__get()
html()
_getRelatedImages()
No public properties found
No constants found
_htmlBegin()
_htmlEnd()
isSupported()
$_params
$_view
$_style
$_title
$_autoRender
$_supported_views
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

Any parameters this widget will need.

.

Type

array

$_view

$_view : \Ansel_View

Reference to the Ansel_View we are attaching to

Type

\Ansel_View

$_style

$_style : array

Holds the style definition for the gallery this view is for (or the image's parent gallery if this is for an image view).

Type

array

$_title

$_title : string

Title for this widget.

Type

string

$_autoRender

$_autoRender : string

Determine if this widget will be automatically rendered, or if it is the calling code's responsibility to render it.

Type

string

$_supported_views

$_supported_views : array

Array of views that this widget may appear in.

Type

array

Methods

__construct()

__construct(array  $params) : \Ansel_Widget_SimilarPhotos

Constructor

Parameters

array $params

Any parameters for this widget

Returns

\Ansel_Widget_SimilarPhotos

attach()

attach(\Ansel_View_Base  $view) : boolean

Attach this widget to the passed in view. Normally called by the Ansel_View once this widget is added.

Parameters

\Ansel_View_Base $view

The view to attach

Returns

boolean

__get()

__get(  $property)

Parameters

$property

html()

html() : string

Return the HTML representing this widget.

Returns

string —

The HTML for this widget.

_getRelatedImages()

_getRelatedImages() : string

Helper function for generating a widget of images related to this one.

Returns

string —

The HTML

_htmlBegin()

_htmlBegin() : string

Default HTML for the beginning of the widget.

Returns

string

_htmlEnd()

_htmlEnd() : string

Default HTML for the end of the widget.

Returns

string

isSupported()

isSupported(string  $view) : boolean

Determine if a particular view (Image, Gallery etc.

.) is supported by this widget.

Parameters

string $view

The view to check

Returns

boolean