API Documentation
\

\Ansel_Widget_Base

Ansel_Widget:: class wraps the display of widgets to be displayed in various Ansel_Views.

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()
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

List of views this widget supports. Assume we support both. Concrete classes should override this if this is not the case.

Type

array

Methods

__construct()

__construct(array  $params) : \Ansel_Widget

Constructor render style

Parameters

array $params

Returns

\Ansel_Widget

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()

Get the HTML for this widget

_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