SemesterSelectorWidget Class Reference

Inheritance diagram for SemesterSelectorWidget:

Public Member Functions
	__construct ($url, $name='semester_id', $method='get')
	includeAll ($state=true)
	setRange ($semester_range_begin, $semester_range_end)
	makeLecturePeriodSelectable ()
	makeVacationPeriodSelectable ()
	render ($variables=[])
Public Member Functions inherited from SelectWidget
	__construct ($title, $url, $name, $method='get', $multiple=false)
	setUrl ($url)
	setMaxLength ($length)
	setSelectParameterName ($name)
	setSelection ($value)
	setRequestMethod ($method)
	setDropdownAutoWidth ($dropdownAutoWidth)
	setMultiple ($multiple)
	setOptions (array $options, $selected=false)
	setOnSubmitHandler ($onsubmit)
	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
	$include_all = false
	$semester_range_begin = 0
	$semester_range_end = 0
bool	$lecture_period_selectable = false
bool	$vacation_period_selectable = false
Protected Attributes inherited from SelectWidget
	$onsubmit = null
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
Static Public Member Functions inherited from SelectWidget
static	arrayToHiddenInput (array $array, $prefix='')
Protected Member Functions inherited from SelectWidget
	hasNestedElements ()
Protected Member Functions inherited from Widget
	guessIndex (WidgetElement $element)

Detailed Description

SemesterSelectorWidget

This class defines a standard sidebar widget for choosing a semester. The selector is derived from the more generic SelecWidget.

Author

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

See also

SelectWidget

Since

Stud.IP 3.2 GPL2 or any later version

Copyright

Stud.IP Core Group

Constructor & Destructor Documentation

__construct()

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

Overrides parent constructor by setting a default title and default name.

Member Function Documentation

includeAll()

includeAll

(

$state = true

)

Should the list include an option for all semesters which results in an option with a value of '0'.

makeLecturePeriodSelectable()

makeLecturePeriodSelectable

(

)

Makes the lecture period in the semester selectable separately.

makeVacationPeriodSelectable()

makeVacationPeriodSelectable

(

)

Makes the vacation period after the lecture period selectable separately.

render()

render

(

$variables = []

)

Populates and renders the widget according to the previously made settings.

setRange()

setRange	(		$semester_range_begin,
			$semester_range_end
	)

Sets the range of semesters to be displayed.

Parameters

$semester_range_begin	The timestamp of the first semester.
$semester_range_end	The timestamp of the end semester.

Field Documentation

$include_all

$include_all = false

protected

$lecture_period_selectable

bool $lecture_period_selectable = false

protected

$semester_range_begin

$semester_range_begin = 0

protected

The timestamp of the first semester that shall be selectable.

$semester_range_end

$semester_range_end = 0

protected

The timestamp of the last semester that shall be selectable.

$vacation_period_selectable

bool $vacation_period_selectable = false

protected

---

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

• lib/classes/sidebar/SemesterSelectorWidget.php