This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

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 ()
	Check input, strip slashes etc. More...

	render (string $a_mode="")

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

	getElementAddCmd ()

	setElementAddCmd ($elementAddCmd)

	getElementRemoveCmd ()

	setElementRemoveCmd ($elementRemoveCmd)

	getElementMoveUpCommand ()

	setElementMoveUpCommand ($elementMoveUpCommand)

	getElementMoveDownCommand ()

	setElementMoveDownCommand ($elementMoveDownCommand)

	setValues ($values)

	getValues ()

	setValue ($value)

	getValue ()

	setMultiValues (array $values)

	getMultiValues ()

	setIdentifiedMultiValues ($values)

	getIdentifiedMultiValues ()

	setValueByArray (array $a_values)

	getInput ()

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

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

	fetchContentTextFromValue ($value)

Protected Member Functions inherited from ilIdentifiedMultiValuesInputGUI
	getMultiValueSubFieldId ($identifier, $subFieldIndex)

	getMultiValuePosIndexedFieldId ($identifier, $positionIndex)

	getMultiValuePosIndexedSubFieldId ($identifier, $subFieldIndex, $positionIndex)

	getFieldIdFromPostVar ($tempPostVar)

	getPostVarSubField ($subFieldIndex)

	getMultiValuePostVarSubField ($identifier, $subFieldIndex)

	getMultiValuePostVarSubFieldPosIndexed ($identifier, $subFieldIndex, $positionIndex)

	getMultiValuePostVarPosIndexed ($identifier, $positionIndex)

	getMultiValuePostVar ($identifier)

	buildMultiValueSubmitVar ($identifier, $positionIndex, $submitCommand)

	setIdentifiedMultiValuesByArray ($a_values)

	prepareMultiValuesInput ($values)

	prepareMultiValuesSubmit ($values)

	getFormValuesManipulators ()

	addFormValuesManipulator (ilFormValuesManipulator $manipulator)

	getSubFieldCompletedPostVar ($subFieldIndex, $elemPostVar)

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)

Protected Attributes
	$editElementOccuranceEnabled = false

	$editElementOrderEnabled = false

Protected Attributes inherited from ilIdentifiedMultiValuesInputGUI
	$elementAddCmd = self::ELEMENT_DEFAULT_ADD_CMD

	$elementRemoveCmd = self::ELEMENT_DEFAULT_REMOVE_CMD

	$elementMoveUpCommand = self::ELEMENT_DEFAULT_MOVE_UP_CMD

	$elementMoveDownCommand = self::ELEMENT_DEFAULT_MOVE_DOWN_CMD

	$identified_multi_values = array()

	$formValuesManipulationChain = array()

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Definition at line 22 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

Reimplemented from ilIdentifiedMultiValuesInputGUI.

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        parent::__construct($a_title, $a_postvar);
        $this->validationRegexp = "";
    }

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

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 193 of file class.ilMultipleTextsInputGUI.php.

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

References ilTextInputGUI\$value, and valueHasContentText().

Referenced by onCheckInput().

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 52 of file class.ilMultipleTextsInputGUI.php.

                                                   : bool
    {
        return $this->editElementOccuranceEnabled;
    }

References $editElementOccuranceEnabled.

Referenced by ilDclMultiTextInputGUI\render(), and render().

Here is the caller graph for this function:

◆ isEditElementOrderEnabled()

ilMultipleTextsInputGUI::isEditElementOrderEnabled ( )

Returns: boolean

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

                                               : bool
    {
        return $this->editElementOrderEnabled;
    }

References $editElementOrderEnabled.

Referenced by ilDclMultiTextInputGUI\render(), and render().

Here is the caller graph for this function:

◆ onCheckInput()

ilMultipleTextsInputGUI::onCheckInput ( )

Check input, strip slashes etc.

set alert, if input is not ok. fetchImageTitle

Returns: boolean Input ok, true/false

Reimplemented from ilIdentifiedMultiValuesInputGUI.

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

                                  : 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();
    }

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

Here is the call graph for this function:

◆ render()

ilMultipleTextsInputGUI::render ( string $a_mode = "" )

Parameters

string $mode

Returns: string

Reimplemented from ilTextInputGUI.

Reimplemented in ilDclMultiTextInputGUI.

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

                                               : string
    {
        $tpl = new ilTemplate("tpl.prop_multi_text_inp.html", true, true, "Services/Form");
        $i = 0;
        foreach ($this->getIdentifiedMultiValues() as $identifier => $value) {
            if (strlen($value)) {
                $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("CMD_UP", $this->buildMultiValueSubmitVar($identifier, $i, 'up'));
                $tpl->setVariable("CMD_DOWN", $this->buildMultiValueSubmitVar($identifier, $i, 'down'));
                $tpl->setVariable("ID", $this->getMultiValuePosIndexedFieldId($identifier, $i));
                $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
                $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::DOWN));
                $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("CMD_ADD", $this->buildMultiValueSubmitVar($identifier, $i, 'add'));
                $tpl->setVariable("CMD_REMOVE", $this->buildMultiValueSubmitVar($identifier, $i, 'remove'));
                $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
                $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
            }
 
            $tpl->parseCurrentBlock();
            $i++;
        }
        $tpl->setVariable("ELEMENT_ID", $this->getFieldId());
 
        if (!$this->getDisabled()) {
            $globalTpl = $GLOBALS['DIC'] ? $GLOBALS['DIC']['tpl'] : $GLOBALS['tpl'];
            $globalTpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
            $globalTpl->addJavascript("./Services/Form/js/ServiceFormIdentifiedWizardInputExtend.js");
            $globalTpl->addJavascript("./Services/Form/js/ServiceFormMultiTextInputInit.js");
        }
 
        return $tpl->get();
    }

References $GLOBALS, $i, $tpl, ilTextInputGUI\$value, ilGlyphGUI\ADD, ilIdentifiedMultiValuesInputGUI\buildMultiValueSubmitVar(), ilGlyphGUI\DOWN, ilGlyphGUI\get(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilIdentifiedMultiValuesInputGUI\getIdentifiedMultiValues(), ilTextInputGUI\getMaxLength(), ilIdentifiedMultiValuesInputGUI\getMultiValuePosIndexedFieldId(), ilIdentifiedMultiValuesInputGUI\getMultiValuePosIndexedSubFieldId(), ilIdentifiedMultiValuesInputGUI\getMultiValuePostVarPosIndexed(), ilTextInputGUI\getSize(), isEditElementOccuranceEnabled(), isEditElementOrderEnabled(), ilLegacyFormElementsUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

Here is the call graph for this function:

◆ setEditElementOccuranceEnabled()

ilMultipleTextsInputGUI::setEditElementOccuranceEnabled ( $editElementOccuranceEnabled )

Parameters

boolean $editElementOccuranceEnabled

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

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

References $editElementOccuranceEnabled.

◆ setEditElementOrderEnabled()

ilMultipleTextsInputGUI::setEditElementOrderEnabled ( $editElementOrderEnabled )

Parameters

boolean $editElementOrderEnabled

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

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

References $editElementOrderEnabled.

◆ valueHasContentText()

ilMultipleTextsInputGUI::valueHasContentText ( $value )

protected

Parameters

$value

Returns: bool

Reimplemented in ilAssOrderingTextsInputGUI.

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

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