This class represents a regular expression input property in a property form. More...

Inheritance diagram for ilRegExpInputGUI:

Collaboration diagram for ilRegExpInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setNoMatchMessage ($a_nomatchmessage)
	Set Message, if input does not match. More...

	getNoMatchMessage ()
	Get Message, if input does not match. More...

	setPattern ($pattern)
	set pattern More...

	getPattern ()
	return pattern More...

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

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)

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

Private Attributes
	$pattern

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

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

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Detailed Description

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References ilFormPropertyGUI\setType().

         {
                 parent::__construct($a_title, $a_postvar);
                 $this->setType("feedurl");
         }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilRegExpInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

References $_POST, $lng, $result, ilTextInputGUI\$value, getNoMatchMessage(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

         {
                 global $lng;
                 
                 // this line is necessary, otherwise it is a security issue (Alex)
                 $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                 
                 $value = $_POST[$this->getPostVar()];
                 
                 if (!$this->getRequired() && strcasecmp($value, "") == 0)
                 {
                         return true;
                 }
                 
                 if ($this->getRequired() && trim($value) == "")
                 {
                         $this->setAlert($lng->txt("msg_input_is_required"));
 
                         return false;
                 }
 
                 $result = 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:

◆ getNoMatchMessage()

ilRegExpInputGUI::getNoMatchMessage ( )

Get Message, if input does not match.

Returns: string Message, if input does not match

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

Referenced by checkInput().

         {
                 return $this->nomatchmessage;
         }

Here is the caller graph for this function:

◆ getPattern()

ilRegExpInputGUI::getPattern ( )

return pattern

Returns: string

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

References $pattern.

         {
                 return $this->pattern;
         }

◆ setNoMatchMessage()

ilRegExpInputGUI::setNoMatchMessage ( $a_nomatchmessage )

Set Message, if input does not match.

Parameters

string $a_nomatchmessage Message, if input does not match

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

         {
                 $this->nomatchmessage = $a_nomatchmessage;
         }

◆ setPattern()

ilRegExpInputGUI::setPattern ( $pattern )

set pattern

Parameters

string regular expression pattern

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

References $pattern.

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

         {
                 $this->pattern = $pattern;
         }

Here is the caller graph for this function:

Field Documentation

◆ $pattern

ilRegExpInputGUI::$pattern

private

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getNoMatchMessage()

◆ getPattern()

◆ setNoMatchMessage()

◆ setPattern()

Field Documentation

◆ $pattern