ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
All Data Structures Namespaces Files Functions Variables Modules Pages
ilAnswerWizardInputGUI Class Reference

This class represents a single choice wizard property in a property form. More...

+ Inheritance diagram for ilAnswerWizardInputGUI:
+ Collaboration diagram for ilAnswerWizardInputGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
 setValue ($a_value)
 Set Value. More...
 
 setValues ($a_values)
 Set Values. More...
 
 getValues ()
 Get Values. More...
 
 setSingleline ($a_value)
 Set singleline. More...
 
 getSingleline ()
 Get singleline. More...
 
 setQuestionObject ($a_value)
 Set question object. More...
 
 getQuestionObject ()
 Get question object. More...
 
 setAllowMove ($a_allow_move)
 Set allow move. More...
 
 getAllowMove ()
 Get allow move. More...
 
 setMinvalueShouldBeGreater ($a_bool)
 Set minvalueShouldBeGreater. More...
 
 minvalueShouldBeGreater ()
 Get minvalueShouldBeGreater. More...
 
 setMinValue ($a_minvalue)
 Set Minimum Value. More...
 
 getMinValue ()
 Get Minimum Value. 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...
 

Protected Attributes

 $values = array()
 
 $allowMove = false
 
 $singleline = true
 
 $qstObject = null
 
 $minvalue = false
 
 $minvalueShouldBeGreater = false
 
- 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 single choice 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.ilAnswerWizardInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Definition at line 28 of file class.ilAnswerWizardInputGUI.php.

References ilTextInputGUI\setSize().

29  {
30  parent::__construct($a_title, $a_postvar);
31  $this->setSize('25');
32  $this->validationRegexp = "";
33  }
setSize($a_size)
Set Size.
+ Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilAnswerWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

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

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

181  {
182  global $lng;
183  if (is_array($_POST[$this->getPostVar()])) $_POST[$this->getPostVar()] = ilUtil::stripSlashesRecursive($_POST[$this->getPostVar()]);
184  $foundvalues = $_POST[$this->getPostVar()];
185  if (is_array($foundvalues))
186  {
187  // check answers
188  if (is_array($foundvalues['answer']))
189  {
190  foreach ($foundvalues['answer'] as $aidx => $answervalue)
191  {
192  if ((strlen($answervalue)) == 0)
193  {
194  $this->setAlert($lng->txt("msg_input_is_required"));
195  return FALSE;
196  }
197  }
198  }
199  // check points
200  $max = 0;
201  if (is_array($foundvalues['points']))
202  {
203  foreach ($foundvalues['points'] as $points)
204  {
205  if ($points > $max) $max = $points;
206  if (((strlen($points)) == 0) || (!is_numeric($points)))
207  {
208  $this->setAlert($lng->txt("form_msg_numeric_value_required"));
209  return FALSE;
210  }
211  if ($this->minvalueShouldBeGreater())
212  {
213  if (trim($points) != "" &&
214  $this->getMinValue() !== false &&
215  $points <= $this->getMinValue())
216  {
217  $this->setAlert($lng->txt("form_msg_value_too_low"));
218 
219  return false;
220  }
221  }
222  else
223  {
224  if (trim($points) != "" &&
225  $this->getMinValue() !== false &&
226  $points < $this->getMinValue())
227  {
228  $this->setAlert($lng->txt("form_msg_value_too_low"));
229 
230  return false;
231 
232  }
233  }
234  }
235  }
236  if ($max == 0)
237  {
238  $this->setAlert($lng->txt("enter_enough_positive_points"));
239  return false;
240  }
241  }
242  else
243  {
244  $this->setAlert($lng->txt("msg_input_is_required"));
245  return FALSE;
246  }
247 
248  return $this->checkSubItemsInput();
249  }
$_POST['username']
Definition: cron.php:12
getPostVar()
Get Post Variable.
setAlert($a_alert)
Set Alert Text.
minvalueShouldBeGreater()
Get minvalueShouldBeGreater.
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:

◆ getAllowMove()

ilAnswerWizardInputGUI::getAllowMove ( )

Get allow move.

Returns
boolean Allow move

Definition at line 132 of file class.ilAnswerWizardInputGUI.php.

References $allowMove.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getMinValue()

ilAnswerWizardInputGUI::getMinValue ( )

Get Minimum Value.

Returns
float Minimum Value

Definition at line 171 of file class.ilAnswerWizardInputGUI.php.

References $minvalue.

Referenced by checkInput().

+ Here is the caller graph for this function:

◆ getQuestionObject()

ilAnswerWizardInputGUI::getQuestionObject ( )

Get question object.

Returns
object Value

Definition at line 112 of file class.ilAnswerWizardInputGUI.php.

References $qstObject.

◆ getSingleline()

ilAnswerWizardInputGUI::getSingleline ( )

Get singleline.

Returns
boolean Value

Definition at line 92 of file class.ilAnswerWizardInputGUI.php.

References $singleline.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getValues()

ilAnswerWizardInputGUI::getValues ( )

Get Values.

Returns
array Values

Definition at line 72 of file class.ilAnswerWizardInputGUI.php.

References $values.

◆ insert()

ilAnswerWizardInputGUI::insert ( $a_tpl)

Insert property html.

Returns
int Size

Definition at line 256 of file class.ilAnswerWizardInputGUI.php.

References $lng, $tpl, ilTextInputGUI\$value, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), getAllowMove(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilTextInputGUI\getMaxLength(), ilFormPropertyGUI\getPostVar(), getSingleline(), ilTextInputGUI\getSize(), ilUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

257  {
258  global $lng;
259 
260  $tpl = new ilTemplate("tpl.prop_answerwizardinput.html", true, true, "Modules/TestQuestionPool");
261  $i = 0;
262  foreach ($this->values as $value)
263  {
264  if ($this->getSingleline())
265  {
266  if (is_object($value))
267  {
268  $tpl->setCurrentBlock("prop_text_propval");
269  $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value->getAnswertext()));
270  $tpl->parseCurrentBlock();
271  $tpl->setCurrentBlock("prop_points_propval");
272  $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value->getPoints()));
273  $tpl->parseCurrentBlock();
274  }
275  $tpl->setCurrentBlock('singleline');
276  $tpl->setVariable("SIZE", $this->getSize());
277  $tpl->setVariable("SINGLELINE_ID", $this->getPostVar() . "[answer][$i]");
278  $tpl->setVariable("SINGLELINE_ROW_NUMBER", $i);
279  $tpl->setVariable("SINGLELINE_POST_VAR", $this->getPostVar());
280  $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
281  if ($this->getDisabled())
282  {
283  $tpl->setVariable("DISABLED_SINGLELINE", " disabled=\"disabled\"");
284  }
285  $tpl->parseCurrentBlock();
286  }
287  else if (!$this->getSingleline())
288  {
289  if (is_object($value))
290  {
291  $tpl->setCurrentBlock("prop_points_propval");
292  $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value->getPoints()));
293  $tpl->parseCurrentBlock();
294  }
295  $tpl->setCurrentBlock('multiline');
296  $tpl->setVariable("PROPERTY_VALUE", $this->qstObject->prepareTextareaOutput($value->getAnswertext()));
297  $tpl->setVariable("MULTILINE_ID", $this->getPostVar() . "[answer][$i]");
298  $tpl->setVariable("MULTILINE_ROW_NUMBER", $i);
299  $tpl->setVariable("MULTILINE_POST_VAR", $this->getPostVar());
300  if ($this->getDisabled())
301  {
302  $tpl->setVariable("DISABLED_MULTILINE", " disabled=\"disabled\"");
303  }
304  $tpl->parseCurrentBlock();
305  }
306  if ($this->getAllowMove())
307  {
308  $tpl->setCurrentBlock("move");
309  $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
310  $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
311  $tpl->setVariable("ID", $this->getPostVar() . "[$i]");
312  $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
313  $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::DOWN));
314  $tpl->parseCurrentBlock();
315  }
316  $tpl->setCurrentBlock("row");
317  $tpl->setVariable("POST_VAR", $this->getPostVar());
318  $tpl->setVariable("ROW_NUMBER", $i);
319  $tpl->setVariable("ID", $this->getPostVar() . "[answer][$i]");
320  $tpl->setVariable("POINTS_ID", $this->getPostVar() . "[points][$i]");
321  $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
322  $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
323  if ($this->getDisabled())
324  {
325  $tpl->setVariable("DISABLED_POINTS", " disabled=\"disabled\"");
326  }
327  $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
328  $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
329  $tpl->parseCurrentBlock();
330  $i++;
331  }
332 
333  $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
334  $tpl->setVariable("ANSWER_TEXT", $lng->txt('answer_text'));
335  $tpl->setVariable("POINTS_TEXT", $lng->txt('points'));
336  $tpl->setVariable("COMMANDS_TEXT", $lng->txt('actions'));
337 
338  $a_tpl->setCurrentBlock("prop_generic");
339  $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
340  $a_tpl->parseCurrentBlock();
341 
342  global $tpl;
343  $tpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
344  $tpl->addJavascript("./Modules/TestQuestionPool/templates/default/answerwizard.js");
345  }
static prepareFormOutput($a_str, $a_strip=false)
prepares string output for html forms public
getMaxLength()
Get Max Length.
getPostVar()
Get Post Variable.
static get($a_glyph, $a_text="")
Get glyph html.
global $tpl
Definition: ilias.php:8
getFieldId()
Get Post Variable.
special template class to simplify handling of ITX/PEAR
global $lng
Definition: privfeed.php:40
+ Here is the call graph for this function:

◆ minvalueShouldBeGreater()

ilAnswerWizardInputGUI::minvalueShouldBeGreater ( )

Get minvalueShouldBeGreater.

Returns
boolean true if the minimum value should be greater than minvalue

Definition at line 152 of file class.ilAnswerWizardInputGUI.php.

References $minvalueShouldBeGreater.

Referenced by checkInput(), and setMinvalueShouldBeGreater().

+ Here is the caller graph for this function:

◆ setAllowMove()

ilAnswerWizardInputGUI::setAllowMove (   $a_allow_move)

Set allow move.

Parameters
boolean$a_allow_moveAllow move

Definition at line 122 of file class.ilAnswerWizardInputGUI.php.

123  {
124  $this->allowMove = $a_allow_move;
125  }

◆ setMinValue()

ilAnswerWizardInputGUI::setMinValue (   $a_minvalue)

Set Minimum Value.

Parameters
float$a_minvalueMinimum Value

Definition at line 161 of file class.ilAnswerWizardInputGUI.php.

162  {
163  $this->minvalue = $a_minvalue;
164  }

◆ setMinvalueShouldBeGreater()

ilAnswerWizardInputGUI::setMinvalueShouldBeGreater (   $a_bool)

Set minvalueShouldBeGreater.

Parameters
boolean$a_booltrue if the minimum value should be greater than minvalue

Definition at line 142 of file class.ilAnswerWizardInputGUI.php.

References minvalueShouldBeGreater().

143  {
144  $this->minvalueShouldBeGreater = $a_bool;
145  }
minvalueShouldBeGreater()
Get minvalueShouldBeGreater.
+ Here is the call graph for this function:

◆ setQuestionObject()

ilAnswerWizardInputGUI::setQuestionObject (   $a_value)

Set question object.

Parameters
object$a_valuetest object

Definition at line 102 of file class.ilAnswerWizardInputGUI.php.

103  {
104  $this->qstObject =& $a_value;
105  }

◆ setSingleline()

ilAnswerWizardInputGUI::setSingleline (   $a_value)

Set singleline.

Parameters
boolean$a_valueValue

Definition at line 82 of file class.ilAnswerWizardInputGUI.php.

83  {
84  $this->singleline = $a_value;
85  }

◆ setValue()

ilAnswerWizardInputGUI::setValue (   $a_value)

Set Value.

Parameters
string$a_valueValue

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

References ilTextInputGUI\$value.

41  {
42  $this->values = array();
43  if (is_array($a_value))
44  {
45  if (is_array($a_value['answer']))
46  {
47  foreach ($a_value['answer'] as $index => $value)
48  {
49  include_once "./Modules/TestQuestionPool/classes/class.assAnswerBinaryStateImage.php";
50  $answer = new ASS_AnswerBinaryStateImage($value, $a_value['points'][$index], $index, 1, $a_value['imagename'][$index]);
51  array_push($this->values, $answer);
52  }
53  }
54  }
55  }
Class for answers with a binary state indicator.

◆ setValues()

ilAnswerWizardInputGUI::setValues (   $a_values)

Set Values.

Parameters
array$a_valueValue

Definition at line 62 of file class.ilAnswerWizardInputGUI.php.

63  {
64  $this->values = $a_values;
65  }

Field Documentation

◆ $allowMove

ilAnswerWizardInputGUI::$allowMove = false
protected

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

Referenced by getAllowMove().

◆ $minvalue

ilAnswerWizardInputGUI::$minvalue = false
protected

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

Referenced by getMinValue().

◆ $minvalueShouldBeGreater

ilAnswerWizardInputGUI::$minvalueShouldBeGreater = false
protected

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

Referenced by minvalueShouldBeGreater().

◆ $qstObject

ilAnswerWizardInputGUI::$qstObject = null
protected

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

Referenced by getQuestionObject().

◆ $singleline

ilAnswerWizardInputGUI::$singleline = true
protected

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

Referenced by getSingleline().

◆ $values

ilAnswerWizardInputGUI::$values = array()
protected

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

Referenced by getValues().


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