ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilKprimChoiceWizardInputGUI Class Reference
+ Inheritance diagram for ilKprimChoiceWizardInputGUI:
+ Collaboration diagram for ilKprimChoiceWizardInputGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
 setFiles ($files)
 
 getFiles ()
 
 setIgnoreMissingUploadsEnabled ($ignoreMissingUploadsEnabled)
 
 isIgnoreMissingUploadsEnabled ()
 
 setValue ($a_value)
 Set Value. More...
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 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)
 Set multi values. More...
 
 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...
 
 getTableFilterHTML ()
 Get input item HTML to be inserted into table filters. More...
 
 getToolbarHTML ()
 Get input item HTML to be inserted into ilToolbarGUI. 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

- 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 = "" 
)

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Reimplemented from ilSingleChoiceWizardInputGUI.

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

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 }

References $lng, and $tpl.

Member Function Documentation

◆ checkInput()

ilKprimChoiceWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

Reimplemented from ilSingleChoiceWizardInputGUI.

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

101 {
102 global $lng;
103
104 include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
105 if( is_array($_POST[$this->getPostVar()]) )
106 {
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["username"]
getPostVar()
Get Post Variable.
setAlert($a_alert)
Set Alert Text.
static _getUsedHTMLTagsAsString($a_module="")
Returns a string of all allowed HTML tags for text editing.
static stripSlashesRecursive($a_data, $a_strip_html=true, $a_allow="")
Strip slashes from array and sub-arrays.

References $_POST, $lng, ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), ilSubEnabledFormPropertyGUI\checkSubItemsInput(), checkUploads(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashesRecursive().

+ Here is the call graph for this function:

◆ checkUploads()

ilKprimChoiceWizardInputGUI::checkUploads (   $foundvalues)

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

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

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

Referenced by checkInput().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ collectValidFiles()

ilKprimChoiceWizardInputGUI::collectValidFiles ( )

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

473 {
474 foreach($_FILES[$this->getPostVar()]['error']['image'] as $index => $err)
475 {
476 if( $err > 0 )
477 {
478 continue;
479 }
480
481 $this->files[$index] = array(
482 'position' => $index,
483 'tmp_name' => $_FILES[$this->getPostVar()]['tmp_name']['image'][$index],
484 'name' => $_FILES[$this->getPostVar()]['name']['image'][$index],
485 'type' => $_FILES[$this->getPostVar()]['type']['image'][$index],
486 'size' => $_FILES[$this->getPostVar()]['size']['image'][$index]
487 );
488 }
489 }

References ilFormPropertyGUI\getPostVar().

+ Here is the call graph for this function:

◆ getFiles()

ilKprimChoiceWizardInputGUI::getFiles ( )

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

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

References $files.

◆ setIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::setIgnoreMissingUploadsEnabled (   $ignoreMissingUploadsEnabled)

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

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

References $ignoreMissingUploadsEnabled.

◆ setValue()

ilKprimChoiceWizardInputGUI::setValue (   $a_value)

Set Value.

Parameters
string$a_valueValue

Reimplemented from ilSingleChoiceWizardInputGUI.

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

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 }

References ilTextInputGUI\$value.

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().

◆ CUSTOM_UPLOAD_ERR

const ilKprimChoiceWizardInputGUI::CUSTOM_UPLOAD_ERR = 99

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

Referenced by checkUploads().


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