Stud.IP  5.4
 All Data Structures Namespaces Files Functions Variables Groups
Public Member Functions | Protected Attributes
SemesterSelectorWidget Class Reference
Inheritance diagram for SemesterSelectorWidget:
SelectWidget SidebarWidget Widget

Public Member Functions

 __construct ($url, $name= 'semester_id', $method= 'get')
 
 includeAll ($state=true)
 
 setRange ($semester_range_begin, $semester_range_end)
 
 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)
 
 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
 
- 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 (   $url,
  $name = 'semester_id',
  $method = 'get' 
)

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

Member Function Documentation

includeAll (   $state = true)

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

render (   $variables = [])

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

setRange (   $semester_range_begin,
  $semester_range_end 
)

Sets the range of semesters to be displayed.

Parameters
$semester_range_beginThe timestamp of the first semester.
$semester_range_endThe timestamp of the end semester.

Field Documentation

$include_all = false
protected
$semester_range_begin = 0
protected

The timestamp of the first semester that shall be selectable.

$semester_range_end = 0
protected

The timestamp of the last semester that shall be selectable.

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