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 ()
	Check input, strip slashes etc. More...
	render ($a_mode="")
Public Member Functions inherited from ilIdentifiedMultiValuesInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	getElementAddCmd ()
	setElementAddCmd ($elementAddCmd)
	getElementRemoveCmd ()
	setElementRemoveCmd ($elementRemoveCmd)
	getElementMoveUpCommand ()
	setElementMoveUpCommand ($elementMoveUpCommand)
	getElementMoveDownCommand ()
	setElementMoveDownCommand ($elementMoveDownCommand)
	setValues ($values)
	getValues ()
	setValue ($value)
	Set Value. More...
	getValue ()
	Get Value. More...
	setMultiValues (array $values)
	Set multi values. More...
	getMultiValues ()
	Get multi values. More...
	setIdentifiedMultiValues ($values)
	getIdentifiedMultiValues ()
	setValueByArray ($a_values)
	Set value by array. More...
	checkInput ()
	Check input, strip slashes etc. More...
	onCheckInput ()
	prepareReprintable (assQuestion $question)
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...

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 ($a_type)
	Set Type. More...
	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

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

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($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

Definition at line 12 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 30 of file class.ilMultipleTextsInputGUI.php.

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

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

Here is the call graph for this function:

Member Function Documentation

fetchContentTextFromValue()

ilMultipleTextsInputGUI::fetchContentTextFromValue (   $value )

protected

Parameters

$value

Returns

string

Definition at line 188 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 42 of file class.ilMultipleTextsInputGUI.php.

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

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

    {
        $lng = $this->lng;
        
        $submittedElements = $_POST[$this->getPostVar()];
        
        if (!is_array($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($submittedContentText) == "") {
                $this->setAlert($lng->txt('msg_input_is_required'));
                return false;
            }
            
            if (strlen($this->getValidationRegexp())) {
                if (!preg_match($this->getValidationRegexp(), $submittedContentText)) {
                    $this->setAlert($lng->txt('msg_wrong_format'));
                    return false;
                }
            }
        }
 
        return $this->checkSubItemsInput();
    }

References $_POST, ilFormPropertyGUI\$lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), fetchContentTextFromValue(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilTextInputGUI\getValidationRegexp(), and ilFormPropertyGUI\setAlert().

Here is the call graph for this function:

render()

ilMultipleTextsInputGUI::render

(

$a_mode = ""

)

Parameters

string

$mode

Returns

string

Reimplemented in ilDclMultiTextInputGUI.

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

    {
        $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", ilUtil::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));
                include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                $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'));
                include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                $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()) {
            $tpl->setCurrentBlock('js_engine_initialisation');
            $tpl->touchBlock('js_engine_initialisation');
            $tpl->parseCurrentBlock();
            
            $globalTpl = $GLOBALS['DIC'] ? $GLOBALS['DIC']['tpl'] : $GLOBALS['tpl'];
            $globalTpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
            $globalTpl->addJavascript("./Services/Form/js/ServiceFormIdentifiedWizardInputExtend.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(), ilUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

Here is the call graph for this function:

setEditElementOccuranceEnabled()

ilMultipleTextsInputGUI::setEditElementOccuranceEnabled

(

$editElementOccuranceEnabled

)

Parameters

boolean

$editElementOccuranceEnabled

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

    {
        $this->editElementOccuranceEnabled = $editElementOccuranceEnabled;
    }

References $editElementOccuranceEnabled.

setEditElementOrderEnabled()

ilMultipleTextsInputGUI::setEditElementOrderEnabled

(

$editElementOrderEnabled

)

Parameters

boolean

$editElementOrderEnabled

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

    {
        $this->editElementOrderEnabled = $editElementOrderEnabled;
    }

References $editElementOrderEnabled.

valueHasContentText()

ilMultipleTextsInputGUI::valueHasContentText (   $value )

protected

Parameters

$value

Returns

bool

Reimplemented in ilAssOrderingTextsInputGUI.

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

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

References ilTextInputGUI\$value.

Referenced by fetchContentTextFromValue().

Here is the caller graph for this function:

Field Documentation

$editElementOccuranceEnabled

ilMultipleTextsInputGUI::$editElementOccuranceEnabled = false

protected

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

Referenced by isEditElementOccuranceEnabled(), and setEditElementOccuranceEnabled().

$editElementOrderEnabled

ilMultipleTextsInputGUI::$editElementOrderEnabled = false

protected

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

Referenced by isEditElementOrderEnabled(), and setEditElementOrderEnabled().

---

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

• Services/Form/classes/class.ilMultipleTextsInputGUI.php