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 ($value)

	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)

	setValueByArray (array $a_values)

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

	setPending (string $val)

	checkInput ()
	Check input, strip slashes etc. More...

	insert (ilTemplate $a_tpl)

Public Member Functions inherited from ilTextInputGUI
	__construct (string $a_title="", string $a_postvar="")

	setValue ($a_value)

	getValue ()

	setValidationFailureMessage (string $a_msg)

	getValidationFailureMessage ()

	setValidationRegexp (string $a_value)

	getValidationRegexp ()

	setMaxLength (?int $a_maxlength)

	getMaxLength ()

	setSize (int $a_size)

	setInlineStyle (string $a_style)

	getInlineStyle ()

	setCssClass (string $a_class)

	getCssClass ()

	setValueByArray (array $a_values)

	getSize ()

	setSuffix (string $a_value)

	getSuffix ()

	setInputType (string $a_type)
	set input type More...

	getInputType ()

	setSubmitFormOnEnter (bool $a_val)

	getSubmitFormOnEnter ()

	checkInput ()
	Check input, strip slashes etc. More...

	getInput ()

	getDataSource ()

	setDataSource (string $href, string $a_delimiter=null)

	setDataSourceSubmitOnSelection (bool $a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl (string $a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)

	render (string $a_mode="")

	insert (ilTemplate $a_tpl)

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

	setDisableHtmlAutoComplete (bool $autocomplete)

	isHtmlAutoCompleteDisabled ()

	getPostValueForComparison ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback (string $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...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. 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
	$tpl

	$qstObject

Protected Attributes inherited from ilSingleChoiceWizardInputGUI
	$values = []

	$allowMove = false

	$singleline = true

	$qstObject = null

	$suffixes = []

	$showPoints = true

	$hideImages = false

ArrayBasedRequestWrapper	$post_wrapper

Protected Attributes inherited from ilTextInputGUI
	$value = null

int	$maxlength = 200

int	$size = 40

string	$validationRegexp = ""

string	$validationFailureMessage = ''

string	$suffix = ""

string	$style_css = ""

string	$css_class = ""

string	$ajax_datasource = ""

string	$ajax_datasource_delimiter = null

bool	$ajax_datasource_commit = false

string	$ajax_datasource_commit_url = ""

bool	$submit_form_on_enter = false

bool	$autocomplete_disabled = false

string	$input_type = ""

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Private Member Functions
	cleanupAnswerText (array $answer_text, bool $is_rte)
	sk - 12.05.2023: This is one more of those that we need, but don't want. More...

Private Attributes
	$files

	$ignoreMissingUploadsEnabled

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

Definition at line 29 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 47 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, ilFormPropertyGUI\$lng, $tpl, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

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 115 of file class.ilKprimChoiceWizardInputGUI.php.

                                : bool
    {
        global $DIC;
        $lng = $DIC['lng'];
 
        include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
        if (is_array($_POST[$this->getPostVar()])) {
            $foundvalues = ilArrayUtil::stripSlashesRecursive(
                $_POST[$this->getPostVar()],
                false,
                ilObjAdvancedEditing::_getUsedHTMLTagsAsString("assessment")
            );
        } else {
            $foundvalues = $_POST[$this->getPostVar()];
        }
 
        if (is_array($foundvalues)) {
            // check answers
            if (is_array($foundvalues['answer'])) {
                foreach ($foundvalues['answer'] as $aidx => $answervalue) {
                    $hasImage = isset($foundvalues['imagename']) ? true : false;
                    if (((strlen($answervalue)) == 0) && !$hasImage) {
                        $this->setAlert($lng->txt("msg_input_is_required"));
                        return false;
                    }
 
                    if (mb_strlen($answervalue) > $this->getMaxLength()) {
                        $this->setAlert($lng->txt("msg_input_char_limit_max"));
                        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 $DIC, ilFormPropertyGUI\$lng, ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), ilSubEnabledFormPropertyGUI\checkSubItemsInput(), checkUploads(), ilTextInputGUI\getMaxLength(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\setAlert(), ilArrayUtil\stripSlashesRecursive(), true, and ilLanguage\txt().

Here is the call graph for this function:

◆ checkUploads()

ilKprimChoiceWizardInputGUI::checkUploads ( $foundvalues )

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

                                              : bool
    {
        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_FORM_SIZE:
                                case UPLOAD_ERR_INI_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()) {
                                        $has_image = isset($foundvalues['imagename'][$index]) ? true : false;
                                        if (!$has_image && (!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);
                        if (isset($filename_arr["extension"])) {
                            $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);
                        if (isset($filename_arr["extension"])) {
                            $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 = ilVirusScanner::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(), ILIAS\Repository\lng(), ilFormPropertyGUI\setAlert(), true, and ilVirusScanner\virusHandling().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cleanupAnswerText()

ilKprimChoiceWizardInputGUI::cleanupAnswerText	(	array	$answer_text,
		bool	$is_rte
	)

private

sk - 12.05.2023: This is one more of those that we need, but don't want.

Deprecated:

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

                                                                        : array
    {
        if (!is_array($answer_text)) {
            return [];
        }
 
        if ($is_rte) {
            return ilArrayUtil::stripSlashesRecursive(
                $answer_text,
                false,
                ilObjAdvancedEditing::_getUsedHTMLTagsAsString("assessment")
            );
        }
 
        return ilArrayUtil::stripSlashesRecursive(
            $answer_text,
            true,
            assQuestionGUI::ALLOWED_PLAIN_TEXT_TAGS
        );
    }

References ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), assQuestionGUI\ALLOWED_PLAIN_TEXT_TAGS, and ilArrayUtil\stripSlashesRecursive().

Referenced by setValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectValidFiles()

ilKprimChoiceWizardInputGUI::collectValidFiles ( )

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

                                       : void
    {
        foreach ($_FILES[$this->getPostVar()]['error']['image'] as $index => $err) {
            if ($err > 0) {
                continue;
            }
 
            $this->files[$index] = array(
                '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 68 of file class.ilKprimChoiceWizardInputGUI.php.

                              : array
    {
        return $this->files;
    }

References $files.

◆ isIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::isIgnoreMissingUploadsEnabled ( )

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

                                                   : bool
    {
        return $this->ignoreMissingUploadsEnabled;
    }

References $ignoreMissingUploadsEnabled.

Referenced by checkUploads().

Here is the caller graph for this function:

◆ setFiles()

ilKprimChoiceWizardInputGUI::setFiles ( $files )

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

                                    : void
    {
        $this->files = $files;
    }

References $files.

◆ setIgnoreMissingUploadsEnabled()

ilKprimChoiceWizardInputGUI::setIgnoreMissingUploadsEnabled ( $ignoreMissingUploadsEnabled )

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

                                                                                : void
    {
        $this->ignoreMissingUploadsEnabled = $ignoreMissingUploadsEnabled;
    }

References $ignoreMissingUploadsEnabled.

◆ setValue()

ilKprimChoiceWizardInputGUI::setValue ( $a_value )

Parameters

string | array $a_value

Reimplemented from ilSingleChoiceWizardInputGUI.

Reimplemented in ilKprimChoiceCorrectionsInputGUI.

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

                                    : void
    {
        $this->values = [];
 
        $is_rte = isset($_POST["answer_type"]) &&  $_POST["answer_type"] == "multiLine";
        $a_value = $this->cleanupAnswerText($value, $is_rte);
 
        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);
                if (isset($a_value['imagename'])) {
                    $answer->setImageFile($a_value['imagename'][$index] ?? '');
                }
 
                if (isset($a_value['correctness']) && isset($a_value['correctness'][$index]) && 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);
    }