AdminCourseOptionsWidget Class Reference

Inheritance diagram for AdminCourseOptionsWidget:

Public Member Functions
	__construct (string $title)
	addCheckbox (string $label, string $filter_name, bool $checked=false, $true_value=1, $false_value=null, array $attributes=[])
	addRadioButton (string $label, string $filter_name, $value, bool $checked=false, array $attributes=[])
	addSelect (string $label, string $filter_name, array $options, $selected_value=null, array $attributes=[])
	setPositionInSidebar (?string $position)
	getPositionInSidebar ()
Public Member Functions inherited from ListWidget
	__construct ()
	addCSSClass ($css_class)
	removeCSSClass ($css_class)
	addSeparator ($attributes=[])
	render ($variables=[])
Public Member Functions inherited from SidebarWidget
	__construct ()
	setId (string $id)
	getId ()
	setTitle ($title)
	getTitle ()
	removeTitle ()
	setExtra ($extra)
	getExtra ()
	removeExtra ()
	setAdditionalAttribute (string $key, $value)
	setAdditionalAttributes (array $attributes)
	removeAdditionalAttribute (string $key)
	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)

Protected Attributes
	$position_in_sidebar = null
Protected Attributes inherited from ListWidget
	$css_classes = []
Protected Attributes inherited from SidebarWidget
	$additional_attributes = []
Protected Attributes inherited from Widget
	$elements = []
	$template = 'widgets/widget'
	$template_variables = []
	$layout = 'widgets/widget-layout'
	$forced_rendering = false
	$layout_css_classes = []

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

Detailed Description

This is a special widget class for use with the admin course page. It will connect to the Vue app and use it's method to change the filters.

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Since

Stud.IP 5.4

Constructor & Destructor Documentation

__construct()

__construct

(

string

$title

)

Member Function Documentation

addCheckbox()

addCheckbox	(	string	$label,
		string	$filter_name,
		bool	$checked = false,
			$true_value = 1,
			$false_value = null,
		array	$attributes = []
	)

Adds a checkbox to the widget.

Parameters

string	$label
string	$filter_name
bool	$checked
	$true_value
	$false_value
array	$attributes

Returns

ButtonElement

addRadioButton()

addRadioButton	(	string	$label,
		string	$filter_name,
			$value,
		bool	$checked = false,
		array	$attributes = []
	)

Adds a radio button to the widget.

Parameters

string	$label
string	$filter_name
	$value
bool	$checked
array	$attributes

Returns

ButtonElement

addSelect()

addSelect	(	string	$label,
		string	$filter_name,
		array	$options,
			$selected_value = null,
		array	$attributes = []
	)

Adds a select list to the widget.

Parameters

string	$label
string	$filter_name
array	$options
	$selected_value
array	$attributes

getPositionInSidebar()

getPositionInSidebar

(

)

Returns the position where the widget should be inserted in the sidebar.

Returns

string|null

setPositionInSidebar()

setPositionInSidebar

(

?string

$position

)

Sets the position where the widget should be inserted in the sidebar.

Field Documentation

$position_in_sidebar

$position_in_sidebar = null

protected

---

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

• lib/classes/sidebar/AdminCourseOptionsWidget.php