ilTextInputGUI Class Reference

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

Inheritance diagram for ilTextInputGUI:

Collaboration diagram for ilTextInputGUI:

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

Protected Member Functions
	render ($a_mode="")
	Render item.

Protected Attributes
	$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
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""

Detailed Description

This class represents a text property in a property form.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 15 of file class.ilTextInputGUI.php.

Constructor & Destructor Documentation

ilTextInputGUI::__construct	(		$a_title = "",
			$a_postvar = ""
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilCategoryWizardInputGUI, ilMatchingWizardInputGUI, ilKVPWizardInputGUI, ilMatrixRowWizardInputGUI, ilErrorTextWizardInputGUI, ilSingleChoiceWizardInputGUI, ilAnswerWizardInputGUI, ilImageWizardInputGUI, ilMatchingPairWizardInputGUI, ilTRBLColorPickerInputGUI, ilFeedUrlInputGUI, ilTextWizardInputGUI, ilRegExpInputGUI, ilLuceneQueryInputGUI, ilScaleInputGUI, and ilColorPickerInputGUI.

Definition at line 39 of file class.ilTextInputGUI.php.

References setInputType().

        {
                parent::__construct($a_title, $a_postvar);
                $this->setInputType("text");
                $this->validationRegexp = "";
        }

Here is the call graph for this function:

Member Function Documentation

ilTextInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilKVPWizardInputGUI, ilTRBLColorPickerInputGUI, ilCategoryWizardInputGUI, ilErrorTextWizardInputGUI, ilSingleChoiceWizardInputGUI, ilMatchingWizardInputGUI, ilMatrixRowWizardInputGUI, ilAnswerWizardInputGUI, ilImageWizardInputGUI, ilMatchingPairWizardInputGUI, ilTextWizardInputGUI, ilRegExpInputGUI, ilMultipleChoiceWizardInputGUI, ilFeedUrlInputGUI, ilLuceneQueryInputGUI, ilColorPickerInputGUI, and ilFormulaInputGUI.

Definition at line 249 of file class.ilTextInputGUI.php.

References $_POST, $lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getValidationFailureMessage(), getValidationRegexp(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

        {
                global $lng;
                
                $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
                {
                        $this->setAlert($lng->txt("msg_input_is_required"));

                        return false;
                }
                else if (strlen($this->getValidationRegexp()))
                {
                        if (!preg_match($this->getValidationRegexp(), $_POST[$this->getPostVar()]))
                        {
                                $this->setAlert(
                                        $this->getValidationFailureMessage() ?
                                        $this->getValidationFailureMessage() :
                                        $lng->txt('msg_wrong_format')
                                );
                                return FALSE;
                        }
                }
                
                return $this->checkSubItemsInput();
        }

Here is the call graph for this function:

ilTextInputGUI::getCssClass

(

)

Definition at line 156 of file class.ilTextInputGUI.php.

References $css_class.

Referenced by render().

        {
                return $this->css_class;
        }

Here is the caller graph for this function:

ilTextInputGUI::getDataSource

(

)

get datasource link for YUI autocomplete

Returns

String link to data generation script

Definition at line 280 of file class.ilTextInputGUI.php.

References $yui_dataSource.

Referenced by render().

         {
                return $this->yui_dataSource;
         }

Here is the caller graph for this function:

ilTextInputGUI::getDataSourceDelimiter

(

)

get data delimiter array

Returns

array array of current delimiters

Definition at line 357 of file class.ilTextInputGUI.php.

References $yui_delimiterarray.

Referenced by render().

        {
                return $this->yui_delimiterarray;       
        }

Here is the caller graph for this function:

ilTextInputGUI::getDataSourceResultFormat

(

)

get data result format callback for YUI autocomplete

Definition at line 324 of file class.ilTextInputGUI.php.

References $yui_formatCallback.

Referenced by render().

         {
                return $this->yui_formatCallback;
         }

Here is the caller graph for this function:

ilTextInputGUI::getDataSourceSchema

(

)

get datasource schema for YUI autocomplete

Returns

array data schema as array

Definition at line 298 of file class.ilTextInputGUI.php.

References $yui_dataSchema.

Referenced by render().

         {
                return $this->yui_dataSchema;
         }

Here is the caller graph for this function:

ilTextInputGUI::getInlineStyle

(

)

Get inline style.

Returns

string style

Definition at line 146 of file class.ilTextInputGUI.php.

References $style_css.

Referenced by ilScaleInputGUI\render(), and render().

        {
                return $this->style_css;
        }

Here is the caller graph for this function:

ilTextInputGUI::getInputType

(

)

get input type

public

Definition at line 219 of file class.ilTextInputGUI.php.

Referenced by render().

        {
                return $this->input_type;
        }

Here is the caller graph for this function:

ilTextInputGUI::getMaxLength

(

)

Get Max Length.

Returns

int Max Length

Definition at line 116 of file class.ilTextInputGUI.php.

References $maxlength.

Referenced by ilTextWizardInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilScaleInputGUI\render(), and render().

        {
                return $this->maxlength;
        }

Here is the caller graph for this function:

ilTextInputGUI::getSize

(

)

Get Size.

Returns

int Size

Definition at line 177 of file class.ilTextInputGUI.php.

References $size.

Referenced by ilTextWizardInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilScaleInputGUI\render(), and render().

        {
                return $this->size;
        }

Here is the caller graph for this function:

ilTextInputGUI::getSubmitFormOnEnter

(

)

Get submit form on enter.

Returns

boolean

Definition at line 239 of file class.ilTextInputGUI.php.

References $submit_form_on_enter.

Referenced by render().

        {
                return $this->submit_form_on_enter;
        }

Here is the caller graph for this function:

ilTextInputGUI::getSuffix

(

)

Get suffix.

Returns

string suffix

Definition at line 197 of file class.ilTextInputGUI.php.

References $suffix.

Referenced by ilScaleInputGUI\render(), and render().

        {
                return $this->suffix;
        }

Here is the caller graph for this function:

ilTextInputGUI::getTableFilterHTML

(

)

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 477 of file class.ilTextInputGUI.php.

References render().

        {
                $html = $this->render();
                return $html;
        }

Here is the call graph for this function:

ilTextInputGUI::getToolbarHTML

(

)

Get HTML for toolbar.

Implements ilToolbarItem.

Definition at line 486 of file class.ilTextInputGUI.php.

References render().

        {
                $html = $this->render("toolbar");
                return $html;
        }

Here is the call graph for this function:

ilTextInputGUI::getValidationFailureMessage

(

)

Definition at line 76 of file class.ilTextInputGUI.php.

References $validationFailureMessage.

Referenced by checkInput().

        {
                return $this->validationFailureMessage;
        }

Here is the caller graph for this function:

ilTextInputGUI::getValidationRegexp

(

)

Get validation regexp.

Returns

string regexp

Definition at line 96 of file class.ilTextInputGUI.php.

References $validationRegexp.

Referenced by ilTextWizardInputGUI\checkInput(), and checkInput().

        {
                return $this->validationRegexp;
        }

Here is the caller graph for this function:

ilTextInputGUI::getValue

(

)

Get Value.

Returns

string Value

Definition at line 61 of file class.ilTextInputGUI.php.

References $value.

Referenced by ilColorPickerInputGUI\insert(), ilScaleInputGUI\render(), and render().

        {
                return $this->value;
        }

Here is the caller graph for this function:

ilTextInputGUI::insert

(

&

$a_tpl

)

Insert property html.

Returns

int Size

Reimplemented in ilSingleChoiceWizardInputGUI, ilMatchingWizardInputGUI, ilCategoryWizardInputGUI, ilKVPWizardInputGUI, ilErrorTextWizardInputGUI, ilImageWizardInputGUI, ilMultipleChoiceWizardInputGUI, ilAnswerWizardInputGUI, ilMatrixRowWizardInputGUI, ilMatchingPairWizardInputGUI, and ilTextWizardInputGUI.

Definition at line 465 of file class.ilTextInputGUI.php.

References render().

        {
                $html = $this->render();

                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $html);
                $a_tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

ilTextInputGUI::render (   $a_mode = "" )

protected

Render item.

Reimplemented in ilScaleInputGUI.

Definition at line 365 of file class.ilTextInputGUI.php.

References $tpl, ilJsonUtil\encode(), getCssClass(), getDataSource(), getDataSourceDelimiter(), getDataSourceResultFormat(), getDataSourceSchema(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), getInlineStyle(), getInputType(), getMaxLength(), ilFormPropertyGUI\getPostVar(), getSize(), getSubmitFormOnEnter(), getSuffix(), getValue(), ilYuiUtil\initAutoComplete(), and ilUtil\prepareFormOutput().

Referenced by getTableFilterHTML(), getToolbarHTML(), and insert().

        {
                $tpl = new ilTemplate("tpl.prop_textinput.html", true, true, "Services/Form");
                if (strlen($this->getValue()))
                {
                        $tpl->setCurrentBlock("prop_text_propval");
                        $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
                        $tpl->parseCurrentBlock();
                }
                if (strlen($this->getInlineStyle()))
                {
                        $tpl->setCurrentBlock("stylecss");
                        $tpl->setVariable("CSS_STYLE", ilUtil::prepareFormOutput($this->getInlineStyle()));
                        $tpl->parseCurrentBlock();
                }
                if(strlen($this->getCssClass()))
                {
                        $tpl->setCurrentBlock("classcss");
                        $tpl->setVariable('CLASS_CSS', ilUtil::prepareFormOutput($this->getCssClass()));
                        $tpl->parseCurrentBlock();
                }
                if ($this->getSubmitFormOnEnter())
                {
                        $tpl->touchBlock("submit_form_on_enter");
                }

                switch($this->getInputType())
                {
                        case 'password':
                                $tpl->setVariable('PROP_INPUT_TYPE','password');
                                break;
                        case 'hidden':
                                $tpl->setVariable('PROP_INPUT_TYPE','hidden');
                                break;
                        case 'text':
                        default:
                                $tpl->setVariable('PROP_INPUT_TYPE','text');
                }
                $tpl->setVariable("ID", $this->getFieldId());
                $tpl->setVariable("SIZE", $this->getSize());
                if($this->getMaxLength() != null)
                        $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
                if (strlen($this->getSuffix())) $tpl->setVariable("INPUT_SUFFIX", $this->getSuffix());
                
                if ($this->getDisabled())
                {
                        $tpl->setVariable("DISABLED",
                                " disabled=\"disabled\"");
                        $tpl->setVariable("HIDDEN_INPUT",
                                $this->getHiddenTag($this->getPostVar(), $this->getValue()));
                }
                else
                {
                        $tpl->setVariable("POST_VAR", $this->getPostVar());
                }

                // use autocomplete feature?
                if ($this->getDataSource() && $this->getDataSourceSchema())
                {
                        include_once "./Services/YUI/classes/class.ilYuiUtil.php";
                        include_once "./Services/JSON/classes/class.ilJsonUtil.php";
                        ilYuiUtil::initAutoComplete();
                        $tpl->setVariable('ID_AUTOCOMPLETE', $this->getFieldId() . "_autocomplete");
                        $tpl->setVariable('YUI_DATASOURCE', $this->getDataSource());
                        $tpl->setVariable('YUI_DATASCHEMA', ilJsonUtil::encode($this->getDataSourceSchema()));
                        if ($this->getDataSourceResultFormat())
                        {
                                $tpl->setVariable('YUI_FORMAT_CALLBACK', $this->getDataSourceResultFormat());
                        }

                        if ($this->getDataSourceDelimiter())
                        {
                                $tpl->setVariable('DELIMITER_ARRAY', ilJsonUtil::encode($this->getDataSourceDelimiter()));      
                        }
                }
                
                if ($a_mode == "toolbar")
                {
                        // block-inline hack, see: http://blog.mozilla.com/webdev/2009/02/20/cross-browser-inline-block/
                        // -moz-inline-stack for FF2
                        // zoom 1; *display:inline for IE6 & 7
                        $tpl->setVariable("STYLE_PAR", 'display: -moz-inline-stack; display:inline-block; zoom: 1; *display:inline;');
                        if ($this->getDataSource() && $this->getDataSourceSchema())
                        {
                                $tpl->setVariable("AC_STYLE", 'style="position:absolute; width:400px;"');
                        }
                }
                else
                {
                        $tpl->setVariable("STYLE_PAR", '');
                }
                
                return $tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilTextInputGUI::setCssClass

(

$a_class

)

Definition at line 151 of file class.ilTextInputGUI.php.

        {
                $this->css_class = $a_class;
        }

ilTextInputGUI::setDataSource

(

$href

)

set datasource link for YUI autocomplete

Parameters

String

link to data generation script

Definition at line 289 of file class.ilTextInputGUI.php.

Referenced by ilRoleAutoCompleteInputGUI\__construct(), ilUserLoginAutoCompleteInputGUI\__construct(), and ilMailAddressbookGUI\showAddressbook().

        {
                $this->yui_dataSource = $href;
        }

Here is the caller graph for this function:

ilTextInputGUI::setDataSourceDelimiter

(

$ar

)

set data delimiter array

Parameters

array

array of chars. Each char will be used as delimiter to handle multiple inputs in one field (e.g. multiple email recipients)

Definition at line 346 of file class.ilTextInputGUI.php.

        {
                if (!is_array($ar))
                        $ar = array($ar);
                $this->yui_delimiterarray = $ar;
        }

ilTextInputGUI::setDataSourceResultFormat

(

$callback

)

set data result format callback for YUI autocomplete

Parameters

String

Javascript callback function which takes three parameters. $callback can be a the name of a function without parenthesis or an function (a, b, c) {...} text block

Definition at line 335 of file class.ilTextInputGUI.php.

Referenced by ilRoleAutoCompleteInputGUI\__construct(), and ilUserLoginAutoCompleteInputGUI\__construct().

        {
                $this->yui_formatCallback = $callback;
        }

Here is the caller graph for this function:

ilTextInputGUI::setDataSourceSchema

(

$ds

)

set datasource schema for YUI autocomplete

Parameters

array

Data Schema as array. The first Element contains a path in dot notation to a result array in the expected json response e.g. for the json response {response : { result : [firstObject, secondObject ...] }} the dot notated path is 'response.result' The following Elements contains names of attributes within the resultobjects (firstObject, secondObject... see above) which should be passed to the autocomplete component. You can define a javascript format callback function, to process the passed values (see setDataSourceResultFormat for more information)

Definition at line 316 of file class.ilTextInputGUI.php.

Referenced by ilRoleAutoCompleteInputGUI\__construct(), and ilUserLoginAutoCompleteInputGUI\__construct().

        {
                $this->yui_dataSchema = $ds;
        }

Here is the caller graph for this function:

ilTextInputGUI::setInlineStyle

(

$a_style

)

Set inline style.

Parameters

string

$a_style

style

Definition at line 136 of file class.ilTextInputGUI.php.

        {
                $this->style_css = $a_style;
        }

ilTextInputGUI::setInputType

(

$a_type

)

set input type

public

Parameters

string

input type password | text

Definition at line 209 of file class.ilTextInputGUI.php.

Referenced by ilRoleAutoCompleteInputGUI\__construct(), ilUserLoginAutoCompleteInputGUI\__construct(), __construct(), and ilPDNewsBlockGUI\editSettings().

        {
                $this->input_type = $a_type;
        }

Here is the caller graph for this function:

ilTextInputGUI::setMaxLength

(

$a_maxlength

)

Set Max Length.

Parameters

int

$a_maxlength

Max Length

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

Referenced by ilRoleAutoCompleteInputGUI\__construct(), ilUserLoginAutoCompleteInputGUI\__construct(), ilSocialBookmarks\_initForm(), ilObjPaymentSettingsGUI\getERPform_eco(), ilObjMediaCastGUI\initAddCastItemForm(), ilObjExerciseGUI\initAssignmentForm(), ilObjSystemFolderGUI\initBasicSettingsForm(), ilSetupGUI\initClientIniForm(), ilSetupGUI\initClientLoginForm(), ilSetupGUI\initContactDataForm(), ilObjSystemFolderGUI\initContactInformationForm(), ilObjSAHSLearningModuleGUI\initCreationForm(), ilObjContentObjectGUI\initCreationForm(), ilObjectPluginGUI\initEditForm(), ilObjFileBasedLMGUI\initEditForm(), ilObjMediaPoolGUI\initEditForm(), ilObject2GUI\initEditForm(), ilTermListTableGUI\initFilter(), ilPresentationListTableGUI\initFilter(), ilSurveyQuestionblockbrowserTableGUI\initFilter(), ilTestQuestionBrowserTableGUI\initFilter(), ilSurveyQuestionbrowserTableGUI\initFilter(), ilSurveyQuestionsTableGUI\initFilter(), ilRegistrationCodesTableGUI\initFilter(), ilLPTableBaseGUI\initFilter(), ilMediaPoolTableGUI\initFilter(), ilQuestionBrowserTableGUI\initFilter(), ilEvaluationAllTableGUI\initFilter(), ilUserTableGUI\initFilter(), ilObjMediaPoolGUI\initFolderForm(), ilObjSystemFolderGUI\initJavaServerForm(), ilObjMediaPoolGUI\initMediaPoolPageForm(), ilPersonalProfileGUI\initProfilePageForm(), ilObjStyleSheetGUI\initPropertiesForm(), ilSearchGUI\initStandardSearchForm(), ilObjStyleSheetGUI\initTagStyleForm(), ilObjPaymentSettingsGUI\initVatForm(), ilFileSystemGUI\listFiles(), ilObjGlossaryGUI\listTerms(), ilPaymentStatisticGUI\searchUser(), ilObjPaymentSettingsGUI\searchUserSPObject(), and ilObjPrivacySecurityGUI\showSecurity().

        {
                $this->maxlength = $a_maxlength;
        }

Here is the caller graph for this function:

ilTextInputGUI::setSize

(

$a_size

)

Set Size.

Parameters

int

$a_size

Size

Definition at line 126 of file class.ilTextInputGUI.php.

Referenced by ilRoleAutoCompleteInputGUI\__construct(), ilUserLoginAutoCompleteInputGUI\__construct(), ilAnswerWizardInputGUI\__construct(), ilImageWizardInputGUI\__construct(), ilSingleChoiceWizardInputGUI\__construct(), FormMailCodesGUI\__construct(), ilMatchingWizardInputGUI\__construct(), ilObjStyleSettingsGUI\createPgGUIObject(), assNumericGUI\editQuestion(), assClozeTestGUI\editQuestion(), ilObjLearningResourcesSettingsGUI\editSettings(), ilObjPaymentSettingsGUI\generalSettingsObject(), ilSetupGUI\initClientLoginForm(), ilObjectCustomUserFieldsGUI\initFieldForm(), ilObjMailGUI\initForm(), ilCalendarRecurrenceGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjUserGUI\initForm(), ilObjLinkResourceGUI\initFormLink(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilObjectCopyGUI\initFormSearch(), ilConsultationHoursGUI\initFormSequence(), ilPCTableGUI\initPropertiesForm(), ilECSSettingsGUI\initSettingsForm(), ilObjGroupGUI\membersObject(), ilObjCourseGUI\membersObject(), ilPageLayoutGUI\properties(), ilObjSurveyGUI\propertiesObject(), ilObjTestGUI\propertiesObject(), ilPCPlaceHolderGUI\propertyGUI(), ilMailFormGUI\searchUsers(), ilMailFormGUI\showForm(), ilStartUpGUI\showLogin(), ilStartUpGUI\showOpenIdLogin(), ilMailSearchGUI\showResults(), ilPaymentTrusteeGUI\showTrustees(), ilObjTaggingSettingsGUI\showUsers(), ilObjPaymentSettingsGUI\vendorsObject(), and ilObjPDFGenerationGUI\webkitObject().

        {
                $this->size = $a_size;
        }

Here is the caller graph for this function:

ilTextInputGUI::setSubmitFormOnEnter

(

$a_val

)

Set submit form on enter.

Parameters

boolean

Definition at line 229 of file class.ilTextInputGUI.php.

        {
                $this->submit_form_on_enter = $a_val;
        }

ilTextInputGUI::setSuffix

(

$a_value

)

Set suffix.

Parameters

string

$a_value

suffix

Definition at line 187 of file class.ilTextInputGUI.php.

        {
                $this->suffix = $a_value;
        }

ilTextInputGUI::setValidationFailureMessage

(

$a_msg

)

Set message string for validation failure.

Returns

Parameters

string

$a_msg

Definition at line 71 of file class.ilTextInputGUI.php.

        {
                $this->validationFailureMessage = $a_msg;
        }

ilTextInputGUI::setValidationRegexp

(

$a_value

)

Set validation regexp.

Parameters

string

$a_value

regexp

Definition at line 86 of file class.ilTextInputGUI.php.

Referenced by ilOpenIdSettingsGUI\initFormProvider().

        {
                $this->validationRegexp = $a_value;
        }

Here is the caller graph for this function:

ilTextInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

Reimplemented in ilMatchingWizardInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilTextWizardInputGUI, ilSingleChoiceWizardInputGUI, ilKVPWizardInputGUI, ilColorPickerInputGUI, ilErrorTextWizardInputGUI, ilImageWizardInputGUI, ilAnswerWizardInputGUI, ilMatchingPairWizardInputGUI, ilMultipleChoiceWizardInputGUI, and ilFormulaInputGUI.

Definition at line 51 of file class.ilTextInputGUI.php.

Referenced by assQuestionGUI\addBasicQuestionFormProperties(), ilPaymentCouponGUI\addCoupon(), ilObjPaymentSettingsGUI\addCurrencyObject(), ilUserProfile\addStandardFieldsToForm(), ilObjSystemFolderGUI\benchmarkObject(), ilObjPaymentSettingsGUI\bmfSettingsObject(), ilCertificateGUI\certificateEditor(), ilObjPaymentSettingsGUI\editCurrencyObject(), ilObjFileAccessSettingsGUI\editDiskQuotaSettings(), SurveyTextQuestionGUI\editQuestion(), SurveyMetricQuestionGUI\editQuestion(), SurveySingleChoiceQuestionGUI\editQuestion(), SurveyMultipleChoiceQuestionGUI\editQuestion(), assJavaAppletGUI\editQuestion(), SurveyMatrixQuestionGUI\editQuestion(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilPDNewsBlockGUI\editSettings(), ilObjPaymentSettingsGUI\editVendorObject(), ilObjPaymentSettingsGUI\epaySettingsObject(), ilObjPaymentSettingsGUI\generalSettingsObject(), ilPaymentCouponGUI\generateCodes(), ilLuceneAdvancedSearchFields\getFormElement(), ilAdvancedSearchGUI\initAdvancedMetaDataForm(), ilECSSettingsGUI\initCategoryMappingForm(), ilObjMDSettingsGUI\initCopyrightEditForm(), ilObjSystemFolderGUI\initCronJobsForm(), ilObjRemoteCourseGUI\initEditTable(), ilCalendarAppointmentGUI\initForm(), ilObjSessionGUI\initForm(), ilBookmarkAdministrationGUI\initFormBookmark(), ilCourseObjectivesGUI\initFormLimits(), ilObjLinkResourceGUI\initFormLink(), ilLuceneSearchGUI\initFormSearch(), ilCalendarCategoryGUI\initFormSearch(), ilObjMediaCastSettingsGUI\initFormSettings(), ilObjLinkResourceGUI\initFormSettings(), ilObjCourseGUI\initInfoEditor(), ilPCTableGUI\initPropertiesForm(), ilECSSettingsGUI\initSettingsForm(), ilObjMediaCastGUI\initSettingsForm(), ilShopShoppingCartGUI\newUserForm(), ilAdvancedMDRecordGUI\parseSearch(), ilObjPaymentSettingsGUI\paypalSettingsObject(), ilObjSurveyGUI\propertiesObject(), setValueByArray(), ilMailAddressbookGUI\showAddressForm(), ilPurchaseBMFGUI\showPersonalData(), ilPurchaseBaseGUI\showPersonalData(), ilObjPrivacySecurityGUI\showSecurity(), ilShopGUI\showShopContent(), and ilShopTopicsGUI\showTopicForm().

        {
                $this->value = $a_value;
        }

Here is the caller graph for this function:

ilTextInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

Definition at line 167 of file class.ilTextInputGUI.php.

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

        {
                $this->setValue($a_values[$this->getPostVar()]);
        }

Here is the call graph for this function:

Field Documentation

ilTextInputGUI::$css_class

protected

Definition at line 24 of file class.ilTextInputGUI.php.

Referenced by getCssClass().

ilTextInputGUI::$maxlength = 200

protected

Definition at line 18 of file class.ilTextInputGUI.php.

Referenced by getMaxLength().

ilTextInputGUI::$size = 40

protected

Definition at line 19 of file class.ilTextInputGUI.php.

Referenced by getSize().

ilTextInputGUI::$style_css

protected

Definition at line 23 of file class.ilTextInputGUI.php.

Referenced by getInlineStyle().

ilTextInputGUI::$submit_form_on_enter = false

protected

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

Referenced by getSubmitFormOnEnter().

ilTextInputGUI::$suffix

protected

Definition at line 22 of file class.ilTextInputGUI.php.

Referenced by ilMultipleChoiceWizardInputGUI\checkInput(), ilImageWizardInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), getSuffix(), ilMultipleChoiceWizardInputGUI\insert(), ilImageWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), and ilSingleChoiceWizardInputGUI\insert().

ilTextInputGUI::$validationFailureMessage = ''

protected

Definition at line 21 of file class.ilTextInputGUI.php.

Referenced by getValidationFailureMessage().

ilTextInputGUI::$validationRegexp

protected

Definition at line 20 of file class.ilTextInputGUI.php.

Referenced by getValidationRegexp().

ilTextInputGUI::$value

protected

Definition at line 17 of file class.ilTextInputGUI.php.

Referenced by ilRegExpInputGUI\checkInput(), ilTextWizardInputGUI\checkInput(), ilTRBLColorPickerInputGUI\checkInput(), getValue(), ilTextWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilTRBLColorPickerInputGUI\insert(), ilImageWizardInputGUI\insert(), ilErrorTextWizardInputGUI\insert(), ilKVPWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\setValue(), ilAnswerWizardInputGUI\setValue(), ilImageWizardInputGUI\setValue(), ilSingleChoiceWizardInputGUI\setValue(), ilMatrixRowWizardInputGUI\setValue(), ilCategoryWizardInputGUI\setValue(), and ilMatchingWizardInputGUI\setValue().

ilTextInputGUI::$yui_dataSchema

protected

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

Referenced by getDataSourceSchema().

ilTextInputGUI::$yui_dataSource

protected

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

Referenced by getDataSource().

ilTextInputGUI::$yui_delimiterarray = array()

protected

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

Referenced by getDataSourceDelimiter().

ilTextInputGUI::$yui_formatCallback

protected

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

Referenced by getDataSourceResultFormat().

---

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

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