This class represents a selection list property in a property form. More...

Inheritance diagram for ilSelectInputGUI:

Collaboration diagram for ilSelectInputGUI:

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

	setOptions ($a_options)
	Set Options. More...

	getOptions ()
	Get Options. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setValueByArray ($a_values)
	Set value by array. More...

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

	addCustomAttribute ($a_attr)

	getCustomAttributes ()

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

	setHideSubForm ($a_value, $a_condition=null)
	Set initial sub form visibility, optionally add dynamic value-based condition. More...

	hideSubForm ()

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

	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

Protected Attributes
	$cust_attr = array()

	$options = array()

	$value

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 selection list 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 17 of file class.ilSelectInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References ilFormPropertyGUI\setType().

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

Here is the call graph for this function:

Member Function Documentation

◆ addCustomAttribute()

ilSelectInputGUI::addCustomAttribute ( $a_attr )

Definition at line 134 of file class.ilSelectInputGUI.php.

Referenced by setHideSubForm().

         {
                 $this->cust_attr[] = $a_attr;
         }

Here is the caller graph for this function:

◆ checkInput()

ilSelectInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Definition at line 100 of file class.ilSelectInputGUI.php.

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

         {
                 global $lng;
 
                 $valid = true;
                 if(!$this->getMulti())
                 {
                         $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                         if($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
                         {
                                 $valid = 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()])))
                         {
                                 $valid = false;
                         }
                 }
                 if (!$valid)
                 {
                         $this->setAlert($lng->txt("msg_input_is_required"));
                         return false;
                 }
                 return $this->checkSubItemsInput();
         }

Here is the call graph for this function:

◆ getCustomAttributes()

ilSelectInputGUI::getCustomAttributes ( )

Definition at line 139 of file class.ilSelectInputGUI.php.

References $cust_attr.

Referenced by render().

         {
                 return (array) $this->cust_attr;
         }

Here is the caller graph for this function:

◆ getOptions()

ilSelectInputGUI::getOptions ( )

Get Options.

Returns: array Options. Array ("value" => "option_text")

Definition at line 50 of file class.ilSelectInputGUI.php.

Referenced by render().

         {
                 return $this->options ? $this->options : array();
         }

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilSelectInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 247 of file class.ilSelectInputGUI.php.

References $html, and render().

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

Here is the call graph for this function:

◆ getToolbarHTML()

ilSelectInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

Implements ilToolbarItem.

Definition at line 256 of file class.ilSelectInputGUI.php.

References $html, and render().

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

Here is the call graph for this function:

◆ getValue()

ilSelectInputGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 75 of file class.ilSelectInputGUI.php.

References $value.

Referenced by render().

         {
                 return $this->value;
         }

Here is the caller graph for this function:

◆ hideSubForm()

ilSelectInputGUI::hideSubForm ( )

Definition at line 281 of file class.ilSelectInputGUI.php.

         {
                 return (bool)$this->hide_sub;
         }

◆ insert()

ilSelectInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

Definition at line 237 of file class.ilSelectInputGUI.php.

References render().

         {
                 $a_tpl->setCurrentBlock("prop_generic");
                 $a_tpl->setVariable("PROP_GENERIC", $this->render());
                 $a_tpl->parseCurrentBlock();
         }

Here is the call graph for this function:

◆ render()

ilSelectInputGUI::render ( $a_mode = "" )

Render item.

Definition at line 147 of file class.ilSelectInputGUI.php.

References ilFormPropertyGUI\$postvar, $tpl, $value, getCustomAttributes(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), ilFormPropertyGUI\getMulti(), ilFormPropertyGUI\getMultiIconsHTML(), ilFormPropertyGUI\getMultiValues(), getOptions(), ilFormPropertyGUI\getPostVar(), getValue(), and ilUtil\prepareFormOutput().

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

         {
                 $tpl = new ilTemplate("tpl.prop_select.html", true, true, "Services/Form");
                 
                 foreach($this->getCustomAttributes() as $attr)
                 {
                         $tpl->setCurrentBlock('cust_attr');
                         $tpl->setVariable('CUSTOM_ATTR',$attr);
                         $tpl->parseCurrentBlock();
                 }
                 
                 // determin value to select. Due to accessibility reasons we
                 // should always select a value (per default the first one)
                 $first = true;
                 foreach($this->getOptions() as $option_value => $option_text)
                 {
                         if ($first)
                         {
                                 $sel_value = $option_value;
                         }
                         $first = false;
                         if ((string) $option_value == (string) $this->getValue())
                         {
                                 $sel_value = $option_value;
                         }
                 }
                 foreach($this->getOptions() as $option_value => $option_text)
                 {
                         $tpl->setCurrentBlock("prop_select_option");
                         $tpl->setVariable("VAL_SELECT_OPTION", ilUtil::prepareFormOutput($option_value));
                         if((string) $sel_value == (string) $option_value)
                         {
                                 $tpl->setVariable("CHK_SEL_OPTION",
                                         'selected="selected"');
                         }
                         $tpl->setVariable("TXT_SELECT_OPTION", $option_text);
                         $tpl->parseCurrentBlock();
                 }
                 $tpl->setVariable("ID", $this->getFieldId());
                 
                 $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);
                 }
                 
                 // multi icons
                 if($this->getMulti() && !$a_mode && !$this->getDisabled())
                 {
                         $tpl->touchBlock("inline_in_bl");
                         $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:

◆ setHideSubForm()

ilSelectInputGUI::setHideSubForm	(	$a_value,
		$a_condition = `null`
	)

Set initial sub form visibility, optionally add dynamic value-based condition.

See also: ilObjBookingPoolGUI

Parameters

bool	$a_value
string	$a_condition

Definition at line 269 of file class.ilSelectInputGUI.php.

References addCustomAttribute(), and ilFormPropertyGUI\getFieldId().

         {
                 $this->hide_sub = (bool)$a_value;
                 
                 if($a_condition)
                 {
                         $this->addCustomAttribute('onchange="if(this.value '.$a_condition.')'.
                                 ' { il.Form.showSubForm(\'subform_'.$this->getFieldId().'\', \'il_prop_cont_'.$this->getFieldId().'\'); }'.
                                 ' else { il.Form.hideSubForm(\'subform_'.$this->getFieldId().'\'); };"');
                 }
         }

Here is the call graph for this function:

◆ setOptions()

ilSelectInputGUI::setOptions ( $a_options )

Set Options.

Parameters

array $a_options Options. Array ("value" => "option_text")

Definition at line 40 of file class.ilSelectInputGUI.php.

Referenced by FormMailCodesGUI\__construct(), ilContactGUI\activateTab(), ilSurveyEvaluationGUI\addApprSelectionToToolbar(), ilPaymentStatisticGUI\addCustomer(), ilObjPaymentSettingsGUI\addCustomerObject(), ilMemberAgreementGUI\addCustomFields(), ilTestExpressPageObjectGUI\addQuestion(), ilObjTestGUI\addQuestionObject(), ilSurveyPageGUI\addQuestionToolbarForm(), ilUserProfile\addStandardFieldsToForm(), ilTestSkillEvaluationToolbarGUI\build(), ilObjQuestionPoolGUI\buildCreateQuestionForm(), ilObjStudyProgrammeSettingsGUI\buildForm(), ilObjTestDynamicQuestionSetConfigGUI\buildForm(), ilSurveyEvaluationGUI\competenceEval(), ilSurveyConstraintsGUI\constraintForm(), ilSurveyEditorGUI\copyQuestionsToPoolObject(), ilSurveyEditorGUI\createQuestionObject(), ilObjTestGUI\createQuestionObject(), ilSessionStatisticsGUI\current(), ilPCTableGUI\editCellAlignment(), ilObjPaymentSettingsGUI\editDetailsObject(), ilObjExternalToolsSettingsGUI\editMapsObject(), ilObjHelpSettingsGUI\editSettings(), ilObjNewsSettingsGUI\editSettings(), ilPDNewsBlockGUI\editSettings(), ilSurveyEvaluationGUI\evaluation(), ilSurveyEvaluationGUI\evaluationuser(), ilTestEvaluationGUI\exportFileUploadsForAllParticipants(), ilObjAuthSettingsGUI\getApacheAuthSettingsForm(), ilNotificationAdminSettingsForm\getChannelForm(), ilNotificationAdminSettingsForm\getGeneralSettingsForm(), ilObjectTranslationGUI\getMultiLangForm(), ilPCIIMTriggerEditorGUI\getToolbar(), ilImageMapEditorGUI\getToolbar(), ilExAssignmentEditorGUI\getTypeDropdown(), ilNotificationAdminSettingsForm\getTypeForm(), ilObjStyleSettingsGUI\initAddPageLayoutForm(), ilAdvancedSearchGUI\initAdvancedMetaDataForm(), ilSetupGUI\initBasicSettingsForm(), ilECSSettingsGUI\initCategoryMappingForm(), ilObjStyleSheetGUI\initCharacteristicForm(), ilObjGlossaryGUI\initCreateForm(), ilTestManScoringParticipantsBySelectedQuestionAndPassTableGUI\initFilter(), ilTestManScoringParticipantsTableGUI\initFilter(), ilTestDynamicQuestionSetStatisticTableGUI\initFilter(), ilBuddySystemRelationsTableGUI\initFilter(), ilTestParticipantsTableGUI\initFilter(), ilRoleTableGUI\initFilter(), ilRegistrationCodesTableGUI\initFilter(), ilUserTableGUI\initFilter(), ilObjMailGUI\initForm(), ilPCTabsGUI\initForm(), ilPageLayoutGUI\initForm(), ilCalendarAppointmentGUI\initForm(), ilDataCollectionFieldEditGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjUserGUI\initForm(), ilObjLinkResourceGUI\initFormLink(), ilCourseObjectivesGUI\initFormRandom(), ilConsultationHoursGUI\initFormSequence(), ilCASSettingsGUI\initFormSettings(), ilObjAwarenessAdministrationGUI\initFormSettings(), ilObjLoggingSettingsGUI\initFormSettings(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilSurveyEditorGUI\initHeadingForm(), ilObjSurveyGUI\initImportForm(), ilObjTestGUI\initImportForm(), ilObjSystemFolderGUI\initJavaServerIniForm(), ilPCListGUI\initListForm(), ilPersonalSettingsGUI\initMailOptionsForm(), ilMailOptionsGUI\initMailOptionsForm(), ilObjSCORM2004LearningModuleGUI\initPropertiesEditableForm(), ilPCTableGUI\initPropertiesForm(), ilObjSCORM2004LearningModuleGUI\initPropertiesForm(), ilObjContentObjectGUI\initPropertiesForm(), ilPCSourceCodeGUI\initPropertyForm(), ilObjRepositorySettingsGUI\initSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilObjTaxonomyGUI\initSettingsForm(), ilObjContentObjectGUI\initStylePropertiesForm(), ilObjPortfolioBaseGUI\initStylePropertiesForm(), ilObjSCORM2004LearningModuleGUI\initStylePropertiesForm(), ilObjGlossaryGUI\initStylePropertiesForm(), ilObjWikiGUI\initStylePropertiesForm(), ilObjBlogGUI\initStylePropertiesForm(), ilContainerGUI\initStylePropertiesForm(), ilObjStyleSheetGUI\initTagStyleForm(), ilObjStyleSheetGUI\initTemplateGenerationForm(), ilObjSAHSLearningModuleGUI\initUploadForm(), ilPCQuestionGUI\insert(), assFormulaQuestionGUI\isSaveCommand(), ilSessionStatisticsGUI\long(), ilSurveyPageGUI\movePageForm(), ilObjTestGUI\movePageFormObject(), ilTermsOfServiceAcceptanceHistoryTableGUI\numericOrdering(), ilSCORM2004TrackingItemsPerUserFilterGUI\parse(), assKprimChoiceGUI\populateQuestionSpecificFormPart(), assMatchingQuestionGUI\populateQuestionSpecificFormPart(), assTextSubsetGUI\populateQuestionSpecificFormPart(), ilSurveyEditorGUI\printViewObject(), ilObjSCORMLearningModuleGUI\properties(), ilSurveyEditorGUI\questionsObject(), ilTestEvaluationGUI\resetfilterEvaluation(), ilPaymentObjectGUI\resetObjectFilter(), ilObjOrgUnitSettingsFormGUI\saveObject(), ilSurveyEditorGUI\setBrowseForQuestionsSubtabs(), ilRadiusSettingsGUI\settings(), ilOpenIdSettingsGUI\settings(), ilObjCertificateSettingsGUI\settings(), ilSessionStatisticsGUI\short(), ilChatroomHistoryTask\showMessages(), ilStartUpGUI\showOpenIdLoginForm(), ilPurchaseBMFGUI\showPersonalData(), ilPurchaseBaseGUI\showPersonalData(), ilPaymentObjectGUI\showSelectedObject(), ilExcCriteriaGUI\view(), ilPDNotesGUI\view(), and ilWikiStatGUI\viewToolbar().

         {
                 $this->options = $a_options;
         }

Here is the caller graph for this function:

◆ setValue()

ilSelectInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

Definition at line 60 of file class.ilSelectInputGUI.php.

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

Referenced by ilUserProfile\addStandardFieldsToForm(), ilObjPaymentSettingsGUI\getSubTabs(), ilECSSettingsGUI\initCategoryMappingForm(), ilOrgUnitTypeFormGUI\initForm(), ilStudyProgrammeTypeFormGUI\initForm(), ilCalendarAppointmentGUI\initForm(), ilObjSearchSettingsGUI\initFormSettings(), ilAuthLoginPageEditorGUI\initLoginForm(), ilECSSettingsGUI\initMappingsForm(), ilObjPaymentSettingsGUI\InvoiceNumberObject(), ilTaxAssignInputGUI\setCurrentValues(), setValueByArray(), and ilShopTopicsGUI\showTopicsSettings().

         {
                 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()

ilSelectInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

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

         {               
                 $this->setValue($a_values[$this->getPostVar()]);
                 foreach($this->getSubItems() as $item)
                 {
                         $item->setValueByArray($a_values);
                 }
         }

Here is the call graph for this function:

Field Documentation

◆ $cust_attr

ilSelectInputGUI::$cust_attr = array()

protected

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

Referenced by getCustomAttributes().

◆ $options

ilSelectInputGUI::$options = array()

protected

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

Referenced by ilCountrySelectInputGUI\getOptions(), and ilTaxAssignInputGUI\getOptions().

◆ $value

ilSelectInputGUI::$value

protected

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

Referenced by checkInput(), getValue(), and render().

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

Services/Form/classes/class.ilSelectInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomAttribute()

◆ checkInput()

◆ getCustomAttributes()

◆ getOptions()

◆ getTableFilterHTML()

◆ getToolbarHTML()

◆ getValue()

◆ hideSubForm()

◆ insert()

◆ render()

◆ setHideSubForm()

◆ setOptions()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $cust_attr

◆ $options

◆ $value