ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilAdvSelectInputGUI Class Reference

This class represents an advanced selection list property in a property form. More...

+ Inheritance diagram for ilAdvSelectInputGUI:
+ Collaboration diagram for ilAdvSelectInputGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
 addOption ($a_value, $a_text, $a_html="")
 Add an Options. More...
 
 getOptions ()
 Get Options. More...
 
 setValue ($a_value)
 Set Value. More...
 
 getValue ()
 Get Value. More...
 
 setValueByArray ($a_values)
 Set value by array. More...
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 insert (&$a_tpl)
 Insert property html. More...
 
- Public Member Functions inherited from ilFormPropertyGUI
 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
executeCommand ()
 Execute command. More...
 
 getType ()
 Get Type. More...
 
 setTitle ($a_title)
 Set Title. More...
 
 getTitle ()
 Get Title. More...
 
 setPostVar ($a_postvar)
 Set Post Variable. More...
 
 getPostVar ()
 Get Post Variable. More...
 
 getFieldId ()
 Get Post Variable. More...
 
 setInfo ($a_info)
 Set Information Text. More...
 
 getInfo ()
 Get Information Text. More...
 
 setAlert ($a_alert)
 Set Alert Text. More...
 
 getAlert ()
 Get Alert Text. More...
 
 setRequired ($a_required)
 Set Required. More...
 
 getRequired ()
 Get Required. More...
 
 setDisabled ($a_disabled)
 Set Disabled. More...
 
 getDisabled ()
 Get Disabled. More...
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 setParentForm ($a_parentform)
 Set Parent Form. More...
 
 getParentForm ()
 Get Parent Form. More...
 
 setParent ($a_val)
 Set Parent GUI object. More...
 
 getParent ()
 Get Parent GUI object. More...
 
 getSubForm ()
 Get sub form html. More...
 
 hideSubForm ()
 Sub form hidden on init? More...
 
 setHiddenTitle ($a_val)
 Set hidden title (for screenreaders) More...
 
 getHiddenTitle ()
 Get hidden title. More...
 
 getItemByPostVar ($a_post_var)
 Get item by post var. More...
 
 serializeData ()
 serialize data More...
 
 unserializeData ($a_data)
 unserialize data More...
 
 writeToSession ()
 Write to session. More...
 
 clearFromSession ()
 Clear session value. More...
 
 readFromSession ()
 Read from session. More...
 
 getHiddenTag ($a_post_var, $a_value)
 Get hidden tag (used for disabled properties) More...
 
 setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
 Set Multi. More...
 
 getMulti ()
 Get Multi. More...
 
 setMultiValues (array $a_values)
 Set multi values. More...
 
 getMultiValues ()
 Get multi values. More...
 
 getContentOutsideFormTag ()
 Get content that has to reside outside of the parent form tag, e.g. More...
 
 removeProhibitedCharacters ($a_text)
 Remove prohibited characters see #19159. More...
 
 stripSlashesAddSpaceFallback ($a_str)
 Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
 

Protected Attributes

 $options = array()
 
 $value
 
- Protected Attributes inherited from ilFormPropertyGUI
 $type
 
 $title
 
 $postvar
 
 $info
 
 $alert
 
 $required = false
 
 $parentgui
 
 $parentform
 
 $hidden_title = ""
 
 $multi = false
 
 $multi_sortable = false
 
 $multi_addremove = true
 
 $multi_values
 

Additional Inherited Members

- Protected Member Functions inherited from ilFormPropertyGUI
 setType ($a_type)
 Set Type. More...
 
 getMultiIconsHTML ()
 Get HTML for multiple value icons. More...
 

Detailed Description

This class represents an advanced selection list property in a property form.

It can hold graphical selection items, uses javascript and falls back to a normal selection list, when javascript is disabled.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 14 of file class.ilAdvSelectInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAdvSelectInputGUI::__construct (   $a_title = "",
  $a_postvar = "" 
)

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 25 of file class.ilAdvSelectInputGUI.php.

26 {
27 parent::__construct($a_title, $a_postvar);
28 $this->setType("advselect");
29 }
setType($a_type)
Set Type.

References ilFormPropertyGUI\setType().

+ Here is the call graph for this function:

Member Function Documentation

◆ addOption()

ilAdvSelectInputGUI::addOption (   $a_value,
  $a_text,
  $a_html = "" 
)

Add an Options.

Parameters
array$a_optionsOptions. Array ("value" => "option_html")

Definition at line 36 of file class.ilAdvSelectInputGUI.php.

37 {
38 $this->options[$a_value] = array("value" => $a_value,
39 "txt" => $a_text, "html" => $a_html);
40 }

◆ checkInput()

ilAdvSelectInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

Definition at line 87 of file class.ilAdvSelectInputGUI.php.

88 {
89 global $lng;
90
91 $_POST[$this->getPostVar()] =
93 if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
94 {
95 $this->setAlert($lng->txt("msg_input_is_required"));
96
97 return false;
98 }
99 return true;
100 }
getPostVar()
Get Post Variable.
setAlert($a_alert)
Set Alert Text.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
$_POST['username']
Definition: cron.php:12
global $lng
Definition: privfeed.php:40

References $_POST, $lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

+ Here is the call graph for this function:

◆ getOptions()

ilAdvSelectInputGUI::getOptions ( )

Get Options.

Returns
array Options. Array ("value" => "option_html")

Definition at line 47 of file class.ilAdvSelectInputGUI.php.

References $options.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getValue()

ilAdvSelectInputGUI::getValue ( )

Get Value.

Returns
string Value

Definition at line 67 of file class.ilAdvSelectInputGUI.php.

References $value.

Referenced by insert().

+ Here is the caller graph for this function:

◆ insert()

ilAdvSelectInputGUI::insert ( $a_tpl)

Insert property html.

Returns
int Size

Definition at line 107 of file class.ilAdvSelectInputGUI.php.

108 {
109 include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
110 $selection = new ilAdvancedSelectionListGUI();
111 $selection->setFormSelectMode($this->getPostVar(), "", false,
112 "", "", "",
113 "", "", "", "");
114 $selection->setId($this->getPostVar());
115 $selection->setHeaderIcon(ilAdvancedSelectionListGUI::DOWN_ARROW_DARK);
116 $selection->setSelectedValue($this->getValue());
117 $selection->setUseImages(false);
119
120 foreach($this->getOptions() as $option)
121 {
122 $selection->addItem($option["txt"], $option["value"], "",
123 "", $option["value"], "", $option["html"]);
124 if ($this->getValue() == $option["value"])
125 {
126 $selection->setListTitle($option["txt"]);
127 }
128 }
129
130 $a_tpl->setCurrentBlock("prop_generic");
131 $a_tpl->setVariable("PROP_GENERIC", $selection->getHTML());
132 $a_tpl->parseCurrentBlock();
133 }
User interface class for advanced drop-down selection lists.

References ilAdvancedSelectionListGUI\DOWN_ARROW_DARK, getOptions(), ilFormPropertyGUI\getPostVar(), getValue(), and ilAdvancedSelectionListGUI\ON_ITEM_CLICK_FORM_SELECT.

+ Here is the call graph for this function:

◆ setValue()

ilAdvSelectInputGUI::setValue (   $a_value)

Set Value.

Parameters
string$a_valueValue

Definition at line 57 of file class.ilAdvSelectInputGUI.php.

58 {
59 $this->value = $a_value;
60 }

Referenced by setValueByArray().

+ Here is the caller graph for this function:

◆ setValueByArray()

ilAdvSelectInputGUI::setValueByArray (   $a_values)

Set value by array.

Parameters
array$a_valuesvalue array

Definition at line 77 of file class.ilAdvSelectInputGUI.php.

78 {
79 $this->setValue($a_values[$this->getPostVar()]);
80 }
setValue($a_value)
Set Value.

References ilFormPropertyGUI\getPostVar(), and setValue().

+ Here is the call graph for this function:

Field Documentation

◆ $options

ilAdvSelectInputGUI::$options = array()
protected

Definition at line 16 of file class.ilAdvSelectInputGUI.php.

Referenced by getOptions().

◆ $value

ilAdvSelectInputGUI::$value
protected

Definition at line 17 of file class.ilAdvSelectInputGUI.php.

Referenced by getValue().


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