ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
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)
 
- 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...
 
 stripSlashesAddSpaceFallback ($a_str)
 Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
 
 getTableFilterLabelFor ()
 Get label "for" attribute value for filter. More...
 
 getFormLabelFor ()
 Get label "for" attribute value for form. More...
 
- Public Member Functions inherited from ilTableFilterItem
 getTableFilterLabelFor ()
 Get label "for" attribute value. 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
 $ctrl
 
 $lng
 
 $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

- Static Public Member Functions inherited from ilFormPropertyGUI
static removeProhibitedCharacters ($a_text)
 Remove prohibited characters see #19159. More...
 
- 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 $DIC, $lng, and $tpl.

37  {
38  parent::__construct($a_title, $a_postvar);
39 
40  global $DIC;
41  $lng = $DIC['lng'];
42  $tpl = $DIC['tpl'];
43 
44  $this->lng = $lng;
45  $this->tpl = $tpl;
46 
47  $this->files = array();
48 
49  $this->ignoreMissingUploadsEnabled = false;
50  }
global $DIC
Definition: saml.php:7

Member Function Documentation

◆ checkInput()

ilKprimChoiceWizardInputGUI::checkInput ( )

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

References $_POST, $DIC, $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.

100  {
101  global $DIC;
102  $lng = $DIC['lng'];
103 
104  include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
105  if (is_array($_POST[$this->getPostVar()])) {
107  $_POST[$this->getPostVar()],
108  false,
110  );
111  }
112 
113  $foundvalues = $_POST[$this->getPostVar()];
114 
115  #vd($foundvalues);
116 
117  if (is_array($foundvalues)) {
118  // check answers
119  if (is_array($foundvalues['answer'])) {
120  foreach ($foundvalues['answer'] as $aidx => $answervalue) {
121  if (((strlen($answervalue)) == 0) && (strlen($foundvalues['imagename'][$aidx]) == 0)) {
122  $this->setAlert($lng->txt("msg_input_is_required"));
123  return false;
124  }
125  }
126  }
127 
128  // check correctness
129  if (!isset($foundvalues['correctness']) || count($foundvalues['correctness']) < count($foundvalues['answer'])) {
130  $this->setAlert($lng->txt("msg_input_is_required"));
131  return false;
132  }
133 
134  if (!$this->checkUploads($foundvalues)) {
135  return false;
136  }
137  } else {
138  $this->setAlert($lng->txt("msg_input_is_required"));
139  return false;
140  }
141 
142  return $this->checkSubItemsInput();
143  }
static _getUsedHTMLTagsAsString($a_module="")
Returns a string of all allowed HTML tags for text editing.
global $DIC
Definition: saml.php:7
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"]
+ Here is the call graph for this function:

◆ checkUploads()

ilKprimChoiceWizardInputGUI::checkUploads (   $foundvalues)

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

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

Referenced by checkInput().

308  {
309  if (is_array($_FILES) && count($_FILES) && $this->getSingleline()) {
310  if (!$this->hideImages) {
311  if (is_array($_FILES[$this->getPostVar()]['error']['image'])) {
312  foreach ($_FILES[$this->getPostVar()]['error']['image'] as $index => $error) {
313  // error handling
314  if ($error > 0) {
315  switch ($error) {
316  case UPLOAD_ERR_INI_SIZE:
317  $this->setAlert($this->lng->txt("form_msg_file_size_exceeds"));
318  return false;
319  break;
320 
321  case UPLOAD_ERR_FORM_SIZE:
322  $this->setAlert($this->lng->txt("form_msg_file_size_exceeds"));
323  return false;
324  break;
325 
326  case UPLOAD_ERR_PARTIAL:
327  $this->setAlert($this->lng->txt("form_msg_file_partially_uploaded"));
328  return false;
329  break;
330 
331  case UPLOAD_ERR_NO_FILE:
332  if ($this->getRequired() && !$this->isIgnoreMissingUploadsEnabled()) {
333  if ((!strlen($foundvalues['imagename'][$index])) && (!strlen($foundvalues['answer'][$index]))) {
334  $this->setAlert($this->lng->txt("form_msg_file_no_upload"));
335  return false;
336  }
337  }
338  break;
339 
340  case UPLOAD_ERR_NO_TMP_DIR:
341  $this->setAlert($this->lng->txt("form_msg_file_missing_tmp_dir"));
342  return false;
343  break;
344 
345  case UPLOAD_ERR_CANT_WRITE:
346  $this->setAlert($this->lng->txt("form_msg_file_cannot_write_to_disk"));
347  return false;
348  break;
349 
350  case UPLOAD_ERR_EXTENSION:
351  $this->setAlert($this->lng->txt("form_msg_file_upload_stopped_ext"));
352  return false;
353  break;
354  }
355  }
356  }
357  } else {
358  if ($this->getRequired()) {
359  $this->setAlert($this->lng->txt("form_msg_file_no_upload"));
360  return false;
361  }
362  }
363 
364  if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image'])) {
365  foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname) {
366  $filename = $_FILES[$this->getPostVar()]['name']['image'][$index];
367  $filename_arr = pathinfo($filename);
368  $suffix = $filename_arr["extension"];
369  $mimetype = $_FILES[$this->getPostVar()]['type']['image'][$index];
370  $size_bytes = $_FILES[$this->getPostVar()]['size']['image'][$index];
371  // check suffixes
372  if (strlen($tmpname) && is_array($this->getSuffixes())) {
373  if (!in_array(strtolower($suffix), $this->getSuffixes())) {
374  $this->setAlert($this->lng->txt("form_msg_file_wrong_file_type"));
375  return false;
376  }
377  }
378  }
379  }
380 
381  if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image'])) {
382  foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname) {
383  if ($_FILES[$this->getPostVar()]['error']['image'][$index] > 0) {
384  continue;
385  }
386 
387  $mimetype = ilObjMediaObject::getMimeType($tmpname);
388 
389  if (!preg_match("/^image/", $mimetype)) {
390  $_FILES[$this->getPostVar()]['error']['image'][$index] = self::CUSTOM_UPLOAD_ERR;
391  $this->setAlert($this->lng->txt("form_msg_file_wrong_mime_type"));
392  return false;
393  }
394  }
395  }
396 
397 
398  if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image'])) {
399  foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname) {
400  $filename = $_FILES[$this->getPostVar()]['name']['image'][$index];
401  $filename_arr = pathinfo($filename);
402  $suffix = $filename_arr["extension"];
403  $mimetype = $_FILES[$this->getPostVar()]['type']['image'][$index];
404  $size_bytes = $_FILES[$this->getPostVar()]['size']['image'][$index];
405  // virus handling
406  if (strlen($tmpname)) {
407  $vir = ilUtil::virusHandling($tmpname, $filename);
408  if ($vir[0] == false) {
409  $_FILES[$this->getPostVar()]['error']['image'][$index] = self::CUSTOM_UPLOAD_ERR;
410  $this->setAlert($this->lng->txt("form_msg_file_virus_found") . "<br />" . $vir[1]);
411  return false;
412  }
413  }
414  }
415  }
416  }
417  }
418 
419  return true;
420  }
static getMimeType($a_file, $a_external=null)
get mime type for file
static virusHandling($a_file, $a_orig_name="", $a_clean=true)
scan file for viruses and clean files if possible
getPostVar()
Get Post Variable.
$index
Definition: metadata.php:60
setAlert($a_alert)
Set Alert Text.
$filename
Definition: buildRTE.php:89
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ collectValidFiles()

ilKprimChoiceWizardInputGUI::collectValidFiles ( )

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

References $index, and ilFormPropertyGUI\getPostVar().

423  {
424  foreach ($_FILES[$this->getPostVar()]['error']['image'] as $index => $err) {
425  if ($err > 0) {
426  continue;
427  }
428 
429  $this->files[$index] = array(
430  'position' => $index,
431  'tmp_name' => $_FILES[$this->getPostVar()]['tmp_name']['image'][$index],
432  'name' => $_FILES[$this->getPostVar()]['name']['image'][$index],
433  'type' => $_FILES[$this->getPostVar()]['type']['image'][$index],
434  'size' => $_FILES[$this->getPostVar()]['size']['image'][$index]
435  );
436  }
437  }
getPostVar()
Get Post Variable.
$index
Definition: metadata.php:60
+ Here is the call graph for this function:

◆ getFiles()

ilKprimChoiceWizardInputGUI::getFiles ( )

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

References $files.

◆ isIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::isIgnoreMissingUploadsEnabled ( )

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

References $ignoreMissingUploadsEnabled.

Referenced by checkUploads().

+ Here is the caller graph for this function:

◆ setFiles()

ilKprimChoiceWizardInputGUI::setFiles (   $files)

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

References $files.

◆ setIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::setIgnoreMissingUploadsEnabled (   $ignoreMissingUploadsEnabled)

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

References $ignoreMissingUploadsEnabled.

63  {
64  $this->ignoreMissingUploadsEnabled = $ignoreMissingUploadsEnabled;
65  }

◆ setValue()

ilKprimChoiceWizardInputGUI::setValue (   $a_value)

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

References $index, and ilTextInputGUI\$value.

73  {
74  $this->values = array();
75 
76  if (is_array($a_value) && is_array($a_value['answer'])) {
77  foreach ($a_value['answer'] as $index => $value) {
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  $answer->setCorrectness((bool) $a_value['correctness'][$index]);
86  }
87 
88  $answer->setThumbPrefix($this->qstObject->getThumbPrefix());
89  $answer->setImageFsDir($this->qstObject->getImagePath());
90  $answer->setImageWebDir($this->qstObject->getImagePathWeb());
91 
92  $this->values[] = $answer;
93  }
94  }
95 
96  #vd($this->values);
97  }
$index
Definition: metadata.php:60

Field Documentation

◆ $files

ilKprimChoiceWizardInputGUI::$files
private

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

Referenced by getFiles(), and setFiles().

◆ $ignoreMissingUploadsEnabled

ilKprimChoiceWizardInputGUI::$ignoreMissingUploadsEnabled
private

◆ $lng

ilKprimChoiceWizardInputGUI::$lng
protected

◆ $qstObject

ilKprimChoiceWizardInputGUI::$qstObject
protected

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

◆ $tpl

ilKprimChoiceWizardInputGUI::$tpl
protected

◆ 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: