OptionsWidget Class Reference

Inheritance diagram for OptionsWidget:

Collaboration diagram for OptionsWidget:

Public Member Functions
	__construct ($title=null)
	setUseFormFlag ($use_form=true)
	getUseFormFlag ()
	setFormMethod ($method='post')
	getFormMethod ()
	setFormDirectSubmission ($submit_form_directly=true)
	getFormDirectSubmission ()
	setFormActionUrl ($form_action_url='')
	getFormActionUrl ()
	addCheckbox ( $label, $state, $toggle_url, $toggle_url_off=null, array $attributes=[], $name='', $value='')
	addRadioButton ( $label, $url, $checked=false, $name='', $value='')
	addSelect ($label, $url, $name, $options, $selected_option=false, $attributes=array())
	render ($variables=[])
Public Member Functions inherited from ListWidget
	__construct ()
	addCSSClass ($css_class)
	removeCSSClass ($css_class)
	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)
	addLayoutCSSClass ($css_class)
	removeLayoutCSSClass ($css_class)
	render ($variables=array())
	__isset ($offset)
	__get ($offset)
	__set ($offset, $value)
	__unset ($offset)

Data Fields
const	INDEX = 'options'

Protected Attributes
	$option_elements
	$use_form
	$form_method
	$submit_form_directly
	$form_action_url
Protected Attributes inherited from ListWidget
	$css_classes = array()
Protected Attributes inherited from Widget
	$elements = array()
	$template = 'widgets/widget'
	$template_variables = array()
	$layout = 'widgets/widget-layout'
	$forced_rendering = false
	$layout_css_classes = array()

Additional Inherited Members
Protected Member Functions inherited from Widget
	guessIndex (WidgetElement $element)

Detailed Description

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m @license GPL2 or any later version

Constructor & Destructor Documentation

__construct()

__construct

(

$title = null

)

Parameters

String

$title

Optional alternative title

Here is the call graph for this function:

Member Function Documentation

addCheckbox()

addCheckbox	(		$label,
			$state,
			$toggle_url,
			$toggle_url_off = null,
		array	$attributes = [],
			$name = '',
			$value = ''
	)

Parameters

String	$label
bool	$state
String	$toggle_url	Url to execute the action
String	$toggle_url_off	Optional alternative url to explicitely turn off the checkbox ($toggle_url will then act as $toggle_url_on)
Array	$attributes	Optional additional attributes for the anchor

addRadioButton()

addRadioButton	(		$label,
			$url,
			$checked = false,
			$name = '',
			$value = ''
	)

Parameters

String	$label
String	$url
bool	$checked

addSelect()

addSelect	(		$label,
			$url,
			$name,
			$options,
			$selected_option = false,
			$attributes = array()
	)

Adds a select element to the widget.

Parameters

String	$label
String	$url
String	$name	Attribute name
array	$options	Array of associative options (value => label)
mixed	$selected_option	Currently selected option
array	$attributes	Additional attributes

getFormActionUrl()

getFormActionUrl

(

)

getFormDirectSubmission()

getFormDirectSubmission

(

)

getFormMethod()

getFormMethod

(

)

getUseFormFlag()

getUseFormFlag

(

)

render()

render

(

$variables = []

)

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 ListWidget.

Here is the call graph for this function:

setFormActionUrl()

setFormActionUrl

(

$form_action_url = ''

)

setFormDirectSubmission()

setFormDirectSubmission

(

$submit_form_directly = true

)

setFormMethod()

setFormMethod

(

$method = 'post'

)

setUseFormFlag()

setUseFormFlag

(

$use_form = true

)

Field Documentation

$form_action_url

$form_action_url

protected

$form_method

$form_method

protected

$option_elements

$option_elements

protected

$submit_form_directly

$submit_form_directly

protected

$use_form

$use_form

protected

INDEX

const INDEX = 'options'

---

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

• lib/classes/sidebar/OptionsWidget.php