ilFormulaInputGUI Class Reference

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

Inheritance diagram for ilFormulaInputGUI:

Collaboration diagram for ilFormulaInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	setValue ($a_value)
	checkInput ()
	Check input, strip slashes etc. More...
	getInput ()
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...

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

Detailed Description

This class represents a formula text property in a property form.

Author

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

Definition at line 26 of file class.ilFormulaInputGUI.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 28 of file class.ilFormulaInputGUI.php.

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

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

        $this->lng = $DIC->language();
    }

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilFormulaInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

bool Input ok, true/false

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

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

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

        if ($this->getRequired() && $this->getInput() == "") {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        } else {
            $eval = new EvalMath();
            $eval->suppress_errors = true;
            $result = $eval->e(str_replace(",", ".", $this->getInput()));
            if ($result === false) {
                $this->setAlert($lng->txt("form_msg_formula_is_required"));
                return false;
            }
        }

        return $this->checkSubItemsInput();
    }

Here is the call graph for this function:

getInput()

ilFormulaInputGUI::getInput

(

)

Definition at line 70 of file class.ilFormulaInputGUI.php.

References ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequestParam(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Referenced by checkInput().

                              : string
    {
        $t = $this->refinery->kindlyTo()->string();
        return ilUtil::stripSlashes(
            (string) ($this->getRequestParam($this->getPostVar(), $t) ?? ""),
            false
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setValue()

ilFormulaInputGUI::setValue

(

$a_value

)

Parameters

string | array

$a_value

Definition at line 41 of file class.ilFormulaInputGUI.php.

                                      : void
    {
        $this->value = str_replace(',', '.', $a_value);
    }

---

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

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