ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
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...
 

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 $lng, $tpl, array, and files.

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  }
Create styles array
The data for the language used.
Done writing files

Member Function Documentation

◆ checkInput()

ilKprimChoiceWizardInputGUI::checkInput ( )

Definition at line 97 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.

98  {
99  global $lng;
100 
101  include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
102  if (is_array($_POST[$this->getPostVar()])) {
104  $_POST[$this->getPostVar()],
105  false,
107  );
108  }
109 
110  $foundvalues = $_POST[$this->getPostVar()];
111 
112  #vd($foundvalues);
113 
114  if (is_array($foundvalues)) {
115  // check answers
116  if (is_array($foundvalues['answer'])) {
117  foreach ($foundvalues['answer'] as $aidx => $answervalue) {
118  if (((strlen($answervalue)) == 0) && (strlen($foundvalues['imagename'][$aidx]) == 0)) {
119  $this->setAlert($lng->txt("msg_input_is_required"));
120  return false;
121  }
122  }
123  }
124 
125  // check correctness
126  if (!isset($foundvalues['correctness']) || count($foundvalues['correctness']) < count($foundvalues['answer'])) {
127  $this->setAlert($lng->txt("msg_input_is_required"));
128  return false;
129  }
130 
131  if (!$this->checkUploads($foundvalues)) {
132  return false;
133  }
134  } else {
135  $this->setAlert($lng->txt("msg_input_is_required"));
136  return false;
137  }
138 
139  return $this->checkSubItemsInput();
140  }
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.
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 304 of file class.ilKprimChoiceWizardInputGUI.php.

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

Referenced by checkInput().

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

◆ collectValidFiles()

ilKprimChoiceWizardInputGUI::collectValidFiles ( )

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

References $index, array, files, and ilFormPropertyGUI\getPostVar().

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

◆ getFiles()

ilKprimChoiceWizardInputGUI::getFiles ( )

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

References $files.

◆ isIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::isIgnoreMissingUploadsEnabled ( )

Definition at line 65 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 50 of file class.ilKprimChoiceWizardInputGUI.php.

References $files, and files.

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

◆ 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 $index, ilTextInputGUI\$value, and array.

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

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

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: