ilRegExpInputGUI Class Reference

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

Inheritance diagram for ilRegExpInputGUI:

Collaboration diagram for ilRegExpInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	setNoMatchMessage (string $a_nomatchmessage)
	getNoMatchMessage ()
	setPattern (string $pattern)
	getPattern ()
	checkInput ()
	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...

Protected Attributes
string	$nomatchmessage = ""
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

Private Attributes
string	$pattern = ""

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
	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 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 This class represents a regular expression input property in a property form.

Author

Roland Küstermann rolan.nosp@m.d.ku.nosp@m.ester.nosp@m.mann.nosp@m.@kit..nosp@m.edu

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

Constructor & Destructor Documentation

__construct()

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

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

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

      {
        global $DIC;

        $this->lng = $DIC->language();
        parent::__construct($a_title, $a_postvar);
        $this->setType("feedurl");
    }

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilRegExpInputGUI::checkInput

(

)

Definition at line 62 of file class.ilRegExpInputGUI.php.

References ilFormPropertyGUI\$lng, ilTextInputGUI\$value, getInput(), getNoMatchMessage(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilLanguage\txt().

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

        $value = $this->getInput();

        if (!$this->getRequired() && strcasecmp($value, "") == 0) {
            return true;
        }

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

        $result = (bool) preg_match($this->pattern, $value);
        if (!$result) {
            if ($this->getNoMatchMessage() == "") {
                $this->setAlert($lng->txt("msg_input_does_not_match_regexp"));
            } else {
                $this->setAlert($this->getNoMatchMessage());
            }
        }
        return $result;
    }

Here is the call graph for this function:

getInput()

ilRegExpInputGUI::getInput

(

)

Definition at line 88 of file class.ilRegExpInputGUI.php.

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

Referenced by checkInput().

                              : string
    {
        return $this->str($this->getPostVar());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNoMatchMessage()

ilRegExpInputGUI::getNoMatchMessage

(

)

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

References $nomatchmessage.

Referenced by checkInput().

                                       : string
    {
        return $this->nomatchmessage;
    }

Here is the caller graph for this function:

getPattern()

ilRegExpInputGUI::getPattern

(

)

Definition at line 57 of file class.ilRegExpInputGUI.php.

References $pattern.

                                : string
    {
        return $this->pattern;
    }

setNoMatchMessage()

ilRegExpInputGUI::setNoMatchMessage

(

string

$a_nomatchmessage

)

Definition at line 42 of file class.ilRegExpInputGUI.php.

                                                               : void
    {
        $this->nomatchmessage = $a_nomatchmessage;
    }

setPattern()

ilRegExpInputGUI::setPattern

(

string

$pattern

)

Definition at line 52 of file class.ilRegExpInputGUI.php.

References $pattern.

Referenced by ilObjMediaCastGUI\initAddCastItemForm(), ilStyleCharacteristicGUI\initCharacteristicForm(), ilObjStyleSheetGUI\initColorForm(), ilObjStyleSheetGUI\initTemplateForm(), and ilObjStyleSheetGUI\initTemplateGenerationForm().

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

Here is the caller graph for this function:

Field Documentation

$nomatchmessage

string ilRegExpInputGUI::$nomatchmessage = ""

protected

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

Referenced by getNoMatchMessage().

$pattern

string ilRegExpInputGUI::$pattern = ""

private

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

Referenced by getPattern(), and setPattern().

---

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

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