WidgetContainer Class Reference

Inheritance diagram for WidgetContainer:

Collaboration diagram for WidgetContainer:

Public Member Functions
	addWidget (Widget $widget, $index=null)
	insertWidget (Widget $widget, $before_index, $index=null)
	getWidget ($index)
	getWidgets ()
	removeWidget ($index)
	hasWidgets ()
	hasWidget ($index)
	render ()

Static Public Member Functions
static	Get ()

Protected Member Functions
	__construct ()

Protected Attributes
	$widgets = []

Static Protected Attributes
static	$instances = null

Detailed Description

Generic widget container

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m @license GPL 2 or later

Since

3.1 @abstract

Constructor & Destructor Documentation

__construct()

__construct ( )

protected

Private constructor to ensure that the singleton Get() method is always used.

See also

WidgetContainer::Get

Reimplemented in Helpbar, and Sidebar.

Member Function Documentation

addWidget()

addWidget	(	Widget	$widget,
			$index = null
	)

Add a widget to the container.

Parameters

Widget	$widget	The actual widget
String	$index	Optional index/name of the widget, defaults to class name without "widget"

Returns

Widget The added widget to allow for easier handling

Here is the caller graph for this function:

Get()

static Get ( )

static

Returns the instance of this container to ensure there is only one instance.

Returns

WidgetContainer The container instance

Here is the caller graph for this function:

getWidget()

getWidget

(

$index

)

Retrieve the widget at the specified position.

Parameters

String

$index

Index/name of the widget to retrieve.

Returns

WidgetElement The widget at the specified position.

Exceptions

Exception

if the specified position is invalid

getWidgets()

getWidgets

(

)

Returns all widgets of the container.

Returns

array of Widget

hasWidget()

hasWidget

(

$index

)

Returns whether a widget exists at the given index.

Parameters

String

$index

Index/name of the widget to check for.

Returns

bool Does a widget exist at the given index?

hasWidgets()

hasWidgets

(

)

Returns whether this container has any widget.

Returns

bool True if the container has at least one widget, false otherwise.

Here is the caller graph for this function:

insertWidget()

insertWidget	(	Widget	$widget,
			$before_index,
			$index = null
	)

Insert a widget before a specific other widget or at the end of the list if the specified position is invalid.

Parameters

Widget	$widget	The actual widget
String	$before_index	Insert widget before this widget
String	$index	Optional index/name of the widget, defaults to class name without "widget"

Returns

Widget The inserted widget to allow for easier handling

Here is the caller graph for this function:

removeWidget()

removeWidget

(

$index

)

Removes the widget at the specified position.

Parameters

String

$index

Index/name of the widget to remove.

Exceptions

Exception

if the specified position is invalid

render()

render ( )

abstract

Renders the container.

@abstract

Reimplemented in Helpbar, and Sidebar.

Field Documentation

$instances

$instances = null

staticprotected

The singleton instance of the container

$widgets

$widgets = []

protected

Contains the widgets of the container

---

The documentation for this class was generated from the following file:

• lib/classes/WidgetContainer.php