ilMultipleTextsInputGUI Class Reference

Inheritance diagram for ilMultipleTextsInputGUI:

Collaboration diagram for ilMultipleTextsInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	isEditElementOccuranceEnabled ()
	setEditElementOccuranceEnabled ($editElementOccuranceEnabled)
	isEditElementOrderEnabled ()
	setEditElementOrderEnabled ($editElementOrderEnabled)
	onCheckInput ()
	render (string $a_mode="")
Public Member Functions inherited from ilIdentifiedMultiValuesInputGUI
	__construct ($a_title="", $a_postvar="")
	getElementAddCmd ()
	setElementAddCmd (string $element_add_cmd)
	getElementRemoveCmd ()
	setElementRemoveCmd (string $element_remove_cmd)
	getElementMoveUpCommand ()
	setElementMoveUpCommand (string $element_move_up_cmd)
	getElementMoveDownCommand ()
	setElementMoveDownCommand (string $element_move_down_cmd)
	setValues ($values)
	getValues ()
	setValue ($value)
	getValue ()
	setMultiValues (array $values)
	getMultiValues ()
	setIdentifiedMultiValues ($values)
	getIdentifiedMultiValues ()
	setValueByArray (array $a_values)
	getInput ()
	checkInput ()
	onCheckInput ()
	prepareReprintable (assQuestion $question)
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 ()
	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)
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
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Member Functions
	valueHasContentText ($value)
	fetchContentTextFromValue ($value)
Protected Member Functions inherited from ilIdentifiedMultiValuesInputGUI
	getMultiValueSubFieldId ($identifier, $sub_field_index)
	getMultiValuePosIndexedFieldId ($identifier, $position_index)
	getMultiValuePosIndexedSubFieldId ($identifier, $sub_field_index, $position_index)
	getFieldIdFromPostVar ($temp_post_var)
	getPostVarSubField ($sub_field_index)
	getMultiValuePostVarSubField ($identifier, $sub_field_index)
	getMultiValuePostVarSubFieldPosIndexed ($identifier, $sub_field_index, $position_index)
	getMultiValuePostVarPosIndexed ($identifier, $positionIndex)
	getMultiValuePostVar ($identifier)
	buildMultiValueSubmitVar ($identifier, $position_index, $submit_cmd)
	setIdentifiedMultiValuesByArray ($a_values)
	prepareMultiValuesInput ($values)
	prepareMultiValuesSubmit ($values)
	getFormValuesManipulators ()
	addFormValuesManipulator (ilFormValuesManipulator $manipulator)
	getSubFieldCompletedPostVar ($subFieldIndex, $elem_post_var)
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)

Protected Attributes
	$editElementOccuranceEnabled = false
	$editElementOrderEnabled = false
GlyphFactory	$glyph_factory
Renderer	$renderer
ilGlobalTemplateInterface	$tpl
Protected Attributes inherited from ilIdentifiedMultiValuesInputGUI
string	$element_add_cmd = self::ELEMENT_DEFAULT_ADD_CMD
string	$element_remove_cmd = self::ELEMENT_DEFAULT_REMOVE_CMD
string	$element_move_up_cmd = self::ELEMENT_DEFAULT_MOVE_UP_CMD
string	$element_move_down_cmd = self::ELEMENT_DEFAULT_MOVE_DOWN_CMD
	$identified_multi_values = []
	$formValuesManipulationChain = []
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...
Data Fields inherited from ilIdentifiedMultiValuesInputGUI
const	ELEMENT_DEFAULT_ADD_CMD = 'addElement'
const	ELEMENT_DEFAULT_REMOVE_CMD = 'removeElement'
const	ELEMENT_DEFAULT_MOVE_UP_CMD = 'moveUpElement'
const	ELEMENT_DEFAULT_MOVE_DOWN_CMD = 'moveDownElement'

Detailed Description

Author

Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Definition at line 25 of file class.ilMultipleTextsInputGUI.php.

Constructor & Destructor Documentation

__construct()

ilMultipleTextsInputGUI::__construct	(		$a_title = "",
			$a_postvar = ""
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

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

    {
        parent::__construct($a_title, $a_postvar);

        global $DIC;
        $this->lng = $DIC['lng'];
        $this->glyph_factory = $DIC->ui()->factory()->symbol()->glyph();
        $this->renderer = $DIC['ui.renderer'];
        $this->tpl = $DIC['tpl'];

        $this->validationRegexp = "";
    }

Here is the call graph for this function:

Member Function Documentation

fetchContentTextFromValue()

ilMultipleTextsInputGUI::fetchContentTextFromValue (   $value )

protected

Parameters

mixed

$value

Returns

string|ilAssOrderingElement|null

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

References ilTextInputGUI\$value, null, and valueHasContentText().

Referenced by onCheckInput().

    {
        if ($this->valueHasContentText($value)) {
            return $value;
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isEditElementOccuranceEnabled()

ilMultipleTextsInputGUI::isEditElementOccuranceEnabled

(

)

Returns

boolean $editElementOccuranceEnabled

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

References $editElementOccuranceEnabled.

Referenced by render().

                                                   : bool
    {
        return $this->editElementOccuranceEnabled;
    }

Here is the caller graph for this function:

isEditElementOrderEnabled()

ilMultipleTextsInputGUI::isEditElementOrderEnabled

(

)

Returns

boolean

Definition at line 79 of file class.ilMultipleTextsInputGUI.php.

References $editElementOrderEnabled.

Referenced by render().

                                               : bool
    {
        return $this->editElementOrderEnabled;
    }

Here is the caller graph for this function:

onCheckInput()

ilMultipleTextsInputGUI::onCheckInput

(

)

Definition at line 92 of file class.ilMultipleTextsInputGUI.php.

References ilFormPropertyGUI\$lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), fetchContentTextFromValue(), ilIdentifiedMultiValuesInputGUI\getInput(), ilFormPropertyGUI\getRequired(), ilTextInputGUI\getValidationRegexp(), ilFormPropertyGUI\setAlert(), and ilLanguage\txt().

                                  : bool
    {
        $lng = $this->lng;

        $submittedElements = $this->getInput();

        if ($submittedElements === [] && $this->getRequired()) {
            $this->setAlert($lng->txt('msg_input_is_required'));
            return false;
        }

        foreach ($submittedElements as $submittedValue) {
            $submittedContentText = $this->fetchContentTextFromValue($submittedValue);

            if ($this->getRequired() && trim((string) $submittedContentText) === "") {
                $this->setAlert($lng->txt('msg_input_is_required'));
                return false;
            }

            if ($this->getValidationRegexp() !== '') {
                if (!preg_match($this->getValidationRegexp(), (string) $submittedContentText)) {
                    $this->setAlert($lng->txt('msg_wrong_format'));
                    return false;
                }
            }
        }

        return $this->checkSubItemsInput();
    }

Here is the call graph for this function:

render()

ilMultipleTextsInputGUI::render

(

string

$a_mode = ""

)

Definition at line 122 of file class.ilMultipleTextsInputGUI.php.

References ilTextInputGUI\$value, ILIAS\UICore\GlobalTemplate\get(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilIdentifiedMultiValuesInputGUI\getIdentifiedMultiValues(), ilTextInputGUI\getMaxLength(), ilIdentifiedMultiValuesInputGUI\getMultiValuePosIndexedFieldId(), ilIdentifiedMultiValuesInputGUI\getMultiValuePosIndexedSubFieldId(), ilIdentifiedMultiValuesInputGUI\getMultiValuePostVarPosIndexed(), ilTextInputGUI\getSize(), isEditElementOccuranceEnabled(), isEditElementOrderEnabled(), null, ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), renderer(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), and ILIAS\UICore\GlobalTemplate\setVariable().

                                               : string
    {
        $tpl = new ilTemplate("tpl.prop_multi_text_inp.html", true, true, "components/ILIAS/TestQuestionPool");
        $i = 0;
        foreach ($this->getIdentifiedMultiValues() as $identifier => $value) {
            if ($value !== null) {
                $tpl->setCurrentBlock("prop_text_propval");
                $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($value));
                $tpl->parseCurrentBlock();
            }
            if ($this->isEditElementOrderEnabled()) {
                $tpl->setCurrentBlock("move");
                $tpl->setVariable("ID_UP", $this->getMultiValuePosIndexedSubFieldId($identifier, 'up', $i));
                $tpl->setVariable("ID_DOWN", $this->getMultiValuePosIndexedSubFieldId($identifier, 'down', $i));
                $tpl->setVariable("ID", $this->getMultiValuePosIndexedFieldId($identifier, $i));
                $tpl->setVariable("UP_BUTTON", $this->renderer->render(
                    $this->glyph_factory->up()->withAction('#')
                ));
                $tpl->setVariable("DOWN_BUTTON", $this->renderer->render(
                    $this->glyph_factory->down()->withAction('#')
                ));
                $tpl->parseCurrentBlock();
            }
            $tpl->setCurrentBlock("row");
            $tpl->setVariable("POST_VAR", $this->getMultiValuePostVarPosIndexed($identifier, $i));
            $tpl->setVariable("ID", $this->getMultiValuePosIndexedFieldId($identifier, $i));
            $tpl->setVariable("SIZE", $this->getSize());
            $tpl->setVariable("MAXLENGTH", $this->getMaxLength());

            if ($this->getDisabled()) {
                $tpl->setVariable(
                    "DISABLED",
                    " disabled=\"disabled\""
                );
            } elseif ($this->isEditElementOccuranceEnabled()) {
                $tpl->setVariable("ID_ADD", $this->getMultiValuePosIndexedSubFieldId($identifier, 'add', $i));
                $tpl->setVariable("ID_REMOVE", $this->getMultiValuePosIndexedSubFieldId($identifier, 'remove', $i));
                $tpl->setVariable("ADD_BUTTON", $this->renderer->render(
                    $this->glyph_factory->add()->withAction('#')
                ));
                $tpl->setVariable("REMOVE_BUTTON", $this->renderer->render(
                    $this->glyph_factory->remove()->withAction('#')
                ));
            }

            $tpl->parseCurrentBlock();
            $i++;
        }
        $tpl->setVariable("ELEMENT_ID", $this->getFieldId());

        if (!$this->getDisabled()) {
            $config = '{'
                . '"fieldContainerSelector": ".ilWzdContainerText", '
                . '"reindexingRequiredElementsSelectors": ["input:text", "button"], '
                . '"handleRowCleanUpCallback": function(rowElem) {$(rowElem).find("input:text").val("")}'
                . '}';
            $this->tpl->addJavascript("assets/js/answerwizardinput.js");
            $this->tpl->addJavascript("assets/js/identifiedwizardinput.js");
            $this->tpl->addOnLoadCode("$.extend({}, AnswerWizardInput, IdentifiedWizardInput).init({$config});");
        }

        return $tpl->get();
    }

Here is the call graph for this function:

setEditElementOccuranceEnabled()

ilMultipleTextsInputGUI::setEditElementOccuranceEnabled

(

$editElementOccuranceEnabled

)

Parameters

boolean

$editElementOccuranceEnabled

Definition at line 71 of file class.ilMultipleTextsInputGUI.php.

References $editElementOccuranceEnabled.

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

setEditElementOrderEnabled()

ilMultipleTextsInputGUI::setEditElementOrderEnabled

(

$editElementOrderEnabled

)

Parameters

boolean

$editElementOrderEnabled

Definition at line 87 of file class.ilMultipleTextsInputGUI.php.

References $editElementOrderEnabled.

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

valueHasContentText()

ilMultipleTextsInputGUI::valueHasContentText (   $value )

protected

Parameters

$value

Returns

bool

Definition at line 190 of file class.ilMultipleTextsInputGUI.php.

References ilTextInputGUI\$value, and null.

Referenced by fetchContentTextFromValue().

                                                  : bool
    {
        if ($value === null || is_array($value) || is_object($value)) {
            return false;
        }

        return (bool) strlen($value);
    }

Here is the caller graph for this function:

Field Documentation

$editElementOccuranceEnabled

ilMultipleTextsInputGUI::$editElementOccuranceEnabled = false

protected

Definition at line 30 of file class.ilMultipleTextsInputGUI.php.

Referenced by isEditElementOccuranceEnabled(), and setEditElementOccuranceEnabled().

$editElementOrderEnabled

ilMultipleTextsInputGUI::$editElementOrderEnabled = false

protected

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

Referenced by isEditElementOrderEnabled(), and setEditElementOrderEnabled().

$glyph_factory

GlyphFactory ilMultipleTextsInputGUI::$glyph_factory

protected

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

$renderer

Renderer ilMultipleTextsInputGUI::$renderer

protected

Definition at line 38 of file class.ilMultipleTextsInputGUI.php.

$tpl

ilGlobalTemplateInterface ilMultipleTextsInputGUI::$tpl

protected

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

---

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

• components/ILIAS/TestQuestionPool/classes/forms/class.ilMultipleTextsInputGUI.php