ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilErrorTextWizardInputGUI Class Reference

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

+ Inheritance diagram for ilErrorTextWizardInputGUI:
+ Collaboration diagram for ilErrorTextWizardInputGUI:

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...
 
 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)
 
 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...
 

Protected Attributes

 $values = array()
 
 $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 11 of file class.ilErrorTextWizardInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Definition at line 27 of file class.ilErrorTextWizardInputGUI.php.

28  {
29  parent::__construct($a_title, $a_postvar);
30  }

Member Function Documentation

◆ checkInput()

ilErrorTextWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

Definition at line 198 of file class.ilErrorTextWizardInputGUI.php.

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

199  {
200  global $lng;
201 
202  if (is_array($_POST[$this->getPostVar()])) $_POST[$this->getPostVar()] = ilUtil::stripSlashesRecursive($_POST[$this->getPostVar()]);
203  $foundvalues = $_POST[$this->getPostVar()];
204  $max_points = 0;
205 
206  if (is_array($foundvalues))
207  {
208  // check answers
209  if (is_array($foundvalues['key']) && is_array($foundvalues['value']))
210  {
211  foreach ($foundvalues['key'] as $val)
212  {
213  if ($this->getRequired() && (strlen($val)) == 0)
214  {
215  $this->setAlert($lng->txt("msg_input_is_required"));
216  return FALSE;
217  }
218  }
219  foreach ($foundvalues['value'] as $val)
220  {
221  if ($this->getRequired() && (strlen($val)) == 0)
222  {
223  $this->setAlert($lng->txt("msg_input_is_required"));
224  return FALSE;
225  }
226  }
227  foreach ($foundvalues['points'] as $val)
228  {
229  if ($this->getRequired() && (strlen($val)) == 0)
230  {
231  $this->setAlert($lng->txt("msg_input_is_required"));
232  return FALSE;
233  }
234  if (!is_numeric(str_replace(",", ".", $val)))
235  {
236  $this->setAlert($lng->txt("form_msg_numeric_value_required"));
237  return FALSE;
238  }
239  if((float)$val <= 0)
240  {
241  $this->setAlert($lng->txt("positive_numbers_required"));
242  return FALSE;
243  }
244  }
245  }
246  else
247  {
248  if ($this->getRequired())
249  {
250  $this->setAlert($lng->txt("msg_input_is_required"));
251  return FALSE;
252  }
253  }
254  }
255  else
256  {
257  if ($this->getRequired())
258  {
259  $this->setAlert($lng->txt("msg_input_is_required"));
260  return FALSE;
261  }
262  }
263 
264  return $this->checkSubItemsInput();
265  }
$_POST['username']
Definition: cron.php:12
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.
global $lng
Definition: privfeed.php:40
+ Here is the call graph for this function:

◆ getKeyMaxlength()

ilErrorTextWizardInputGUI::getKeyMaxlength ( )

Get key maxlength.

Returns
integer Key maxlength

Definition at line 108 of file class.ilErrorTextWizardInputGUI.php.

References $key_maxlength.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getKeyName()

ilErrorTextWizardInputGUI::getKeyName ( )

Get key name.

Returns
string value name

Definition at line 168 of file class.ilErrorTextWizardInputGUI.php.

References $key_name.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getKeySize()

ilErrorTextWizardInputGUI::getKeySize ( )

Get key size.

Returns
integer Key size

Definition at line 68 of file class.ilErrorTextWizardInputGUI.php.

References $key_size.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getValueMaxlength()

ilErrorTextWizardInputGUI::getValueMaxlength ( )

Get value maxlength.

Returns
integer value maxlength

Definition at line 128 of file class.ilErrorTextWizardInputGUI.php.

References $value_maxlength.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getValueName()

ilErrorTextWizardInputGUI::getValueName ( )

Get value name.

Returns
string value name

Definition at line 148 of file class.ilErrorTextWizardInputGUI.php.

References $value_name.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getValues()

ilErrorTextWizardInputGUI::getValues ( )

Get Values.

Returns
array Values

Definition at line 188 of file class.ilErrorTextWizardInputGUI.php.

References $values.

◆ getValueSize()

ilErrorTextWizardInputGUI::getValueSize ( )

Get value size.

Returns
integer value size

Definition at line 88 of file class.ilErrorTextWizardInputGUI.php.

References $value_size.

Referenced by insert().

+ Here is the caller graph for this function:

◆ insert()

ilErrorTextWizardInputGUI::insert ( $a_tpl)

Insert property html.

Returns
int Size

Definition at line 272 of file class.ilErrorTextWizardInputGUI.php.

References $lng, $tpl, ilTextInputGUI\$value, getKeyMaxlength(), getKeyName(), getKeySize(), ilFormPropertyGUI\getPostVar(), getValueMaxlength(), getValueName(), getValueSize(), and ilUtil\prepareFormOutput().

273  {
274  global $lng;
275 
276  $tpl = new ilTemplate("tpl.prop_errortextwizardinput.html", true, true, "Modules/TestQuestionPool");
277  $i = 0;
278  foreach ($this->values as $value)
279  {
280  if (is_object($value))
281  {
282  if (strlen($value->text_wrong))
283  {
284  $tpl->setCurrentBlock("prop_key_propval");
285  $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value->text_wrong));
286  $tpl->parseCurrentBlock();
287  }
288  if (strlen($value->text_correct))
289  {
290  $tpl->setCurrentBlock("prop_value_propval");
291  $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value->text_correct));
292  $tpl->parseCurrentBlock();
293  }
294  if (strlen($value->points))
295  {
296  $tpl->setCurrentBlock("prop_points_propval");
297  $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value->points));
298  $tpl->parseCurrentBlock();
299  }
300  }
301 
302  $tpl->setCurrentBlock("row");
303  $class = ($i % 2 == 0) ? "even" : "odd";
304  if ($i == 0) $class .= " first";
305  if ($i == count($this->values)-1) $class .= " last";
306  $tpl->setVariable("ROW_CLASS", $class);
307  $tpl->setVariable("ROW_NUMBER", $i);
308 
309  $tpl->setVariable("KEY_SIZE", $this->getKeySize());
310  $tpl->setVariable("KEY_ID", $this->getPostVar() . "[key][$i]");
311  $tpl->setVariable("KEY_MAXLENGTH", $this->getKeyMaxlength());
312 
313  $tpl->setVariable("VALUE_SIZE", $this->getValueSize());
314  $tpl->setVariable("VALUE_ID", $this->getPostVar() . "[value][$i]");
315  $tpl->setVariable("VALUE_MAXLENGTH", $this->getValueMaxlength());
316 
317  $tpl->setVariable("POST_VAR", $this->getPostVar());
318 
319  $tpl->parseCurrentBlock();
320 
321  $i++;
322  }
323  $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
324  $tpl->setVariable("KEY_TEXT", $this->getKeyName());
325  $tpl->setVariable("VALUE_TEXT", $this->getValueName());
326  $tpl->setVariable("POINTS_TEXT", $lng->txt('points'));
327 
328  $a_tpl->setCurrentBlock("prop_generic");
329  $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
330  $a_tpl->parseCurrentBlock();
331  }
static prepareFormOutput($a_str, $a_strip=false)
prepares string output for html forms public
getPostVar()
Get Post Variable.
global $tpl
Definition: ilias.php:8
special template class to simplify handling of ITX/PEAR
global $lng
Definition: privfeed.php:40
+ Here is the call graph for this function:

◆ setKeyMaxlength()

ilErrorTextWizardInputGUI::setKeyMaxlength (   $a_maxlength)

Set key maxlength.

Parameters
integer$a_sizeKey maxlength

Definition at line 98 of file class.ilErrorTextWizardInputGUI.php.

99  {
100  $this->key_maxlength = $a_maxlength;
101  }

◆ setKeyName()

ilErrorTextWizardInputGUI::setKeyName (   $a_name)

Set key name.

Parameters
string$a_namevalue name

Definition at line 158 of file class.ilErrorTextWizardInputGUI.php.

Referenced by assErrorTextGUI\populateAnswerSpecificFormPart().

159  {
160  $this->key_name = $a_name;
161  }
+ Here is the caller graph for this function:

◆ setKeySize()

ilErrorTextWizardInputGUI::setKeySize (   $a_size)

Set key size.

Parameters
integer$a_sizeKey size

Definition at line 58 of file class.ilErrorTextWizardInputGUI.php.

59  {
60  $this->key_size = $a_size;
61  }

◆ setValue()

ilErrorTextWizardInputGUI::setValue (   $a_value)

Set Value.

Parameters
string$a_valueValue

Definition at line 37 of file class.ilErrorTextWizardInputGUI.php.

38  {
39  $this->values = array();
40  if (is_array($a_value))
41  {
42  include_once "./Modules/TestQuestionPool/classes/class.assAnswerErrorText.php";
43  if (is_array($a_value['key']))
44  {
45  foreach ($a_value['key'] as $idx => $key)
46  {
47  array_push($this->values, new assAnswerErrorText($key, $a_value['value'][$idx], str_replace(",", ".", $a_value['points'][$idx])));
48  }
49  }
50  }
51  }
Class for error text answers.

◆ setValueMaxlength()

ilErrorTextWizardInputGUI::setValueMaxlength (   $a_maxlength)

Set value maxlength.

Parameters
integer$a_sizevalue maxlength

Definition at line 118 of file class.ilErrorTextWizardInputGUI.php.

119  {
120  $this->value_maxlength = $a_maxlength;
121  }

◆ setValueName()

ilErrorTextWizardInputGUI::setValueName (   $a_name)

Set value name.

Parameters
string$a_namevalue name

Definition at line 138 of file class.ilErrorTextWizardInputGUI.php.

139  {
140  $this->value_name = $a_name;
141  }

◆ setValues()

ilErrorTextWizardInputGUI::setValues (   $a_values)

Set Values.

Parameters
array$a_valueValue

Definition at line 178 of file class.ilErrorTextWizardInputGUI.php.

179  {
180  $this->values = $a_values;
181  }

◆ setValueSize()

ilErrorTextWizardInputGUI::setValueSize (   $a_size)

Set value size.

Parameters
integer$a_sizevalue size

Definition at line 78 of file class.ilErrorTextWizardInputGUI.php.

79  {
80  $this->value_size = $a_size;
81  }

Field Documentation

◆ $key_maxlength

ilErrorTextWizardInputGUI::$key_maxlength = 255
protected

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

Referenced by getKeyMaxlength().

◆ $key_name

ilErrorTextWizardInputGUI::$key_name = ""
protected

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

Referenced by getKeyName().

◆ $key_size

ilErrorTextWizardInputGUI::$key_size = 20
protected

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

Referenced by getKeySize().

◆ $value_maxlength

ilErrorTextWizardInputGUI::$value_maxlength = 255
protected

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

Referenced by getValueMaxlength().

◆ $value_name

ilErrorTextWizardInputGUI::$value_name = ""
protected

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

Referenced by getValueName().

◆ $value_size

ilErrorTextWizardInputGUI::$value_size = 20
protected

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

Referenced by getValueSize().

◆ $values

ilErrorTextWizardInputGUI::$values = array()
protected

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

Referenced by getValues().


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