Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
InstituteSelectWidget Class Reference
Inheritance diagram for InstituteSelectWidget:
SelectWidget SidebarWidget Widget

Public Member Functions

 __construct ($url, $name, $method= 'get', $multiple=false)
 
 includeAllOption ($include_all_option=true)
 
 setSelectedElementIds ($element_ids=[])
 
 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_option
 
 $selected_element_ids
 
- 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

InstituteSelectWidget

This is a specialisation of the select widget for institutes and their faculties.

Author
Moritz Strohm stroh.nosp@m.m@da.nosp@m.ta-qu.nosp@m.est..nosp@m.de
See Also
SelectWidget
Since
4.5 GPL2 or any later version

Constructor & Destructor Documentation

__construct (   $url,
  $name,
  $method = 'get',
  $multiple = false 
)

Member Function Documentation

includeAllOption (   $include_all_option = true)

Sets the $include_all_option attribute that specifies whether an option for selecting all institutes shall be provided (true) or not (false). This defaults to true.

render (   $variables = [])
setSelectedElementIds (   $element_ids = [])

This method allows setting the selected elements from other sources than the select's name from a request.

Parameters
Array | string$element_idsThe ID of one element (as string) or the IDs of more than one element (as array) which have been selected.

Field Documentation

$include_all_option
protected
$selected_element_ids
protected

The IDs of the selected institutes.


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