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...
	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...
	getFormLabelFor ()
	Get label "for" attribute value for form. More...
Public Member Functions inherited from ilTableFilterItem
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...
	getTableFilterLabelFor ()
	Get label "for" attribute value. 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
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 = ""
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilSingleChoiceWizardInputGUI.

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

    {
        parent::__construct($a_title, $a_postvar);
        
        global $DIC;
        $lng = $DIC['lng'];
        $tpl = $DIC['tpl'];
        
        $this->lng = $lng;
        $this->tpl = $tpl;
        
        $this->files = [];
 
        $this->ignoreMissingUploadsEnabled = false;
    }

References $DIC, $lng, $tpl, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

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.

Reimplemented in ilKprimChoiceCorrectionsInputGUI.

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

    {
        global $DIC;
        $lng = $DIC['lng'];
 
        include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
 
        if (is_array($_POST[$this->getPostVar()]) && $_POST["answer_type"] == "multiLine") {
            $_POST[$this->getPostVar()] = ilUtil::stripSlashesRecursive($_POST[$this->getPostVar()],
                false, ilObjAdvancedEditing::_getUsedHTMLTagsAsString("assessment"));
        } elseif (is_array($_POST[$this->getPostVar()]) && $_POST["answer_type"] == "singleLine") {
            $_POST[$this->getPostVar()] = ilUtil::stripSlashesRecursive($_POST[$this->getPostVar()],
                true, ilSingleChoiceWizardInputGUI::ALLOWED_PAGE_HTML_TAGS);
        }
 
        $foundvalues = $_POST[$this->getPostVar()];
        
        #vd($foundvalues);
        
        if (is_array($foundvalues)) {
            // check answers
            if (is_array($foundvalues['answer'])) {
                foreach ($foundvalues['answer'] as $aidx => $answervalue) {
                    if (((strlen($answervalue)) == 0) && (strlen($foundvalues['imagename'][$aidx]) == 0)) {
                        $this->setAlert($lng->txt("msg_input_is_required"));
                        return false;
                    }
                }
            }
            
            // check correctness
            if (!isset($foundvalues['correctness']) || count($foundvalues['correctness']) < count($foundvalues['answer'])) {
                $this->setAlert($lng->txt("msg_input_is_required"));
                return false;
            }
 
            if (!$this->checkUploads($foundvalues)) {
                return false;
            }
        } else {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
 
        return $this->checkSubItemsInput();
    }

References $_POST, $DIC, $lng, ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), ilSingleChoiceWizardInputGUI\ALLOWED_PAGE_HTML_TAGS, 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 308 of file class.ilKprimChoiceWizardInputGUI.php.

    {
        if (is_array($_FILES) && count($_FILES) && $this->getSingleline()) {
            if (!$this->hideImages) {
                if (is_array($_FILES[$this->getPostVar()]['error']['image'])) {
                    foreach ($_FILES[$this->getPostVar()]['error']['image'] as $index => $error) {
                        // error handling
                        if ($error > 0) {
                            switch ($error) {
                                case UPLOAD_ERR_INI_SIZE:
                                    $this->setAlert($this->lng->txt("form_msg_file_size_exceeds"));
                                    return false;
                                    break;
 
                                case UPLOAD_ERR_FORM_SIZE:
                                    $this->setAlert($this->lng->txt("form_msg_file_size_exceeds"));
                                    return false;
                                    break;
 
                                case UPLOAD_ERR_PARTIAL:
                                    $this->setAlert($this->lng->txt("form_msg_file_partially_uploaded"));
                                    return false;
                                    break;
 
                                case UPLOAD_ERR_NO_FILE:
                                    if ($this->getRequired() && !$this->isIgnoreMissingUploadsEnabled()) {
                                        if ((!strlen($foundvalues['imagename'][$index])) && (!strlen($foundvalues['answer'][$index]))) {
                                            $this->setAlert($this->lng->txt("form_msg_file_no_upload"));
                                            return false;
                                        }
                                    }
                                    break;
 
                                case UPLOAD_ERR_NO_TMP_DIR:
                                    $this->setAlert($this->lng->txt("form_msg_file_missing_tmp_dir"));
                                    return false;
                                    break;
 
                                case UPLOAD_ERR_CANT_WRITE:
                                    $this->setAlert($this->lng->txt("form_msg_file_cannot_write_to_disk"));
                                    return false;
                                    break;
 
                                case UPLOAD_ERR_EXTENSION:
                                    $this->setAlert($this->lng->txt("form_msg_file_upload_stopped_ext"));
                                    return false;
                                    break;
                            }
                        }
                    }
                } else {
                    if ($this->getRequired()) {
                        $this->setAlert($this->lng->txt("form_msg_file_no_upload"));
                        return false;
                    }
                }
 
                if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image'])) {
                    foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname) {
                        $filename = $_FILES[$this->getPostVar()]['name']['image'][$index];
                        $filename_arr = pathinfo($filename);
                        $suffix = $filename_arr["extension"];
                        $mimetype = $_FILES[$this->getPostVar()]['type']['image'][$index];
                        $size_bytes = $_FILES[$this->getPostVar()]['size']['image'][$index];
                        // check suffixes
                        if (strlen($tmpname) && is_array($this->getSuffixes())) {
                            if (!in_array(strtolower($suffix), $this->getSuffixes())) {
                                $this->setAlert($this->lng->txt("form_msg_file_wrong_file_type"));
                                return false;
                            }
                        }
                    }
                }
 
                if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image'])) {
                    foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname) {
                        if ($_FILES[$this->getPostVar()]['error']['image'][$index] > 0) {
                            continue;
                        }
 
                        $mimetype = ilObjMediaObject::getMimeType($tmpname);
 
                        if (!preg_match("/^image/", $mimetype)) {
                            $_FILES[$this->getPostVar()]['error']['image'][$index] = self::CUSTOM_UPLOAD_ERR;
                            $this->setAlert($this->lng->txt("form_msg_file_wrong_mime_type"));
                            return false;
                        }
                    }
                }
 
 
                if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image'])) {
                    foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname) {
                        $filename = $_FILES[$this->getPostVar()]['name']['image'][$index];
                        $filename_arr = pathinfo($filename);
                        $suffix = $filename_arr["extension"];
                        $mimetype = $_FILES[$this->getPostVar()]['type']['image'][$index];
                        $size_bytes = $_FILES[$this->getPostVar()]['size']['image'][$index];
                        // virus handling
                        if (strlen($tmpname)) {
                            $vir = ilUtil::virusHandling($tmpname, $filename);
                            if ($vir[0] == false) {
                                $_FILES[$this->getPostVar()]['error']['image'][$index] = self::CUSTOM_UPLOAD_ERR;
                                $this->setAlert($this->lng->txt("form_msg_file_virus_found") . "<br />" . $vir[1]);
                                return false;
                            }
                        }
                    }
                }
            }
        }
        
        return true;
    }

References $filename, $index, 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 423 of file class.ilKprimChoiceWizardInputGUI.php.

    {
        foreach ($_FILES[$this->getPostVar()]['error']['image'] as $index => $err) {
            if ($err > 0) {
                continue;
            }
 
            $this->files[$index] = [
                'position' => $index,
                'tmp_name' => $_FILES[$this->getPostVar()]['tmp_name']['image'][$index],
                'name' => $_FILES[$this->getPostVar()]['name']['image'][$index],
                'type' => $_FILES[$this->getPostVar()]['type']['image'][$index],
                'size' => $_FILES[$this->getPostVar()]['size']['image'][$index]
            ];
        }
    }

References $index, and ilFormPropertyGUI\getPostVar().

Here is the call graph for this function:

getFiles()

ilKprimChoiceWizardInputGUI::getFiles

(

)

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

    {
        return $this->files;
    }

References $files.

isIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::isIgnoreMissingUploadsEnabled

(

)

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

    {
        return $this->ignoreMissingUploadsEnabled;
    }

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.

    {
        $this->files = $files;
    }

References $files.

setIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::setIgnoreMissingUploadsEnabled

(

$ignoreMissingUploadsEnabled

)

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

    {
        $this->ignoreMissingUploadsEnabled = $ignoreMissingUploadsEnabled;
    }

References $ignoreMissingUploadsEnabled.

setValue()

ilKprimChoiceWizardInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

Reimplemented from ilSingleChoiceWizardInputGUI.

Reimplemented in ilKprimChoiceCorrectionsInputGUI.

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

    {
        $this->values = array();
        
        if (is_array($a_value) && is_array($a_value['answer'])) {
            foreach ($a_value['answer'] as $index => $value) {
                $answer = new ilAssKprimChoiceAnswer();
 
                $answer->setPosition($index);
                $answer->setAnswertext($value);
                $answer->setImageFile($a_value['imagename'][$index]);
                
                if (strlen($a_value['correctness'][$index])) {
                    $answer->setCorrectness((bool) $a_value['correctness'][$index]);
                }
 
                $answer->setThumbPrefix($this->qstObject->getThumbPrefix());
                $answer->setImageFsDir($this->qstObject->getImagePath());
                $answer->setImageWebDir($this->qstObject->getImagePathWeb());
                
                $this->values[] = $answer;
            }
        }
        
        #vd($this->values);
    }

References $index, and 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

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(), checkInput(), and ilKprimChoiceCorrectionsInputGUI\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:

• Modules/TestQuestionPool/classes/class.ilKprimChoiceWizardInputGUI.php