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

This class represents a key value pair wizard property in a property form. More...

+ Inheritance diagram for ilKVPWizardInputGUI:
+ Collaboration diagram for ilKVPWizardInputGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
 setValue ($a_value)
 Set Value. More...
 
 setKeySize ($a_size)
 Set key size. More...
 
 getKeySize ()
 Get key size. More...
 
 setValueSize ($a_size)
 Set value size. More...
 
 getValueSize ()
 Get value size. More...
 
 setKeyMaxlength ($a_maxlength)
 Set key maxlength. More...
 
 getKeyMaxlength ()
 Get key maxlength. More...
 
 setValueMaxlength ($a_maxlength)
 Set value maxlength. More...
 
 getValueMaxlength ()
 Get value maxlength. More...
 
 setValueName ($a_name)
 Set value name. More...
 
 getValueName ()
 Get value name. More...
 
 setKeyName ($a_name)
 Set key name. More...
 
 getKeyName ()
 Get key name. More...
 
 setValues ($a_values)
 Set Values. More...
 
 getValues ()
 Get Values. More...
 
 setAllowMove ($a_allow_move)
 Set allow move. More...
 
 getAllowMove ()
 Get allow move. More...
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 insert (&$a_tpl)
 Insert property html. More...
 
- Public Member Functions inherited from ilTextInputGUI
 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
 setValue ($a_value)
 Set Value. More...
 
 getValue ()
 Get Value. More...
 
 setValidationFailureMessage ($a_msg)
 Set message string for validation failure. More...
 
 getValidationFailureMessage ()
 
 setValidationRegexp ($a_value)
 Set validation regexp. More...
 
 getValidationRegexp ()
 Get validation regexp. More...
 
 setMaxLength ($a_maxlength)
 Set Max Length. More...
 
 getMaxLength ()
 Get Max Length. More...
 
 setSize ($a_size)
 Set Size. More...
 
 setInlineStyle ($a_style)
 Set inline style. More...
 
 getInlineStyle ()
 Get inline style. More...
 
 setCssClass ($a_class)
 
 getCssClass ()
 
 setValueByArray ($a_values)
 Set value by array. More...
 
 getSize ()
 Get Size. More...
 
 setSuffix ($a_value)
 Set suffix. More...
 
 getSuffix ()
 Get suffix. More...
 
 setInputType ($a_type)
 set input type More...
 
 getInputType ()
 get input type More...
 
 setSubmitFormOnEnter ($a_val)
 Set submit form on enter. More...
 
 getSubmitFormOnEnter ()
 Get submit form on enter. More...
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 getDataSource ()
 get datasource link for js autocomplete More...
 
 setDataSource ($href, $a_delimiter=null)
 set datasource link for js autocomplete More...
 
 setDataSourceSubmitOnSelection ($a_stat)
 
 getDataSourceSubmitOnSelection ()
 
 setDataSourceSubmitUrl ($a_url)
 
 getDataSourceSubmitUrl ()
 
 setMultiValues (array $a_values)
 Set multi values. More...
 
 insert (&$a_tpl)
 Insert property html. More...
 
 getTableFilterHTML ()
 Get HTML for table filter. More...
 
 getToolbarHTML ()
 Get HTML for toolbar. More...
 
 setDisableHtmlAutoComplete ($autocomplete)
 
 isHtmlAutoCompleteDisabled ()
 
- Public Member Functions inherited from ilSubEnabledFormPropertyGUI
 addSubItem ($a_item)
 Add Subitem. More...
 
 getSubItems ()
 Get Subitems. More...
 
 getSubInputItemsRecursive ()
 returns a flat array of possibly existing subitems recursively More...
 
 checkSubItemsInput ()
 Check SubItems. More...
 
 getSubForm ()
 Get sub form html. More...
 
 getItemByPostVar ($a_post_var)
 Get item by post var. 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...
 
 getTableFilterHTML ()
 Get input item HTML to be inserted into table filters. More...
 
 getToolbarHTML ()
 Get input item HTML to be inserted into ilToolbarGUI. More...
 

Protected Attributes

 $values = array()
 
 $allowMove = false
 
 $key_size = 20
 
 $value_size = 20
 
 $key_maxlength = 255
 
 $value_maxlength = 255
 
 $key_name = ""
 
 $value_name = ""
 
- Protected Attributes inherited from ilTextInputGUI
 $value
 
 $maxlength = 200
 
 $size = 40
 
 $validationRegexp
 
 $validationFailureMessage = ''
 
 $suffix
 
 $style_css
 
 $css_class
 
 $ajax_datasource
 
 $ajax_datasource_delimiter
 
 $ajax_datasource_commit = FALSE
 
 $ajax_datasource_commit_url
 
 $submit_form_on_enter = false
 
 $autocomplete_disabled = false
 
- Protected Attributes inherited from ilSubEnabledFormPropertyGUI
 $sub_items = array()
 
- 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 a key value pair wizard property in a property form.

Author
Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de
Version
$Id$

Definition at line 13 of file class.ilKVPWizardInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Reimplemented from ilTextInputGUI.

Definition at line 30 of file class.ilKVPWizardInputGUI.php.

31 {
32 parent::__construct($a_title, $a_postvar);
33 }

Member Function Documentation

◆ checkInput()

ilKVPWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

Reimplemented from ilTextInputGUI.

Definition at line 220 of file class.ilKVPWizardInputGUI.php.

221 {
222 global $lng;
223
224 if (is_array($_POST[$this->getPostVar()])) $_POST[$this->getPostVar()] = ilUtil::stripSlashesRecursive($_POST[$this->getPostVar()]);
225 $foundvalues = $_POST[$this->getPostVar()];
226 if (is_array($foundvalues))
227 {
228 // check answers
229 if (is_array($foundvalues['key']) && is_array($foundvalues['value']))
230 {
231 foreach ($foundvalues['key'] as $val)
232 {
233 if ($this->getRequired() && (strlen($val)) == 0)
234 {
235 $this->setAlert($lng->txt("msg_input_is_required"));
236 return FALSE;
237 }
238 }
239 foreach ($foundvalues['value'] as $val)
240 {
241 if ($this->getRequired() && (strlen($val)) == 0)
242 {
243 $this->setAlert($lng->txt("msg_input_is_required"));
244 return FALSE;
245 }
246 }
247 }
248 else
249 {
250 if ($this->getRequired())
251 {
252 $this->setAlert($lng->txt("msg_input_is_required"));
253 return FALSE;
254 }
255 }
256 }
257 else
258 {
259 if ($this->getRequired())
260 {
261 $this->setAlert($lng->txt("msg_input_is_required"));
262 return FALSE;
263 }
264 }
265 return $this->checkSubItemsInput();
266 }
getPostVar()
Get Post Variable.
setAlert($a_alert)
Set Alert Text.
static stripSlashesRecursive($a_data, $a_strip_html=true, $a_allow="")
Strip slashes from array and sub-arrays.
$_POST['username']
Definition: cron.php:12
global $lng
Definition: privfeed.php:40

References $_POST, $lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashesRecursive().

+ Here is the call graph for this function:

◆ getAllowMove()

ilKVPWizardInputGUI::getAllowMove ( )

Get allow move.

Returns
boolean Allow move

Definition at line 210 of file class.ilKVPWizardInputGUI.php.

References $allowMove.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getKeyMaxlength()

ilKVPWizardInputGUI::getKeyMaxlength ( )

Get key maxlength.

Returns
integer Key maxlength

Definition at line 110 of file class.ilKVPWizardInputGUI.php.

References $key_maxlength.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getKeyName()

ilKVPWizardInputGUI::getKeyName ( )

Get key name.

Returns
string value name

Definition at line 170 of file class.ilKVPWizardInputGUI.php.

References $key_name.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getKeySize()

ilKVPWizardInputGUI::getKeySize ( )

Get key size.

Returns
integer Key size

Definition at line 70 of file class.ilKVPWizardInputGUI.php.

References $key_size.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getValueMaxlength()

ilKVPWizardInputGUI::getValueMaxlength ( )

Get value maxlength.

Returns
integer value maxlength

Definition at line 130 of file class.ilKVPWizardInputGUI.php.

References $value_maxlength.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getValueName()

ilKVPWizardInputGUI::getValueName ( )

Get value name.

Returns
string value name

Definition at line 150 of file class.ilKVPWizardInputGUI.php.

References $value_name.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getValues()

ilKVPWizardInputGUI::getValues ( )

Get Values.

Returns
array Values

Definition at line 190 of file class.ilKVPWizardInputGUI.php.

References $values.

◆ getValueSize()

ilKVPWizardInputGUI::getValueSize ( )

Get value size.

Returns
integer value size

Definition at line 90 of file class.ilKVPWizardInputGUI.php.

References $value_size.

Referenced by insert().

+ Here is the caller graph for this function:

◆ insert()

ilKVPWizardInputGUI::insert ( $a_tpl)

Insert property html.

Returns
int Size

Reimplemented from ilTextInputGUI.

Definition at line 273 of file class.ilKVPWizardInputGUI.php.

274 {
275 global $lng;
276
277 $tpl = new ilTemplate("tpl.prop_kvpwizardinput.html", true, true, "Modules/TestQuestionPool");
278 $i = 0;
279 foreach ($this->values as $value)
280 {
281 if (is_array($value))
282 {
283 $tpl->setCurrentBlock("prop_key_propval");
284 $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value[0]));
285 $tpl->parseCurrentBlock();
286 $tpl->setCurrentBlock("prop_value_propval");
287 $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value[1]));
288 $tpl->parseCurrentBlock();
289 }
290 if ($this->getAllowMove())
291 {
292 $tpl->setCurrentBlock("move");
293 $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
294 $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
295 $tpl->setVariable("ID", $this->getPostVar() . "[$i]");
296 $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
297 $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::DOWN));
298 $tpl->parseCurrentBlock();
299 }
300
301 $tpl->setCurrentBlock("row");
302 $class = ($i % 2 == 0) ? "even" : "odd";
303 if ($i == 0) $class .= " first";
304 if ($i == count($this->values)-1) $class .= " last";
305 $tpl->setVariable("ROW_CLASS", $class);
306 $tpl->setVariable("ROW_NUMBER", $i);
307
308 $tpl->setVariable("KEY_SIZE", $this->getKeySize());
309 $tpl->setVariable("KEY_ID", $this->getPostVar() . "[key][$i]");
310 $tpl->setVariable("KEY_MAXLENGTH", $this->getKeyMaxlength());
311
312 $tpl->setVariable("VALUE_SIZE", $this->getValueSize());
313 $tpl->setVariable("VALUE_ID", $this->getPostVar() . "[value][$i]");
314 $tpl->setVariable("VALUE_MAXLENGTH", $this->getValueMaxlength());
315
316 $tpl->setVariable("ID", $this->getPostVar() . "[$i]");
317 $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
318 $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
319 $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
320 $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
321
322 $tpl->setVariable("POST_VAR", $this->getPostVar());
323
324 $tpl->parseCurrentBlock();
325
326 $i++;
327 }
328 $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
329 $tpl->setVariable("KEY_TEXT", $this->getKeyName());
330 $tpl->setVariable("VALUE_TEXT", $this->getValueName());
331
332 $a_tpl->setCurrentBlock("prop_generic");
333 $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
334 $a_tpl->parseCurrentBlock();
335
336 global $tpl;
337 $tpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
338 $tpl->addJavascript("./Modules/TestQuestionPool/templates/default/kvpwizard.js");
339 }
global $tpl
Definition: ilias.php:8
getFieldId()
Get Post Variable.
static get($a_glyph, $a_text="")
Get glyph html.
getValueMaxlength()
Get value maxlength.
getKeyMaxlength()
Get key maxlength.
special template class to simplify handling of ITX/PEAR
static prepareFormOutput($a_str, $a_strip=false)
prepares string output for html forms @access public

References $lng, $tpl, ilTextInputGUI\$value, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), getAllowMove(), ilFormPropertyGUI\getFieldId(), getKeyMaxlength(), getKeyName(), getKeySize(), ilFormPropertyGUI\getPostVar(), getValueMaxlength(), getValueName(), getValueSize(), ilUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

+ Here is the call graph for this function:

◆ setAllowMove()

ilKVPWizardInputGUI::setAllowMove (   $a_allow_move)

Set allow move.

Parameters
boolean$a_allow_moveAllow move

Definition at line 200 of file class.ilKVPWizardInputGUI.php.

201 {
202 $this->allowMove = $a_allow_move;
203 }

◆ setKeyMaxlength()

ilKVPWizardInputGUI::setKeyMaxlength (   $a_maxlength)

Set key maxlength.

Parameters
integer$a_sizeKey maxlength

Definition at line 100 of file class.ilKVPWizardInputGUI.php.

101 {
102 $this->key_maxlength = $a_maxlength;
103 }

◆ setKeyName()

ilKVPWizardInputGUI::setKeyName (   $a_name)

Set key name.

Parameters
string$a_namevalue name

Definition at line 160 of file class.ilKVPWizardInputGUI.php.

161 {
162 $this->key_name = $a_name;
163 }

◆ setKeySize()

ilKVPWizardInputGUI::setKeySize (   $a_size)

Set key size.

Parameters
integer$a_sizeKey size

Definition at line 60 of file class.ilKVPWizardInputGUI.php.

61 {
62 $this->key_size = $a_size;
63 }

◆ setValue()

ilKVPWizardInputGUI::setValue (   $a_value)

Set Value.

Parameters
string$a_valueValue

Reimplemented from ilTextInputGUI.

Definition at line 40 of file class.ilKVPWizardInputGUI.php.

41 {
42 $this->values = array();
43 if (is_array($a_value))
44 {
45 if (is_array($a_value['key']))
46 {
47 foreach ($a_value['key'] as $idx => $key)
48 {
49 array_push($this->values, array($key, $a_value['value'][$idx]));
50 }
51 }
52 }
53 }

◆ setValueMaxlength()

ilKVPWizardInputGUI::setValueMaxlength (   $a_maxlength)

Set value maxlength.

Parameters
integer$a_sizevalue maxlength

Definition at line 120 of file class.ilKVPWizardInputGUI.php.

121 {
122 $this->value_maxlength = $a_maxlength;
123 }

◆ setValueName()

ilKVPWizardInputGUI::setValueName (   $a_name)

Set value name.

Parameters
string$a_namevalue name

Definition at line 140 of file class.ilKVPWizardInputGUI.php.

141 {
142 $this->value_name = $a_name;
143 }

◆ setValues()

ilKVPWizardInputGUI::setValues (   $a_values)

Set Values.

Parameters
array$a_valueValue

Definition at line 180 of file class.ilKVPWizardInputGUI.php.

181 {
182 $this->values = $a_values;
183 }

◆ setValueSize()

ilKVPWizardInputGUI::setValueSize (   $a_size)

Set value size.

Parameters
integer$a_sizevalue size

Definition at line 80 of file class.ilKVPWizardInputGUI.php.

81 {
82 $this->value_size = $a_size;
83 }

Field Documentation

◆ $allowMove

ilKVPWizardInputGUI::$allowMove = false
protected

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

Referenced by getAllowMove().

◆ $key_maxlength

ilKVPWizardInputGUI::$key_maxlength = 255
protected

Definition at line 19 of file class.ilKVPWizardInputGUI.php.

Referenced by getKeyMaxlength().

◆ $key_name

ilKVPWizardInputGUI::$key_name = ""
protected

Definition at line 21 of file class.ilKVPWizardInputGUI.php.

Referenced by getKeyName().

◆ $key_size

ilKVPWizardInputGUI::$key_size = 20
protected

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

Referenced by getKeySize().

◆ $value_maxlength

ilKVPWizardInputGUI::$value_maxlength = 255
protected

Definition at line 20 of file class.ilKVPWizardInputGUI.php.

Referenced by getValueMaxlength().

◆ $value_name

ilKVPWizardInputGUI::$value_name = ""
protected

Definition at line 22 of file class.ilKVPWizardInputGUI.php.

Referenced by getValueName().

◆ $value_size

ilKVPWizardInputGUI::$value_size = 20
protected

Definition at line 18 of file class.ilKVPWizardInputGUI.php.

Referenced by getValueSize().

◆ $values

ilKVPWizardInputGUI::$values = array()
protected

Definition at line 15 of file class.ilKVPWizardInputGUI.php.

Referenced by getValues().


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