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.
	setNoMatchMessage ($a_nomatchmessage)
	Set Message, if input does not match.
	getNoMatchMessage ()
	Get Message, if input does not match.
	setPattern ($pattern)
	set pattern
	getPattern ()
	return pattern
	checkInput ()
	Check input, strip slashes etc.
Public Member Functions inherited from ilTextInputGUI
	setValue ($a_value)
	Set Value.
	getValue ()
	Get Value.
	setValidationFailureMessage ($a_msg)
	Set message string for validation failure.
	getValidationFailureMessage ()
	setValidationRegexp ($a_value)
	Set validation regexp.
	getValidationRegexp ()
	Get validation regexp.
	setMaxLength ($a_maxlength)
	Set Max Length.
	getMaxLength ()
	Get Max Length.
	setSize ($a_size)
	Set Size.
	setInlineStyle ($a_style)
	Set inline style.
	getInlineStyle ()
	Get inline style.
	setCssClass ($a_class)
	getCssClass ()
	setValueByArray ($a_values)
	Set value by array.
	getSize ()
	Get Size.
	setSuffix ($a_value)
	Set suffix.
	getSuffix ()
	Get suffix.
	setInputType ($a_type)
	set input type
	getInputType ()
	get input type
	setSubmitFormOnEnter ($a_val)
	Set submit form on enter.
	getSubmitFormOnEnter ()
	Get submit form on enter.
	getDataSource ()
	get datasource link for YUI autocomplete
	setDataSource ($href)
	set datasource link for YUI autocomplete
	getDataSourceSchema ()
	get datasource schema for YUI autocomplete
	setDataSourceSchema ($ds)
	set datasource schema for YUI autocomplete
	getDataSourceResultFormat ()
	get data result format callback for YUI autocomplete
	setDataSourceResultFormat ($callback)
	set data result format callback for YUI autocomplete
	setDataSourceDelimiter ($ar)
	set data delimiter array
	getDataSourceDelimiter ()
	get data delimiter array
	insert (&$a_tpl)
	Insert property html.
	getTableFilterHTML ()
	Get HTML for table filter.
	getToolbarHTML ()
	Get HTML for toolbar.
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem.
	getSubItems ()
	Get Subitems.
	checkSubItemsInput ()
	Check SubItems.
	getSubForm ()
	Get sub form html.
	getItemByPostVar ($a_post_var)
	Get item by post var.
Public Member Functions inherited from ilFormPropertyGUI
&	executeCommand ()
	Execute command.
	getType ()
	Get Type.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setPostVar ($a_postvar)
	Set Post Variable.
	getPostVar ()
	Get Post Variable.
	getFieldId ()
	Get Post Variable.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	setAlert ($a_alert)
	Set Alert Text.
	getAlert ()
	Get Alert Text.
	setRequired ($a_required)
	Set Required.
	getRequired ()
	Get Required.
	setDisabled ($a_disabled)
	Set Disabled.
	getDisabled ()
	Get Disabled.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)

Private Attributes
	$pattern

Additional Inherited Members
Protected Member Functions inherited from ilTextInputGUI
	render ($a_mode="")
	Render item.
Protected Attributes inherited from ilTextInputGUI
	$value
	$maxlength = 200
	$size = 40
	$validationRegexp
	$validationFailureMessage = ''
	$suffix
	$style_css
	$css_class
	$yui_dataSource
	$yui_dataSchema
	$yui_formatCallback
	$yui_delimiterarray = array()
	$submit_form_on_enter = false

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

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilTextInputGUI.

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

ilRegExpInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilTextInputGUI.

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:

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:

ilRegExpInputGUI::getPattern ( )

return pattern

Returns: string

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

References $pattern.

        {
                return $this->pattern;
        }

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;
        }

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

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

Member Function Documentation

Field Documentation