SelectWidget Class Reference

Inheritance diagram for SelectWidget:

Collaboration diagram for SelectWidget:

Public Member Functions
	__construct ($title, $url, $name, $method='get')
	setUrl ($url)
	setSelectParameterName ($name)
	setSelection ($value)
	setRequestMethod ($method)
	setOptions (Array $options)
	render ($variables=array())
Public Member Functions inherited from SidebarWidget
	__construct ()
	setTitle ($title)
	getTitle ()
	removeTitle ()
	setExtra ($extra)
	getExtra ()
	removeExtra ()
	render ($variables=array())
Public Member Functions inherited from Widget
	addElement (WidgetElement $element, $index=null)
	insertElement (WidgetElement $element, $before_index, $index=null)
	getElement ($index)
	getElements ()
	removeElement ($index)
	hasElements ()
	hasElement ($index)
	forceRendering ($state=true)
	render ($variables=array())
	__isset ($offset)
	__get ($offset)
	__set ($offset, $value)
	__unset ($offset)

Additional Inherited Members
Protected Member Functions inherited from Widget
	guessIndex (WidgetElement $element)
Protected Attributes inherited from Widget
	$elements = array()
	$template = 'widgets/widget'
	$template_variables = array()
	$layout = 'widgets/widget-layout'
	$forced_rendering = false

Detailed Description

Sidebar widget for lists of selectable items.

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

Constructor & Destructor Documentation

__construct()

__construct	(		$title,
			$url,
			$name,
			$method = 'get'
	)

Constructs the widget by defining a special template.

Here is the call graph for this function:

Member Function Documentation

render()

render

(

$variables = array()

)

Renders the widget. The widget will only be rendered if it contains at least one element.

Returns

String The THML code of the rendered sidebar widget

Reimplemented from SidebarWidget.

Reimplemented in SemesterSelectorWidget.

Here is the call graph for this function:

setOptions()

setOptions

(

Array

$options

)

Here is the call graph for this function:

setRequestMethod()

setRequestMethod

(

$method

)

Reimplemented in SelectorWidget.

Here is the caller graph for this function:

setSelection()

setSelection

(

$value

)

Reimplemented in SelectorWidget.

setSelectParameterName()

setSelectParameterName

(

$name

)

Reimplemented in SelectorWidget.

Here is the caller graph for this function:

setUrl()

setUrl

(

$url

)

Reimplemented in SelectorWidget.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• lib/classes/sidebar/SelectWidget.php