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. 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...
	setMultiValues (array $a_values)
	render ($a_mode="")
	Render item. More...
	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...

Protected Attributes
	$value
	$maxlength = 200
	$size = 40
	$validationRegexp
	$validationFailureMessage = ''
	$suffix
	$style_css
	$css_class
	$ajax_datasource
	$ajax_datasource_delimiter
	$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

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...
	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

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 16 of file class.ilTextInputGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References setInputType(), and ilFormPropertyGUI\setType().

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

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilTextInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

boolean Input ok, true/false

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

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

        {
                global $lng;
                
                if(!$this->getMulti())
                {               
                        $_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;
                                }
                        }                       
                }
                else 
                {                       
                        foreach($_POST[$this->getPostVar()] as $idx => $value)
                        {
                                $_POST[$this->getPostVar()][$idx] = ilUtil::stripSlashes($value);
                        }               
                        $_POST[$this->getPostVar()] = array_unique($_POST[$this->getPostVar()]);
                        
                        if ($this->getRequired() && !trim(implode("", $_POST[$this->getPostVar()])))
                        {
                                $this->setAlert($lng->txt("msg_input_is_required"));

                                return false;
                        }
                        else if (strlen($this->getValidationRegexp()))
                        {
                                $reg_valid = true;
                                foreach($_POST[$this->getPostVar()] as $value)
                                {
                                        if (!preg_match($this->getValidationRegexp(), $value))
                                        {
                                                $reg_valid = false;
                                                break;
                                        }
                                }
                                if(!$reg_valid)
                                {
                                        $this->setAlert(
                                                $this->getValidationFailureMessage() ?
                                                $this->getValidationFailureMessage() :
                                                $lng->txt('msg_wrong_format')
                                        );
                                        return false;
                                }
                        }
                }               
                
                return $this->checkSubItemsInput();
        }

Here is the call graph for this function:

getCssClass()

ilTextInputGUI::getCssClass

(

)

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

References $css_class.

Referenced by ilMailQuickFilterInputGUI\checkInput(), and render().

        {
                return $this->css_class;
        }

Here is the caller graph for this function:

getDataSource()

ilTextInputGUI::getDataSource

(

)

get datasource link for js autocomplete

Returns

String link to data generation script

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

References $ajax_datasource.

Referenced by ilMailQuickFilterInputGUI\checkInput(), and render().

         {
                return $this->ajax_datasource;
         }

Here is the caller graph for this function:

getInlineStyle()

ilTextInputGUI::getInlineStyle

(

)

Get inline style.

Returns

string style

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

References $style_css.

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

        {
                return $this->style_css;
        }

Here is the caller graph for this function:

getInputType()

ilTextInputGUI::getInputType

(

)

get input type

public

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

Referenced by ilMailQuickFilterInputGUI\checkInput(), and render().

        {
                return $this->input_type;
        }

Here is the caller graph for this function:

getMaxLength()

ilTextInputGUI::getMaxLength

(

)

Get Max Length.

Returns

int Max Length

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

References $maxlength.

Referenced by ilMailQuickFilterInputGUI\checkInput(), ilSelectBuilderInputGUI\insert(), ilTextWizardInputGUI\insert(), ilOrderingTextWizardInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilEssayKeywordWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilScaleInputGUI\render(), and render().

        {
                return $this->maxlength;
        }

Here is the caller graph for this function:

getSize()

ilTextInputGUI::getSize

(

)

Get Size.

Returns

int Size

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

References $size.

Referenced by ilMailQuickFilterInputGUI\checkInput(), ilSelectBuilderInputGUI\insert(), ilTextWizardInputGUI\insert(), ilOrderingTextWizardInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilEssayKeywordWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilScaleInputGUI\render(), and render().

        {
                return $this->size;
        }

Here is the caller graph for this function:

getSubmitFormOnEnter()

ilTextInputGUI::getSubmitFormOnEnter

(

)

Get submit form on enter.

Returns

boolean

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

References $submit_form_on_enter.

Referenced by ilMailQuickFilterInputGUI\checkInput(), and render().

        {
                return $this->submit_form_on_enter;
        }

Here is the caller graph for this function:

getSuffix()

ilTextInputGUI::getSuffix

(

)

Get suffix.

Returns

string suffix

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

References $suffix.

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

        {
                return $this->suffix;
        }

Here is the caller graph for this function:

getTableFilterHTML()

ilTextInputGUI::getTableFilterHTML

(

)

Get HTML for table filter.

Implements ilTableFilterItem.

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

References render().

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

Here is the call graph for this function:

getToolbarHTML()

ilTextInputGUI::getToolbarHTML

(

)

Get HTML for toolbar.

Implements ilToolbarItem.

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

References render().

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

Here is the call graph for this function:

getValidationFailureMessage()

ilTextInputGUI::getValidationFailureMessage

(

)

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

References $validationFailureMessage.

Referenced by checkInput().

        {
                return $this->validationFailureMessage;
        }

Here is the caller graph for this function:

getValidationRegexp()

ilTextInputGUI::getValidationRegexp

(

)

Get validation regexp.

Returns

string regexp

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

References $validationRegexp.

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

        {
                return $this->validationRegexp;
        }

Here is the caller graph for this function:

getValue()

ilTextInputGUI::getValue

(

)

Get Value.

Returns

string Value

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

References $value.

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

        {
                return $this->value;
        }

Here is the caller graph for this function:

insert()

ilTextInputGUI::insert

(

&

$a_tpl

)

Insert property html.

Returns

int Size

Definition at line 509 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:

isHtmlAutoCompleteDisabled()

ilTextInputGUI::isHtmlAutoCompleteDisabled

(

)

Returns

boolean

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

References $autocomplete_disabled.

Referenced by render().

        {
                return $this->autocomplete_disabled;
        }

Here is the caller graph for this function:

render()

ilTextInputGUI::render

(

$a_mode = ""

)

Render item.

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

References ilFormPropertyGUI\$postvar, $tpl, $value, getCssClass(), getDataSource(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), getInlineStyle(), getInputType(), getMaxLength(), ilFormPropertyGUI\getMulti(), ilFormPropertyGUI\getMultiIconsHTML(), ilFormPropertyGUI\getMultiValues(), ilFormPropertyGUI\getPostVar(), getSize(), getSubmitFormOnEnter(), getSuffix(), getValue(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), isHtmlAutoCompleteDisabled(), and ilUtil\prepareFormOutput().

Referenced by ilMailQuickFilterInputGUI\checkInput(), 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());
                
                $postvar = $this->getPostVar();         
                if($this->getMulti() && substr($postvar, -2) != "[]")
                {
                        $postvar .= "[]";
                }
                
                if ($this->getDisabled())
                {
                        if($this->getMulti())
                        {
                                $value = $this->getMultiValues();
                                $hidden = "";   
                                if(is_array($value))
                                {
                                        foreach($value as $item)
                                        {
                                                $hidden .= $this->getHiddenTag($postvar, $item);
                                        }
                                }
                        }
                        else
                        {                       
                                $hidden = $this->getHiddenTag($postvar, $this->getValue());
                        }                       
                        if($hidden)
                        {
                                $tpl->setVariable("DISABLED", " disabled=\"disabled\"");
                                $tpl->setVariable("HIDDEN_INPUT", $hidden);
                        }                       
                }
                else
                {
                        $tpl->setVariable("POST_VAR", $postvar);
                }

                // use autocomplete feature?            
                if ($this->getDataSource())
                {
                        include_once "Services/jQuery/classes/class.iljQueryUtil.php";
                        iljQueryUtil::initjQuery();
                        iljQueryUtil::initjQueryUI();
                        
                        if ($this->getMulti())
                        {
                                $tpl->setCurrentBlock("ac_multi");
                                $tpl->setVariable('MURL_AUTOCOMPLETE', $this->getDataSource());
                                $tpl->setVariable('ID_AUTOCOMPLETE', $this->getFieldId());
                                $tpl->parseCurrentBlock();
                                
                                // set to fields that start with autocomplete selector
                                $sel_auto = '[id^="'.$this->getFieldId().'"]';
                        }
                        else
                        {
                                // use id for autocomplete selector
                                $sel_auto = "#".$this->getFieldId();
                        }
                        
                        if(!$this->ajax_datasource_delimiter)
                        {
                                $tpl->setCurrentBlock("autocomplete_bl");
                                $tpl->setVariable('SEL_AUTOCOMPLETE', $sel_auto);
                                $tpl->setVariable('URL_AUTOCOMPLETE', $this->getDataSource());
                                $tpl->parseCurrentBlock();
                        }
                        else
                        {
                                $tpl->setCurrentBlock("autocomplete_bl");
                                $tpl->setVariable('AUTOCOMPLETE_DELIMITER', $this->ajax_datasource_delimiter);
                                $tpl->setVariable('SEL_AUTOCOMPLETE_DELIMITER', $sel_auto);
                                $tpl->setVariable('URL_AUTOCOMPLETE_DELIMITER', $this->getDataSource());
                                $tpl->parseCurrentBlock();
                        }
                }
                
                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;');
                }
                else
                {
                        $tpl->setVariable("STYLE_PAR", '');
                }

                if($this->isHtmlAutoCompleteDisabled())
                {
                        $tpl->setVariable("AUTOCOMPLETE", "autocomplete=\"off\"");
                }
                
                // multi icons
                if($this->getMulti() && !$a_mode && !$this->getDisabled())
                {
                        $tpl->setVariable("MULTI_ICONS", $this->getMultiIconsHTML());
                }
                
                return $tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setCssClass()

ilTextInputGUI::setCssClass

(

$a_class

)

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

        {
                $this->css_class = $a_class;
        }

setDataSource()

ilTextInputGUI::setDataSource	(		$href,
			$a_delimiter = null
	)

set datasource link for js autocomplete

Parameters

String

link to data generation script

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

Referenced by ilRoleAutoCompleteInputGUI\__construct(), ilUserTableGUI\initFilter(), ilObjSurveyGUI\initPropertiesForm(), ilTermsOfServiceAcceptanceHistoryTableGUI\numericOrdering(), ilPermission2GUI\owner(), ilMailAddressbookGUI\search(), and ilPaymentTrusteeGUI\showTrustees().

        {
                $this->ajax_datasource = $href;
                $this->ajax_datasource_delimiter = $a_delimiter;
        }

Here is the caller graph for this function:

setDisableHtmlAutoComplete()

ilTextInputGUI::setDisableHtmlAutoComplete

(

$autocomplete

)

Parameters

boolean

$autocomplete

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

        {
                $this->autocomplete_disabled = $autocomplete;
        }

setInlineStyle()

ilTextInputGUI::setInlineStyle

(

$a_style

)

Set inline style.

Parameters

string

$a_style

style

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

Referenced by assClozeTestGUI\populateNumericGapFormPart().

        {
                $this->style_css = $a_style;
        }

Here is the caller graph for this function:

setInputType()

ilTextInputGUI::setInputType

(

$a_type

)

set input type

public

Parameters

string

input type password | text

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

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

        {
                $this->input_type = $a_type;
        }

Here is the caller graph for this function:

setMaxLength()

ilTextInputGUI::setMaxLength

(

$a_maxlength

)

Set Max Length.

Parameters

int

$a_maxlength

Max Length

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

Referenced by ilRoleAutoCompleteInputGUI\__construct(), ilSocialBookmarks\_initForm(), ilObjForumGUI\cancelPostObject(), ilObjStyleSheetGUI\createObject(), ilObjMediaCastGUI\editCastItemObject(), ilObjForumGUI\getModifiedReOnSubject(), ilObjMediaCastGUI\initAddCastItemForm(), ilPCIIMTriggerEditorGUI\initAreaEditingForm(), ilImageMapEditorGUI\initAreaEditingForm(), ilObjExerciseGUI\initAssignmentForm(), ilRatingCategoryGUI\initCategoryForm(), ilSetupGUI\initClientIniForm(), ilSetupGUI\initClientLoginForm(), ilSetupGUI\initContactDataForm(), ilObjSystemFolderGUI\initContactInformationForm(), ilObjPortfolioGUI\initCopyPageFormOptions(), ilObjPortfolioGUI\initCreateForm(), ilSetupGUI\initDbSlaveForm(), ilPCFileListGUI\initEditForm(), ilTestQuestionBrowserTableGUI\initFilter(), ilLPObjectStatisticsDailyTableGUI\initFilter(), ilLPObjectStatisticsTableGUI\initFilter(), ilPresentationListTableGUI\initFilter(), ilSurveyQuestionblockbrowserTableGUI\initFilter(), ilSurveyQuestionsTableGUI\initFilter(), ilSurveyQuestionbrowserTableGUI\initFilter(), ilAccountCodesTableGUI\initFilter(), ilTermListTableGUI\initFilter(), ilMediaPoolTableGUI\initFilter(), ilLPObjectStatisticsLPTableGUI\initFilter(), ilQuestionBrowserTableGUI\initFilter(), ilEvaluationAllTableGUI\initFilter(), ilRegistrationCodesTableGUI\initFilter(), ilLPTableBaseGUI\initFilter(), ilObjMediaPoolGUI\initFolderForm(), ilBasicSkillTemplateGUI\initForm(), ilSkillCategoryGUI\initForm(), ilBasicSkillGUI\initForm(), ilPCInteractiveImageGUI\initForm(), ilSkillTreeNodeGUI\initForm(), ilObjUserFolderGUI\initFormGeneralSettings(), ilObjSystemFolderGUI\initJavaServerForm(), ilBasicSkillGUI\initLevelForm(), ilObjMediaPoolGUI\initMediaPoolPageForm(), ilObjContentObjectGUI\initMenuEntryForm(), ilObjPortfolioBaseGUI\initPageForm(), ilSkillProfileGUI\initProfileForm(), ilObjStyleSheetGUI\initPropertiesForm(), ilMDEditorGUI\initQuickEditForm(), ilWikiPageGUI\initRenameForm(), ilObjTaxonomyGUI\initSettingsForm(), ilSettingsTemplateGUI\initSettingsTemplateForm(), ilObjStyleSheetGUI\initTagStyleForm(), ilObjTaxonomyGUI\initTaxNodeForm(), ilObjFileAccessSettingsGUI\initUploadSettingsForm(), ilObjPaymentSettingsGUI\initVatForm(), ilFileSystemGUI\listFiles(), ilObjGlossaryGUI\listTerms(), ilFileSystemGUI\renameFileForm(), ilPaymentStatisticGUI\searchUser(), ilObjPaymentSettingsGUI\searchUserSPObject(), ilObjSystemFolderGUI\showBasicSettingsObject(), and ilObjContentObjectGUI\showTooltipList().

        {
                $this->maxlength = $a_maxlength;
        }

Here is the caller graph for this function:

setMultiValues()

ilTextInputGUI::setMultiValues

(

array

$a_values

)

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

References $value.

Referenced by setValue().

        {
                foreach($a_values as $idx => $value)
                {
                        $a_values[$idx] = trim($value);
                        if($a_values[$idx] == "")
                        {
                                unset($a_values[$idx]);
                        }
                }
                parent::setMultiValues($a_values);
        }

Here is the caller graph for this function:

setSize()

ilTextInputGUI::setSize

(

$a_size

)

Set Size.

Parameters

int

$a_size

Size

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

Referenced by ilRoleAutoCompleteInputGUI\__construct(), ilImageWizardInputGUI\__construct(), ilSingleChoiceWizardInputGUI\__construct(), ilMatchingWizardInputGUI\__construct(), FormMailCodesGUI\__construct(), ilAnswerWizardInputGUI\__construct(), ilAccountRegistrationGUI\__initForm(), ilMemberAgreementGUI\addCustomFields(), ilTestExpressPageObjectGUI\addQuestion(), ilObjTestGUI\addQuestionObject(), ilObjTestSettingsGeneralGUI\buildForm(), ilSurveyEditorGUI\createQuestionObject(), ilObjTestGUI\createQuestionObject(), ilObjLearningResourcesSettingsGUI\editSettings(), ilObjPaymentSettingsGUI\getSubTabs(), ilObjStyleSettingsGUI\initAddPageLayoutForm(), ilSetupGUI\initClientLoginForm(), ilObjPortfolioGUI\initCreateForm(), ilObjectPluginGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjCloudGUI\initCreateForm(), ilObjectGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreationForm(), ilObjectPluginGUI\initEditForm(), ilObjPortfolioGUI\initEditForm(), ilObjectGUI\initEditForm(), ilSurveyParticipantsGUI\initExternalRaterForm(), ilObjectCustomUserFieldsGUI\initFieldForm(), ilObjMailGUI\initForm(), ilCalendarRecurrenceGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilPageLayoutGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjUserGUI\initForm(), ilObjLinkResourceGUI\initFormLink(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilObjectCopyGUI\initFormSearch(), ilConsultationHoursGUI\initFormSequence(), ilContainerReferenceGUI\initFormTitle(), ilObjForumGUI\initForumCreateForm(), ilSurveyParticipantsGUI\initMailRatersForm(), ilPCTableGUI\initPropertiesForm(), ilMailSearchGUI\initSearchForm(), ilObjFileBasedLMGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilAdvancedMDRecordGUI\parseFilter(), assNumericGUI\populateAnswerSpecificFormPart(), ilPCPlaceHolderGUI\propertyGUI(), ilObjTestGUI\redirectToInfoScreenObject(), ilMailFormGUI\searchUsers(), ilObjSurveyAdministrationGUI\settingsObject(), ilMailFormGUI\showForm(), ilStartUpGUI\showLoginForm(), ilStartUpGUI\showOpenIdLoginForm(), and ilObjTaggingSettingsGUI\showUsers().

        {
                $this->size = $a_size;
        }

Here is the caller graph for this function:

setSubmitFormOnEnter()

ilTextInputGUI::setSubmitFormOnEnter

(

$a_val

)

Set submit form on enter.

Parameters

boolean

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

Referenced by ilObjCourseGUI\initEditForm(), ilMailFolderTableGUI\initFilter(), and ilObjGroupGUI\initForm().

        {
                $this->submit_form_on_enter = $a_val;
        }

Here is the caller graph for this function:

setSuffix()

ilTextInputGUI::setSuffix

(

$a_value

)

Set suffix.

Parameters

string

$a_value

suffix

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

Referenced by ilObjMailGUI\initForm().

        {
                $this->suffix = $a_value;
        }

Here is the caller graph for this function:

setValidationFailureMessage()

ilTextInputGUI::setValidationFailureMessage

(

$a_msg

)

Set message string for validation failure.

Returns

Parameters

string

$a_msg

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

        {
                $this->validationFailureMessage = $a_msg;
        }

setValidationRegexp()

ilTextInputGUI::setValidationRegexp

(

$a_value

)

Set validation regexp.

Parameters

string

$a_value

regexp

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

Referenced by ilOpenIdSettingsGUI\initFormProvider(), and ilPermissionGUI\initRoleForm().

        {
                $this->validationRegexp = $a_value;
        }

Here is the caller graph for this function:

setValue()

ilTextInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

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

References ilFormPropertyGUI\getMulti(), and setMultiValues().

Referenced by assClozeTestGUI\addBasicQuestionFormProperties(), assQuestionGUI\addBasicQuestionFormProperties(), ilPaymentCouponGUI\addCoupon(), ilObjPaymentSettingsGUI\addCurrencyObject(), ilDAVCronDiskQuota\addCustomSettingsToForm(), ilUserProfile\addStandardFieldsToForm(), ilObjSystemFolderGUI\benchmarkObject(), ilObjTestSettingsGeneralGUI\buildForm(), ilTestScoringGUI\buildManScoringParticipantForm(), ilMailAddressbookGUI\cancel(), ilCertificateGUI\certificateEditor(), ilObjPaymentSettingsGUI\checkShopActivationObject(), ilObjPaymentSettingsGUI\editCurrencyObject(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilObjPaymentSettingsGUI\editVendorObject(), ilLuceneAdvancedSearchFields\getFormElement(), ilDataCollectionDatatype\getInputField(), ilObjPaymentSettingsGUI\getSubTabs(), ilAdvancedSearchGUI\initAdvancedMetaDataForm(), ilECSSettingsGUI\initCategoryMappingForm(), ilObjMDSettingsGUI\initCopyrightEditForm(), ilSetupGUI\initDbSlaveForm(), ilRemoteObjectBaseGUI\initEditForm(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilAdvancedMDSettingsGUI\initFieldForm(), ilExtIdGUI\initForm(), ilCalendarAppointmentGUI\initForm(), ilAttendanceList\initForm(), ilAdvancedMDSettingsGUI\initForm(), ilObjSessionGUI\initForm(), ilObjGroupGUI\initForm(), ilBookmarkAdministrationGUI\initFormBookmark(), ilECSMappingSettingsGUI\initFormCSettings(), ilCourseObjectivesGUI\initFormLimits(), ilCalendarCategoryGUI\initFormSearch(), ilCASSettingsGUI\initFormSettings(), ilObjMediaCastSettingsGUI\initFormSettings(), ilObjLinkResourceGUI\initFormSettings(), ilCourseObjectivesGUI\initFormTitle(), ilObjSystemFolderGUI\initHTTPSForm(), ilObjCourseGUI\initInfoEditor(), ilObjUserFolderGUI\initNewAccountMailForm(), ilPCTableGUI\initPropertiesForm(), ilObjFileGUI\initPropertiesForm(), ilObjSurveyGUI\initPropertiesForm(), ilObjRepositorySettingsGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilObjMediaCastGUI\initSettingsForm(), ilAdvancedMDRecordGUI\parseSearch(), ilSurveyPhrasesGUI\phraseEditor(), assJavaAppletGUI\populateQuestionSpecificFormPart(), setValueByArray(), ilShopGUI\showGeneralFilter(), ilPurchaseBMFGUI\showPersonalData(), ilPurchaseBaseGUI\showPersonalData(), and ilShopTopicsGUI\showTopicForm().

        {                               
                if($this->getMulti() && is_array($a_value))
                {                                               
                        $this->setMultiValues($a_value);        
                        $a_value = array_shift($a_value);               
                }       
                $this->value = $a_value;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setValueByArray()

ilTextInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

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

$ajax_datasource

ilTextInputGUI::$ajax_datasource

protected

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

Referenced by getDataSource().

$ajax_datasource_delimiter

ilTextInputGUI::$ajax_datasource_delimiter

protected

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

$autocomplete_disabled

ilTextInputGUI::$autocomplete_disabled = false

protected

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

Referenced by isHtmlAutoCompleteDisabled().

$css_class

ilTextInputGUI::$css_class

protected

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

Referenced by getCssClass().

$maxlength

ilTextInputGUI::$maxlength = 200

protected

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

Referenced by getMaxLength().

$size

ilTextInputGUI::$size = 40

protected

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

Referenced by getSize().

$style_css

ilTextInputGUI::$style_css

protected

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

Referenced by getInlineStyle().

$submit_form_on_enter

ilTextInputGUI::$submit_form_on_enter = false

protected

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

Referenced by getSubmitFormOnEnter().

$suffix

ilTextInputGUI::$suffix

protected

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

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

$validationFailureMessage

ilTextInputGUI::$validationFailureMessage = ''

protected

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

Referenced by getValidationFailureMessage().

$validationRegexp

ilTextInputGUI::$validationRegexp

protected

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

Referenced by getValidationRegexp().

$value

ilTextInputGUI::$value

protected

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

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

---

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

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