ilTextWizardInputGUI Class Reference

This class represents a text wizard property in a property form. More...

Inheritance diagram for ilTextWizardInputGUI:

Collaboration diagram for ilTextWizardInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	setValues (array $a_values)
	setValue ($a_value)
	getValues ()
	setAllowMove (bool $a_allow_move)
	getAllowMove ()
	checkInput ()
	Check input, strip slashes etc. More...
	getInput ()
	insert (ilTemplate $a_tpl)
	render (string $a_mode="")
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
ilGlobalTemplateInterface	$tpl
array	$values = array()
bool	$allowMove = false
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 text wizard property in a property form.

Author

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

Deprecated:

12 This component will be removed with ILIAS 12

Definition at line 27 of file class.ilTextWizardInputGUI.php.

Constructor & Destructor Documentation

__construct()

ilTextWizardInputGUI::__construct	(	string	$a_title = "",
		string	$a_postvar = ""
	)

Reimplemented from ilTextInputGUI.

Reimplemented in ilSelectBuilderInputGUI.

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

      {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->tpl = $DIC["tpl"];
        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

checkInput()

ilTextWizardInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilTextInputGUI.

Reimplemented in ilSelectBuilderInputGUI.

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

                                : bool
    {
        $lng = $this->lng;
 
        $foundvalues = $this->getInput();
        if (count($foundvalues) > 0) {
            foreach ($foundvalues as $value) {
                if ($this->getRequired() && trim($value) == "") {
                    $this->setAlert($lng->txt("msg_input_is_required"));
                    return false;
                } elseif (strlen($this->getValidationRegexp())) {
                    if (!preg_match($this->getValidationRegexp(), $value)) {
                        $this->setAlert($lng->txt("msg_wrong_format"));
                        return false;
                    }
                } elseif ($this->getMaxLength() && mb_strlen($value) > $this->getMaxLength()) {
                    $this->setAlert($lng->txt("msg_input_char_limit_max"));
                    return false;
                }
            }
        } elseif ($this->getRequired()) {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
 
        return $this->checkSubItemsInput();
    }

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

Here is the call graph for this function:

getAllowMove()

ilTextWizardInputGUI::getAllowMove

(

)

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

                                  : bool
    {
        return $this->allowMove;
    }

References $allowMove.

Referenced by ilSelectBuilderInputGUI\insert(), and render().

Here is the caller graph for this function:

getInput()

ilTextWizardInputGUI::getInput

(

)

Returns

string|string[]

Reimplemented from ilTextInputGUI.

Reimplemented in ilSelectBuilderInputGUI.

Definition at line 101 of file class.ilTextWizardInputGUI.php.

                              : array
    {
        return $this->strArray($this->getPostVar());
    }

References ilFormPropertyGUI\getPostVar(), and ilFormPropertyGUI\strArray().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

getValues()

ilTextWizardInputGUI::getValues

(

)

Definition at line 58 of file class.ilTextWizardInputGUI.php.

                               : array
    {
        return $this->values;
    }

References $values.

insert()

ilTextWizardInputGUI::insert

(

ilTemplate

$a_tpl

)

Reimplemented from ilTextInputGUI.

Reimplemented in ilSelectBuilderInputGUI.

Definition at line 106 of file class.ilTextWizardInputGUI.php.

                                             : void
    {
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $this->render());
        $a_tpl->parseCurrentBlock();
    }

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

render()

ilTextWizardInputGUI::render

(

string

$a_mode = ""

)

Reimplemented from ilTextInputGUI.

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

                                               : string
    {
        $tpl = new ilTemplate("tpl.prop_textwizardinput.html", true, true, "components/ILIAS/Form");
        $i = 0;
        foreach ($this->values as $value) {
            if (strlen($value)) {
                $tpl->setCurrentBlock("prop_text_propval");
                $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($value));
                $tpl->parseCurrentBlock();
            }
            if ($this->getAllowMove()) {
                $tpl->setCurrentBlock("move");
                $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
                $tpl->setVariable("UP_BUTTON", $this->symbol()->glyph("up")->render());
                $tpl->setVariable("DOWN_BUTTON", $this->symbol()->glyph("down")->render());
                $tpl->parseCurrentBlock();
            }
            $tpl->setCurrentBlock("row");
            $tpl->setVariable("POST_VAR", $this->getPostVar() . "[$i]");
            $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
            $tpl->setVariable("SIZE", $this->getSize());
            $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
 
            if ($this->getDisabled()) {
                $tpl->setVariable(
                    "DISABLED",
                    " disabled=\"disabled\""
                );
            } else {
                $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("ADD_BUTTON", $this->symbol()->glyph("add")->render());
                $tpl->setVariable("REMOVE_BUTTON", $this->symbol()->glyph("remove")->render());
            }
 
            $tpl->parseCurrentBlock();
            $i++;
        }
 
        $tpl->setVariable("ELEMENT_ID", $this->getFieldId());
 
        if (!$this->getDisabled()) {
            $this->tpl->addJavascript("assets/js/ServiceFormWizardInput.js");
            $this->tpl->addJavascript("assets/js/textwizard.js");
        }
 
        return $tpl->get();
    }

References $tpl, ilTextInputGUI\$value, ILIAS\UICore\GlobalTemplate\get(), getAllowMove(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilTextInputGUI\getMaxLength(), ilFormPropertyGUI\getPostVar(), ilTextInputGUI\getSize(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), render(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setVariable(), and ilFormPropertyGUI\symbol().

Referenced by ilSelectBuilderInputGUI\insert(), insert(), and render().

Here is the call graph for this function:

Here is the caller graph for this function:

setAllowMove()

ilTextWizardInputGUI::setAllowMove

(

bool

$a_allow_move

)

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

                                                    : void
    {
        $this->allowMove = $a_allow_move;
    }

setValue()

ilTextWizardInputGUI::setValue

(

$a_value

)

Parameters

array | string

$a_value

Reimplemented from ilTextInputGUI.

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

                                      : void
    {
        $this->values = (array) $a_value;
    }

setValues()

ilTextWizardInputGUI::setValues

(

array

$a_values

)

Definition at line 45 of file class.ilTextWizardInputGUI.php.

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

Field Documentation

$allowMove

bool ilTextWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

$tpl

ilGlobalTemplateInterface ilTextWizardInputGUI::$tpl

protected

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

Referenced by ilSelectBuilderInputGUI\insert(), and render().

$values

array ilTextWizardInputGUI::$values = array()

protected

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

Referenced by getValues().

---

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

• components/ILIAS/Form/classes/class.ilTextWizardInputGUI.php