This class represents a key value pair wizard property in a property form. More...

Inheritance diagram for ilErrorTextWizardInputGUI:

Collaboration diagram for ilErrorTextWizardInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setValue ($a_value)

	setKeySize ($a_size)
	Set key size. More...

	getKeySize ()
	Get key size. More...

	setValueSize ($a_size)
	Set value size. More...

	getValueSize ()
	Get value size. More...

	setKeyMaxlength ($a_maxlength)
	Set key maxlength. More...

	getKeyMaxlength ()
	Get key maxlength. More...

	setValueMaxlength ($a_maxlength)
	Set value maxlength. More...

	getValueMaxlength ()
	Get value maxlength. More...

	setValueName ($a_name)
	Set value name. More...

	getValueName ()
	Get value name. More...

	setKeyName ($a_name)
	Set key name. More...

	getKeyName ()
	Get key name. More...

	setValues ($a_values)
	Set Values. More...

	getValues ()
	Get Values. More...

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

	insert (ilTemplate $a_tpl)
	Insert property html. More...

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

Protected Attributes
	$values = []

	$key_size = 20

	$value_size = 20

	$key_maxlength = 255

	$value_maxlength = 150

	$key_name = ""

	$value_name = ""

ilTestLegacyFormsHelper	$forms_helper

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

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

	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

This class represents a key value pair wizard property in a property form.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version: $Id$

Definition at line 29 of file class.ilErrorTextWizardInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilErrorTextWizardInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 47 of file class.ilErrorTextWizardInputGUI.php.

    {
        parent::__construct($a_title, $a_postvar);
        $this->forms_helper = new ilTestLegacyFormsHelper();
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilErrorTextWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilTextInputGUI.

Reimplemented in ilAssErrorTextCorrectionsInputGUI.

Definition at line 212 of file class.ilErrorTextWizardInputGUI.php.

                                : bool
    {
        $kindlyTo = $this->refinery->kindlyTo();
        $data = $this->raw($this->getPostVar());
 
        if (!is_array($data)) {
            $this->setAlert($this->lng->txt('errortext_info'));
            return false;
        }
 
        // check points
        $points = $this->forms_helper->checkPointsInput($data, $this->getRequired());
        if (!is_array($points)) {
            $this->setAlert($this->lng->txt($points));
            return false;
        }
        foreach ($points as $point) {
            if ($point <= 0) {
                $this->setAlert($this->lng->txt('positive_numbers_required'));
                return false;
            }
        }
 
        // check answers
        $keys = $this->forms_helper->transformArray($data, 'key', $kindlyTo->string());
        $values = $this->forms_helper->transformArray($data, 'value', $kindlyTo->string());
        if (empty($keys) || empty($values)) {
            $this->setAlert($this->lng->txt('msg_input_is_required'));
            return false;
        }
        foreach ([$keys, $values] as $array) {
            foreach ($array as $item) {
                if ($item === '' && $this->getRequired()) {
                    $this->setAlert($this->lng->txt('msg_input_is_required'));
                    return false;
                }
            }
        }
 
        return $this->checkSubItemsInput();
    }

References $data, $values, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ILIAS\Repository\lng(), ilFormPropertyGUI\raw(), ILIAS\Repository\refinery(), and ilFormPropertyGUI\setAlert().

Here is the call graph for this function:

◆ getKeyMaxlength()

ilErrorTextWizardInputGUI::getKeyMaxlength ( )

Get key maxlength.

Returns: integer Key maxlength

Definition at line 123 of file class.ilErrorTextWizardInputGUI.php.

                                     : int
    {
        return $this->key_maxlength;
    }

References $key_maxlength.

Referenced by insert(), and ilAssErrorTextCorrectionsInputGUI\insert().

Here is the caller graph for this function:

◆ getKeyName()

ilErrorTextWizardInputGUI::getKeyName ( )

Get key name.

Returns: string value name

Definition at line 183 of file class.ilErrorTextWizardInputGUI.php.

                                : string
    {
        return $this->key_name;
    }

References $key_name.

Referenced by insert(), and ilAssErrorTextCorrectionsInputGUI\insert().

Here is the caller graph for this function:

◆ getKeySize()

ilErrorTextWizardInputGUI::getKeySize ( )

Get key size.

Returns: integer Key size

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

                                : int
    {
        return $this->key_size;
    }

References $key_size.

Referenced by insert(), and ilAssErrorTextCorrectionsInputGUI\insert().

Here is the caller graph for this function:

◆ getValueMaxlength()

ilErrorTextWizardInputGUI::getValueMaxlength ( )

Get value maxlength.

Returns: integer value maxlength

Definition at line 143 of file class.ilErrorTextWizardInputGUI.php.

                                       : int
    {
        return $this->value_maxlength;
    }

References $value_maxlength.

Referenced by insert(), and ilAssErrorTextCorrectionsInputGUI\insert().

Here is the caller graph for this function:

◆ getValueName()

ilErrorTextWizardInputGUI::getValueName ( )

Get value name.

Returns: string value name

Definition at line 163 of file class.ilErrorTextWizardInputGUI.php.

                                  : string
    {
        return $this->value_name;
    }

References $value_name.

Referenced by insert(), and ilAssErrorTextCorrectionsInputGUI\insert().

Here is the caller graph for this function:

◆ getValues()

ilErrorTextWizardInputGUI::getValues ( )

Get Values.

Returns: array Values

Definition at line 203 of file class.ilErrorTextWizardInputGUI.php.

                               : array
    {
        return $this->values;
    }

References $values.

◆ getValueSize()

ilErrorTextWizardInputGUI::getValueSize ( )

Get value size.

Returns: integer value size

Definition at line 103 of file class.ilErrorTextWizardInputGUI.php.

                                  : int
    {
        return $this->value_size;
    }

References $value_size.

Referenced by insert(), and ilAssErrorTextCorrectionsInputGUI\insert().

Here is the caller graph for this function:

◆ insert()

ilErrorTextWizardInputGUI::insert ( ilTemplate $a_tpl )

Insert property html.

Returns: void Size

Reimplemented from ilTextInputGUI.

Reimplemented in ilAssErrorTextCorrectionsInputGUI.

Definition at line 258 of file class.ilErrorTextWizardInputGUI.php.

                                             : void
    {
        global $DIC;
        $lng = $DIC['lng'];
 
        $tpl = new ilTemplate("tpl.prop_errortextwizardinput.html", true, true, "components/ILIAS/TestQuestionPool");
        $i = 0;
        foreach ($this->values as $value) {
            if (is_object($value)) {
                if (strlen($value->getTextWrong())) {
                    $tpl->setCurrentBlock("prop_key_propval");
                    $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($value->getTextWrong()));
                    $tpl->parseCurrentBlock();
                }
                if (strlen($value->getTextCorrect())) {
                    $tpl->setCurrentBlock("prop_value_propval");
                    $tpl->setVariable(
                        "PROPERTY_VALUE",
                        ilLegacyFormElementsUtil::prepareFormOutput($value->getTextCorrect())
                    );
                    $tpl->parseCurrentBlock();
                }
                if (strlen($value->getPoints())) {
                    $tpl->setCurrentBlock("prop_points_propval");
                    $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($value->getPoints()));
                    $tpl->parseCurrentBlock();
                }
            }
 
            $tpl->setCurrentBlock("row");
            $class = ($i % 2 == 0) ? "even" : "odd";
            if ($i == 0) {
                $class .= " first";
            }
            if ($i == count($this->values) - 1) {
                $class .= " last";
            }
            $tpl->setVariable("ROW_CLASS", $class);
            $tpl->setVariable("ROW_NUMBER", $i);
 
            $tpl->setVariable("KEY_SIZE", $this->getKeySize());
            $tpl->setVariable("KEY_ID", $this->getPostVar() . "[key][$i]");
            $tpl->setVariable("KEY_MAXLENGTH", $this->getKeyMaxlength());
 
            $tpl->setVariable("VALUE_SIZE", $this->getValueSize());
            $tpl->setVariable("VALUE_ID", $this->getPostVar() . "[value][$i]");
            $tpl->setVariable("VALUE_MAXLENGTH", $this->getValueMaxlength());
 
            $tpl->setVariable("POST_VAR", $this->getPostVar());
 
            $tpl->parseCurrentBlock();
 
            $i++;
        }
        $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
        $tpl->setVariable("KEY_TEXT", $this->getKeyName());
        $tpl->setVariable("VALUE_TEXT", $this->getValueName());
        $tpl->setVariable("POINTS_TEXT", $lng->txt('points'));
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
        $a_tpl->parseCurrentBlock();
    }

References $DIC, ilFormPropertyGUI\$lng, ilTextInputGUI\$value, getKeyMaxlength(), getKeyName(), getKeySize(), ilFormPropertyGUI\getPostVar(), getValueMaxlength(), getValueName(), getValueSize(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

Here is the call graph for this function:

◆ setKeyMaxlength()

ilErrorTextWizardInputGUI::setKeyMaxlength ( $a_maxlength )

Set key maxlength.

Parameters

integer $a_size Key maxlength

Definition at line 113 of file class.ilErrorTextWizardInputGUI.php.

                                                 : void
    {
        $this->key_maxlength = $a_maxlength;
    }

◆ setKeyName()

ilErrorTextWizardInputGUI::setKeyName ( $a_name )

Set key name.

Parameters

string $a_name value name

Definition at line 173 of file class.ilErrorTextWizardInputGUI.php.

                                       : void
    {
        $this->key_name = $a_name;
    }

◆ setKeySize()

ilErrorTextWizardInputGUI::setKeySize ( $a_size )

Set key size.

Parameters

integer $a_size Key size

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

                                       : void
    {
        $this->key_size = $a_size;
    }

◆ setValue()

ilErrorTextWizardInputGUI::setValue ( $a_value )

Parameters

string | array $a_value

Reimplemented from ilTextInputGUI.

Reimplemented in ilAssErrorTextCorrectionsInputGUI.

Definition at line 53 of file class.ilErrorTextWizardInputGUI.php.

                                      : void
    {
        $keys = $this->forms_helper->transformArray($a_value, 'key', $this->refinery->kindlyTo()->string());
        $points = $this->forms_helper->transformPoints($a_value);
 
        $this->values = [];
        foreach ($keys as $index => $key) {
            $this->values[] = new assAnswerErrorText(
                $key,
                $a_value['value'][$index] ?? '',
                $points[$index] ?? 0.0
            );
        }
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ setValueMaxlength()

ilErrorTextWizardInputGUI::setValueMaxlength ( $a_maxlength )

Set value maxlength.

Parameters

integer $a_size value maxlength

Definition at line 133 of file class.ilErrorTextWizardInputGUI.php.

                                                   : void
    {
        $this->value_maxlength = $a_maxlength;
    }

◆ setValueName()

ilErrorTextWizardInputGUI::setValueName ( $a_name )

Set value name.

Parameters

string $a_name value name

Definition at line 153 of file class.ilErrorTextWizardInputGUI.php.

                                         : void
    {
        $this->value_name = $a_name;
    }

◆ setValues()

ilErrorTextWizardInputGUI::setValues ( $a_values )

Set Values.

Parameters

array $a_value Value

Definition at line 193 of file class.ilErrorTextWizardInputGUI.php.

                                        : void
    {
        $this->values = $a_values;
    }

◆ setValueSize()

ilErrorTextWizardInputGUI::setValueSize ( $a_size )

Set value size.

Parameters

integer $a_size value size

Definition at line 93 of file class.ilErrorTextWizardInputGUI.php.

                                         : void
    {
        $this->value_size = $a_size;
    }

Field Documentation

◆ $forms_helper

ilTestLegacyFormsHelper ilErrorTextWizardInputGUI::$forms_helper

protected

Definition at line 39 of file class.ilErrorTextWizardInputGUI.php.

◆ $key_maxlength

ilErrorTextWizardInputGUI::$key_maxlength = 255

protected

Definition at line 34 of file class.ilErrorTextWizardInputGUI.php.

Referenced by getKeyMaxlength().

◆ $key_name

ilErrorTextWizardInputGUI::$key_name = ""

protected

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

Referenced by getKeyName().

◆ $key_size

ilErrorTextWizardInputGUI::$key_size = 20

protected

Definition at line 32 of file class.ilErrorTextWizardInputGUI.php.

Referenced by getKeySize().

◆ $value_maxlength

ilErrorTextWizardInputGUI::$value_maxlength = 150

protected

Definition at line 35 of file class.ilErrorTextWizardInputGUI.php.

Referenced by getValueMaxlength().

◆ $value_name

ilErrorTextWizardInputGUI::$value_name = ""

protected

Definition at line 37 of file class.ilErrorTextWizardInputGUI.php.

Referenced by getValueName().

◆ $value_size

ilErrorTextWizardInputGUI::$value_size = 20

protected

Definition at line 33 of file class.ilErrorTextWizardInputGUI.php.

Referenced by getValueSize().

◆ $values

ilErrorTextWizardInputGUI::$values = []

protected

Definition at line 31 of file class.ilErrorTextWizardInputGUI.php.

Referenced by checkInput(), and getValues().

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

components/ILIAS/TestQuestionPool/classes/class.ilErrorTextWizardInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getKeyMaxlength()

◆ getKeyName()

◆ getKeySize()

◆ getValueMaxlength()

◆ getValueName()

◆ getValues()

◆ getValueSize()

◆ insert()

◆ setKeyMaxlength()

◆ setKeyName()

◆ setKeySize()

◆ setValue()

◆ setValueMaxlength()

◆ setValueName()

◆ setValues()

◆ setValueSize()

Field Documentation

◆ $forms_helper

◆ $key_maxlength

◆ $key_name

◆ $key_size

◆ $value_maxlength

◆ $value_name

◆ $value_size

◆ $values