ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions | Data Fields | Protected Attributes | Private Attributes
ilKprimChoiceWizardInputGUI Class Reference
+ Inheritance diagram for ilKprimChoiceWizardInputGUI:
+ Collaboration diagram for ilKprimChoiceWizardInputGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 
 setFiles ($files)
 
 getFiles ()
 
 setIgnoreMissingUploadsEnabled ($ignoreMissingUploadsEnabled)
 
 isIgnoreMissingUploadsEnabled ()
 
 setValue ($a_value)
 
 checkInput ()
 
 checkUploads ($foundvalues)
 
 collectValidFiles ()
 
- Public Member Functions inherited from ilSingleChoiceWizardInputGUI
 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
 setValue ($a_value)
 Set Value. More...
 
 setSuffixes ($a_suffixes)
 Set Accepted Suffixes. More...
 
 setHideImages ($a_hide)
 Set hide images. More...
 
 getSuffixes ()
 Get Accepted Suffixes. More...
 
 setShowPoints ($a_value)
 
 getShowPoints ()
 
 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...
 
 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...
 

Data Fields

const CUSTOM_UPLOAD_ERR = 99
 

Protected Attributes

 $lng
 
 $tpl
 
 $qstObject
 
- Protected Attributes inherited from ilSingleChoiceWizardInputGUI
 $values = array()
 
 $allowMove = false
 
 $singleline = true
 
 $qstObject = null
 
 $suffixes = array()
 
 $showPoints = true
 
 $hideImages = 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
 

Private Attributes

 $files
 
 $ignoreMissingUploadsEnabled
 

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $lng, and $tpl.

37  {
38  parent::__construct($a_title, $a_postvar);
39 
40  global $lng, $tpl;
41 
42  $this->lng = $lng;
43  $this->tpl = $tpl;
44 
45  $this->files = array();
46 
47  $this->ignoreMissingUploadsEnabled = false;
48  }

Member Function Documentation

◆ checkInput()

ilKprimChoiceWizardInputGUI::checkInput ( )

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

References $_POST, $lng, ilTextInputGUI\$suffix, $tpl, ilTextInputGUI\$value, ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), ilSubEnabledFormPropertyGUI\checkSubItemsInput(), checkUploads(), ilGlyphGUI\DOWN, ilGlyphGUI\get(), ilSingleChoiceWizardInputGUI\getAllowMove(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilUtil\getFileSizeInfo(), ilTextInputGUI\getMaxLength(), ilFormPropertyGUI\getPostVar(), ilSingleChoiceWizardInputGUI\getSingleline(), ilTextInputGUI\getSize(), ilSingleChoiceWizardInputGUI\getSuffixes(), ilSingleChoiceWizardInputGUI\insert(), ilUtil\prepareFormOutput(), ilFormPropertyGUI\setAlert(), ilUtil\stripSlashesRecursive(), and ilGlyphGUI\UP.

101  {
102  global $lng;
103 
104  include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
105  if( is_array($_POST[$this->getPostVar()]) )
106  {
107  $_POST[$this->getPostVar()] = ilUtil::stripSlashesRecursive(
108  $_POST[$this->getPostVar()], false, ilObjAdvancedEditing::_getUsedHTMLTagsAsString("assessment")
109  );
110  }
111 
112  $foundvalues = $_POST[$this->getPostVar()];
113 
114  #vd($foundvalues);
115 
116  if( is_array($foundvalues) )
117  {
118  // check answers
119  if (is_array($foundvalues['answer']))
120  {
121  foreach ($foundvalues['answer'] as $aidx => $answervalue)
122  {
123  if (((strlen($answervalue)) == 0) && (strlen($foundvalues['imagename'][$aidx]) == 0))
124  {
125  $this->setAlert($lng->txt("msg_input_is_required"));
126  return FALSE;
127  }
128  }
129  }
130 
131  // check correctness
132  if( !isset($foundvalues['correctness']) || count($foundvalues['correctness']) < count($foundvalues['answer']) )
133  {
134  $this->setAlert($lng->txt("msg_input_is_required"));
135  return false;
136  }
137 
138  if( !$this->checkUploads($foundvalues) )
139  {
140  return false;
141  }
142  }
143  else
144  {
145  $this->setAlert($lng->txt("msg_input_is_required"));
146  return FALSE;
147  }
148 
149  return $this->checkSubItemsInput();
150  }
$_POST
$_POST['username']
Definition: cron.php:12
ilObjAdvancedEditing\_getUsedHTMLTagsAsString
& _getUsedHTMLTagsAsString($a_module="")
Returns a string of all allowed HTML tags for text editing.
Definition: class.ilObjAdvancedEditing.php:258
ilFormPropertyGUI\getPostVar
getPostVar()
Get Post Variable.
Definition: class.ilFormPropertyGUI.php:108
ilFormPropertyGUI\setAlert
setAlert($a_alert)
Set Alert Text.
Definition: class.ilFormPropertyGUI.php:151
ilUtil\stripSlashesRecursive
static stripSlashesRecursive($a_data, $a_strip_html=true, $a_allow="")
Strip slashes from array and sub-arrays.
Definition: class.ilUtil.php:2660
+ Here is the call graph for this function:

◆ checkUploads()

ilKprimChoiceWizardInputGUI::checkUploads (   $foundvalues)

Definition at line 330 of file class.ilKprimChoiceWizardInputGUI.php.

References $filename, ilTextInputGUI\$suffix, ilObjMediaObject\getMimeType(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilSingleChoiceWizardInputGUI\getSingleline(), ilSingleChoiceWizardInputGUI\getSuffixes(), isIgnoreMissingUploadsEnabled(), ilFormPropertyGUI\setAlert(), and ilUtil\virusHandling().

Referenced by checkInput().

331  {
332  if (is_array($_FILES) && count($_FILES) && $this->getSingleline())
333  {
334  if (!$this->hideImages)
335  {
336  if (is_array($_FILES[$this->getPostVar()]['error']['image']))
337  {
338  foreach ($_FILES[$this->getPostVar()]['error']['image'] as $index => $error)
339  {
340  // error handling
341  if ($error > 0)
342  {
343  switch ($error)
344  {
345  case UPLOAD_ERR_INI_SIZE:
346  $this->setAlert($this->lng->txt("form_msg_file_size_exceeds"));
347  return false;
348  break;
349 
350  case UPLOAD_ERR_FORM_SIZE:
351  $this->setAlert($this->lng->txt("form_msg_file_size_exceeds"));
352  return false;
353  break;
354 
355  case UPLOAD_ERR_PARTIAL:
356  $this->setAlert($this->lng->txt("form_msg_file_partially_uploaded"));
357  return false;
358  break;
359 
360  case UPLOAD_ERR_NO_FILE:
361  if($this->getRequired() && !$this->isIgnoreMissingUploadsEnabled())
362  {
363  if ((!strlen($foundvalues['imagename'][$index])) && (!strlen($foundvalues['answer'][$index])))
364  {
365  $this->setAlert($this->lng->txt("form_msg_file_no_upload"));
366  return false;
367  }
368  }
369  break;
370 
371  case UPLOAD_ERR_NO_TMP_DIR:
372  $this->setAlert($this->lng->txt("form_msg_file_missing_tmp_dir"));
373  return false;
374  break;
375 
376  case UPLOAD_ERR_CANT_WRITE:
377  $this->setAlert($this->lng->txt("form_msg_file_cannot_write_to_disk"));
378  return false;
379  break;
380 
381  case UPLOAD_ERR_EXTENSION:
382  $this->setAlert($this->lng->txt("form_msg_file_upload_stopped_ext"));
383  return false;
384  break;
385  }
386  }
387  }
388  }
389  else
390  {
391  if ($this->getRequired())
392  {
393  $this->setAlert($this->lng->txt("form_msg_file_no_upload"));
394  return false;
395  }
396  }
397 
398  if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image']))
399  {
400  foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname)
401  {
402  $filename = $_FILES[$this->getPostVar()]['name']['image'][$index];
403  $filename_arr = pathinfo($filename);
404  $suffix = $filename_arr["extension"];
405  $mimetype = $_FILES[$this->getPostVar()]['type']['image'][$index];
406  $size_bytes = $_FILES[$this->getPostVar()]['size']['image'][$index];
407  // check suffixes
408  if (strlen($tmpname) && is_array($this->getSuffixes()))
409  {
410  if (!in_array(strtolower($suffix), $this->getSuffixes()))
411  {
412  $this->setAlert($this->lng->txt("form_msg_file_wrong_file_type"));
413  return false;
414  }
415  }
416  }
417  }
418 
419  if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image']))
420  {
421  foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname)
422  {
423  if( $_FILES[$this->getPostVar()]['error']['image'][$index] > 0 )
424  {
425  continue;
426  }
427 
428  $mimetype = ilObjMediaObject::getMimeType($tmpname);
429 
430  if( !preg_match("/^image/", $mimetype) )
431  {
432  $_FILES[$this->getPostVar()]['error']['image'][$index] = self::CUSTOM_UPLOAD_ERR;
433  $this->setAlert($this->lng->txt("form_msg_file_wrong_mime_type"));
434  return false;
435  }
436  }
437  }
438 
439 
440  if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image']))
441  {
442  foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname)
443  {
444  $filename = $_FILES[$this->getPostVar()]['name']['image'][$index];
445  $filename_arr = pathinfo($filename);
446  $suffix = $filename_arr["extension"];
447  $mimetype = $_FILES[$this->getPostVar()]['type']['image'][$index];
448  $size_bytes = $_FILES[$this->getPostVar()]['size']['image'][$index];
449  // virus handling
450  if (strlen($tmpname))
451  {
452  $vir = ilUtil::virusHandling($tmpname, $filename);
453  if ($vir[0] == false)
454  {
455  $_FILES[$this->getPostVar()]['error']['image'][$index] = self::CUSTOM_UPLOAD_ERR;
456  $this->setAlert($this->lng->txt("form_msg_file_virus_found")."<br />".$vir[1]);
457  return false;
458  }
459  }
460  }
461  }
462  }
463  }
464 
465  return true;
466  }
ilUtil\virusHandling
static virusHandling($a_file, $a_orig_name="", $a_clean=true)
scan file for viruses and clean files if possible
Definition: class.ilUtil.php:4109
ilFormPropertyGUI\getPostVar
getPostVar()
Get Post Variable.
Definition: class.ilFormPropertyGUI.php:108
ilFormPropertyGUI\setAlert
setAlert($a_alert)
Set Alert Text.
Definition: class.ilFormPropertyGUI.php:151
$filename
$filename
Definition: buildRTE.php:89
ilObjMediaObject\getMimeType
static getMimeType($a_file, $a_external=false)
get mime type for file
Definition: class.ilObjMediaObject.php:1483
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ collectValidFiles()

ilKprimChoiceWizardInputGUI::collectValidFiles ( )

Definition at line 468 of file class.ilKprimChoiceWizardInputGUI.php.

References ilFormPropertyGUI\getPostVar().

469  {
470  foreach($_FILES[$this->getPostVar()]['error']['image'] as $index => $err)
471  {
472  if( $err > 0 )
473  {
474  continue;
475  }
476 
477  $this->files[$index] = array(
478  'position' => $index,
479  'tmp_name' => $_FILES[$this->getPostVar()]['tmp_name']['image'][$index],
480  'name' => $_FILES[$this->getPostVar()]['name']['image'][$index],
481  'type' => $_FILES[$this->getPostVar()]['type']['image'][$index],
482  'size' => $_FILES[$this->getPostVar()]['size']['image'][$index]
483  );
484  }
485  }
ilFormPropertyGUI\getPostVar
getPostVar()
Get Post Variable.
Definition: class.ilFormPropertyGUI.php:108
+ Here is the call graph for this function:

◆ getFiles()

ilKprimChoiceWizardInputGUI::getFiles ( )

Definition at line 55 of file class.ilKprimChoiceWizardInputGUI.php.

References $files.

56  {
57  return $this->files;
58  }

◆ isIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::isIgnoreMissingUploadsEnabled ( )

Definition at line 65 of file class.ilKprimChoiceWizardInputGUI.php.

References $ignoreMissingUploadsEnabled.

Referenced by checkUploads().

66  {
67  return $this->ignoreMissingUploadsEnabled;
68  }
+ Here is the caller graph for this function:

◆ setFiles()

ilKprimChoiceWizardInputGUI::setFiles (   $files)

Definition at line 50 of file class.ilKprimChoiceWizardInputGUI.php.

References $files.

51  {
52  $this->files = $files;
53  }

◆ setIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::setIgnoreMissingUploadsEnabled (   $ignoreMissingUploadsEnabled)

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

References $ignoreMissingUploadsEnabled.

61  {
62  $this->ignoreMissingUploadsEnabled = $ignoreMissingUploadsEnabled;
63  }

◆ setValue()

ilKprimChoiceWizardInputGUI::setValue (   $a_value)

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

References ilTextInputGUI\$value.

71  {
72  $this->values = array();
73 
74  if( is_array($a_value) && is_array($a_value['answer']) )
75  {
76  foreach ($a_value['answer'] as $index => $value)
77  {
78  $answer = new ilAssKprimChoiceAnswer();
79 
80  $answer->setPosition($index);
81  $answer->setAnswertext($value);
82  $answer->setImageFile($a_value['imagename'][$index]);
83 
84  if( strlen($a_value['correctness'][$index]) )
85  {
86  $answer->setCorrectness((bool)$a_value['correctness'][$index]);
87  }
88 
89  $answer->setThumbPrefix($this->qstObject->getThumbPrefix());
90  $answer->setImageFsDir($this->qstObject->getImagePath());
91  $answer->setImageWebDir($this->qstObject->getImagePathWeb());
92 
93  $this->values[] = $answer;
94  }
95  }
96 
97  #vd($this->values);
98  }

Field Documentation

◆ $files

ilKprimChoiceWizardInputGUI::$files
private

Definition at line 32 of file class.ilKprimChoiceWizardInputGUI.php.

Referenced by getFiles(), and setFiles().

◆ $ignoreMissingUploadsEnabled

ilKprimChoiceWizardInputGUI::$ignoreMissingUploadsEnabled
private

Definition at line 34 of file class.ilKprimChoiceWizardInputGUI.php.

Referenced by isIgnoreMissingUploadsEnabled(), and setIgnoreMissingUploadsEnabled().

◆ $lng

ilKprimChoiceWizardInputGUI::$lng
protected

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

Referenced by __construct(), and checkInput().

◆ $qstObject

ilKprimChoiceWizardInputGUI::$qstObject
protected

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

◆ $tpl

ilKprimChoiceWizardInputGUI::$tpl
protected

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

Referenced by __construct(), and checkInput().

◆ CUSTOM_UPLOAD_ERR

const ilKprimChoiceWizardInputGUI::CUSTOM_UPLOAD_ERR = 99

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

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