SelectWidget Class Reference

Inheritance diagram for SelectWidget:

Collaboration diagram for SelectWidget:

Public Member Functions
	__construct ($title, $url, $name, $method='get', $multiple=false)
	setUrl ($url)
	setMaxLength ($length)
	setSelectParameterName ($name)
	setSelection ($value)
	setRequestMethod ($method)
	setMultiple ($multiple)
	setOptions (array $options, $selected=false)
	render ($variables=[])
Public Member Functions inherited from SidebarWidget
	__construct ()
	setTitle ($title)
	getTitle ()
	removeTitle ()
	setExtra ($extra)
	getExtra ()
	removeExtra ()
	render ($variables=[])
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)
	addLayoutCSSClass ($css_class)
	removeLayoutCSSClass ($css_class)
	render ($variables=[])
	__isset ($offset)
	__get ($offset)
	__set ($offset, $value)
	__unset ($offset)

Static Public Member Functions
static	arrayToHiddenInput (array $array, $prefix='')

Protected Member Functions
	hasNestedElements ()
Protected Member Functions inherited from Widget
	guessIndex (WidgetElement $element)

Additional Inherited Members
Protected Attributes inherited from Widget
	$elements = []
	$template = 'widgets/widget'
	$template_variables = []
	$layout = 'widgets/widget-layout'
	$forced_rendering = false
	$layout_css_classes = []

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',
			$multiple = false
	)

Constructs the widget by defining a special template.

Parameters

string	$title	Diplayed title
string	$url	Target url
string	$name	Name of the input element
string	$method	Request method
boolean	$multiple	Defines whether selecting multiple values is allowed

Here is the call graph for this function:

Member Function Documentation

arrayToHiddenInput()

static arrayToHiddenInput ( array  $array,   $prefix = ''  )

static

Converts the given array to a list of hidden inputs

Parameters

array	$array	Array to convert
string	$prefix	Optional prefix for the input name

Returns

string list of hidden inputs as html

Here is the call graph for this function:

Here is the caller graph for this function:

hasNestedElements()

hasNestedElements ( )

protected

Returns whether this element has nested subelements

Returns

boolean true if element has nested subelements

Here is the caller graph for this function:

render()

render

(

$variables = []

)

Renders the select widget

Parameters

array

$variables

Additional vaiarbles

Returns

string rendered widget as ghtml

Reimplemented from SidebarWidget.

Reimplemented in SemesterSelectorWidget.

Here is the call graph for this function:

setMaxLength()

setMaxLength

(

$length

)

Sets the maximum length of the input

Parameters

int

$length

Maximum length

setMultiple()

setMultiple

(

$multiple

)

Sets whether selecting multiple values is allowed or not

Parameters

bool

$multiple

true if selection multiple values should be allowed

Here is the caller graph for this function:

setOptions()

setOptions	(	array	$options,
			$selected = false
	)

Sets the options for the select element

Parameters

array	$options	Options as associative array (value => label)
mixed	$selected	The initially selected value

Here is the call graph for this function:

setRequestMethod()

setRequestMethod

(

$method

)

Sets the request method

Parameters

string

$method

[description]

Reimplemented in SelectorWidget.

Here is the caller graph for this function:

setSelection()

setSelection

(

$value

)

Sets the selected value.

Parameters

mixed

$value

Selected value

Reimplemented in SelectorWidget.

setSelectParameterName()

setSelectParameterName

(

$name

)

Sets the name of the select input element

Parameters

String

$name

Name of the input element

Reimplemented in SelectorWidget.

Here is the caller graph for this function:

setUrl()

setUrl

(

$url

)

Sets the target url

Parameters

string

$url

Target 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