ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
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
const ALLOWED_PAGE_HTML_TAGS = '<em>, <strong>'
 
 $values = []
 
 $allowMove = false
 
 $singleline = true
 
 $qstObject = null
 
 $suffixes = []
 
 $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, $tpl, and ILIAS\GlobalScreen\Provider\__construct().

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 = [];
48 
49  $this->ignoreMissingUploadsEnabled = false;
50  }
global $DIC
Definition: goto.php:24
__construct(Container $dic, ilPlugin $plugin)
+ Here is the call graph for this function:

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(), ilSingleChoiceWizardInputGUI\ALLOWED_PAGE_HTML_TAGS, 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 
106  if (is_array($_POST[$this->getPostVar()]) && $_POST["answer_type"] == "multiLine") {
109  } elseif (is_array($_POST[$this->getPostVar()]) && $_POST["answer_type"] == "singleLine") {
112  }
113 
114  $foundvalues = $_POST[$this->getPostVar()];
115 
116  #vd($foundvalues);
117 
118  if (is_array($foundvalues)) {
119  // check answers
120  if (is_array($foundvalues['answer'])) {
121  foreach ($foundvalues['answer'] as $aidx => $answervalue) {
122  if (((strlen($answervalue)) == 0) && (strlen($foundvalues['imagename'][$aidx]) == 0)) {
123  $this->setAlert($lng->txt("msg_input_is_required"));
124  return false;
125  }
126  }
127  }
128 
129  // check correctness
130  if (!isset($foundvalues['correctness']) || count($foundvalues['correctness']) < count($foundvalues['answer'])) {
131  $this->setAlert($lng->txt("msg_input_is_required"));
132  return false;
133  }
134 
135  if (!$this->checkUploads($foundvalues)) {
136  return false;
137  }
138  } else {
139  $this->setAlert($lng->txt("msg_input_is_required"));
140  return false;
141  }
142 
143  return $this->checkSubItemsInput();
144  }
static _getUsedHTMLTagsAsString($a_module="")
Returns a string of all allowed HTML tags for text editing.
getPostVar()
Get Post Variable.
setAlert($a_alert)
Set Alert Text.
global $DIC
Definition: goto.php:24
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 308 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().

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

References $index, and ilFormPropertyGUI\getPostVar().

424  {
425  foreach ($_FILES[$this->getPostVar()]['error']['image'] as $index => $err) {
426  if ($err > 0) {
427  continue;
428  }
429 
430  $this->files[$index] = [
431  'position' => $index,
432  'tmp_name' => $_FILES[$this->getPostVar()]['tmp_name']['image'][$index],
433  'name' => $_FILES[$this->getPostVar()]['name']['image'][$index],
434  'type' => $_FILES[$this->getPostVar()]['type']['image'][$index],
435  'size' => $_FILES[$this->getPostVar()]['size']['image'][$index]
436  ];
437  }
438  }
getPostVar()
Get Post Variable.
$index
Definition: metadata.php:128
+ 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.

53  {
54  $this->files = $files;
55  }

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

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: