• Home
  • Ansel_Widget_Base

PHP Class Ansel_Widget_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.
Author: Michael J. Rubinsky ([email protected])
Datei anzeigen Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_autoRender string Determine if this widget will be automatically rendered, or if it is the calling code's responsibility to render it.
$_params array .
$_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).
$_supported_views array List of views this widget supports. Assume we support both. Concrete classes should override this if this is not the case.
$_title string Title for this widget.
$_view Ansel_View Reference to the Ansel_View we are attaching to

Public Methods

Method Description
__construct ( array $params ) : Ansel_Widget Constructor render style
__get ( $property )
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.
html ( ) Get the HTML for this widget

Protected Methods

Method Description
_htmlBegin ( ) : string Default HTML for the beginning of the widget.
_htmlEnd ( ) : string Default HTML for the end of the widget.
isSupported ( string $view ) : boolean Determine if a particular view (Image, Gallery etc.

Method Details

__construct() public method

Constructor render style
public __construct ( array $params ) : Ansel_Widget
$params array
return Ansel_Widget

__get() public method

public __get ( $property )

_htmlBegin() protected method

Default HTML for the beginning of the widget.
protected _htmlBegin ( ) : string
return string

_htmlEnd() protected method

Default HTML for the end of the widget.
protected _htmlEnd ( ) : string
return string

attach() public method

Attach this widget to the passed in view. Normally called by the Ansel_View once this widget is added.
public attach ( Ansel_View_Base $view ) : boolean
$view Ansel_View_Base The view to attach
return boolean

html() abstract public method

Get the HTML for this widget
abstract public html ( )

isSupported() protected method

.) is supported by this widget.
protected isSupported ( string $view ) : boolean
$view string The view to check
return boolean

Property Details

$_autoRender protected_oe property

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

$_params protected_oe property

.
protected array $_params
return array

$_style protected_oe property

Holds the style definition for the gallery this view is for (or the image's parent gallery if this is for an image view).
protected array $_style
return array

$_supported_views protected_oe property

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

$_title protected_oe property

Title for this widget.
protected string $_title
return string

$_view protected_oe property

Reference to the Ansel_View we are attaching to
protected Ansel_View $_view
return Ansel_View