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

Inheritance diagram for ilRadioGroupInputGUI:

Collaboration diagram for ilRadioGroupInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	addOption (ilRadioOption $a_option)

	getOptions ()

	setValue (string $a_value)

	getValue ()

	setValueByArray (array $a_values)

	checkInput ()

	getInput ()

	insert (ilTemplate $a_tpl)

	render ()

	getItemByPostVar (string $a_post_var)

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getFormLabelFor ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

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

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Attributes
array	$options = array()

string	$value = ""

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

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

Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()

	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

This class represents a property in a property form.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilRadioGroupInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setType().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         parent::__construct($a_title, $a_postvar);
         $this->setType("radio");
     }

Here is the call graph for this function:

Member Function Documentation

◆ addOption()

ilRadioGroupInputGUI::addOption ( ilRadioOption $a_option )

Definition at line 42 of file class.ilRadioGroupInputGUI.php.

Referenced by FormMailCodesGUI\__construct(), ilAdvancedMDFieldDefinitionSelect\addRadioToEntriesGroup(), ilIncomingMailInputGUI\addSubOptions(), ilAccessibilityUserHasLanguageCriterionGUI\appendOption(), ilAssConfigurableMultiOptionQuestionFeedback\completeSpecificFormProperties(), ilSurveyConstraintsGUI\constraintForm(), ilForumSettingsGUI\getCustomForm(), ilObjPollGUI\initEditCustomForm(), ilTrUserObjectsPropsTableGUI\initFilter(), ilRegistrationSettingsGUI\initForm(), ilObjStudyProgrammeAdminGUI\initFormSettings(), ilCmiXapiLP\initModeOptions(), ilExAssignmentEditorGUI\initPeerReviewForm(), and assQuestionGUI\suggestedsolution().

                                                       : void
     {
         $this->options[] = $a_option;
     }

Here is the caller graph for this function:

◆ checkInput()

ilRadioGroupInputGUI::checkInput ( )

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

References ilFormPropertyGUI\$lng, getInput(), getOptions(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilLanguage\txt().

                                 : bool
     {
         $lng = $this->lng;
 
         $val = $this->getInput();
         if ($this->getRequired() && trim($val) == "") {
             $this->setAlert($lng->txt("msg_input_is_required"));
             return false;
         }
 
         $ok = true;
         $value = $this->getInput();
         foreach ($this->getOptions() as $option) {
             foreach ($option->getSubItems() as $item) {
                 if ($value == $option->getValue()) {
                     if (!$item->checkInput()) {
                         $ok = false;
                     }
                 }
             }
         }
         return $ok;
     }

Here is the call graph for this function:

◆ getFormLabelFor()

ilRadioGroupInputGUI::getFormLabelFor ( )

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

                                      : string
     {
         return "";
     }

◆ getInput()

ilRadioGroupInputGUI::getInput ( )

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

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

Referenced by checkInput().

                               : string
     {
         return $this->str($this->getPostVar());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemByPostVar()

ilRadioGroupInputGUI::getItemByPostVar ( string $a_post_var )

Definition at line 190 of file class.ilRadioGroupInputGUI.php.

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

                                                         : ?ilFormPropertyGUI
     {
         if ($this->getPostVar() == $a_post_var) {
             return $this;
         }
 
         foreach ($this->getOptions() as $option) {
             foreach ($option->getSubItems() as $item) {
                 if ($item->getType() != "section_header") {
                     $ret = $item->getItemByPostVar($a_post_var);
                     if (is_object($ret)) {
                         return $ret;
                     }
                 }
             }
         }
 
         return null;
     }

Here is the call graph for this function:

◆ getOptions()

ilRadioGroupInputGUI::getOptions ( )

Definition at line 47 of file class.ilRadioGroupInputGUI.php.

References $options.

Referenced by checkInput(), getItemByPostVar(), getTableFilterHTML(), render(), and setValueByArray().

                                 : array
     {
         return $this->options;
     }

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilRadioGroupInputGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

Definition at line 210 of file class.ilRadioGroupInputGUI.php.

References getOptions(), ilSubEnabledFormPropertyGUI\getSubInputItemsRecursive(), and render().

                                         : string
     {
         return $this->render();
     }

Here is the call graph for this function:

◆ getValue()

ilRadioGroupInputGUI::getValue ( )

Definition at line 57 of file class.ilRadioGroupInputGUI.php.

References $value.

Referenced by ilAdvancedMDFieldDefinitionSelect\addEditOptionsFieldsToDefinitionForm(), and render().

                               : string
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilRadioGroupInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 101 of file class.ilRadioGroupInputGUI.php.

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                              : void
     {
         $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:

◆ render()

ilRadioGroupInputGUI::render ( )

Definition at line 110 of file class.ilRadioGroupInputGUI.php.

References ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), getOptions(), ilFormPropertyGUI\getParentForm(), ilFormPropertyGUI\getPostVar(), and getValue().

Referenced by getTableFilterHTML(), and insert().

                             : string
     {
         $tpl = new ilTemplate("tpl.prop_radio.html", true, true, "components/ILIAS/Form");
 
         foreach ($this->getOptions() as $option) {
             // information text for option
             if ($option->getInfo() != "") {
                 $tpl->setCurrentBlock("radio_option_desc");
                 $tpl->setVariable("RADIO_OPTION_DESC", $option->getInfo());
                 if ($option->getInfo() !== '') {
                     $tpl->setVariable('DESCRIPTION_FOR_ID', $this->getFieldId() . "_" . $option->getValue());
                 }
                 $tpl->parseCurrentBlock();
             }
 
 
             if (count($option->getSubItems()) > 0) {
                 if ($option->getValue() != $this->getValue()) {
                     // #10930
                     if ($this->global_tpl) {
                         $hop_id = $this->getFieldId() . "_" . $option->getValue();
                         $this->global_tpl->addOnloadCode(
                             "il.Form.hideSubForm('subform_$hop_id');"
                         );
                     }
                     if ($this->getParentForm()) {
                         $this->getParentForm()->addAsyncOnloadCode(
                             "il.Form.hideSubForm('subform_$hop_id');"
                         );
                     }
                 }
                 $tpl->setCurrentBlock("radio_option_subform");
                 $pf = new ilPropertyFormGUI();
                 $pf->setMode("subform");
                 $pf->setItems($option->getSubItems());
                 $tpl->setVariable("SUB_FORM", $pf->getContent());
                 $tpl->setVariable("SOP_ID", $this->getFieldId() . "_" . $option->getValue());
                 if ($pf->getMultipart()) {
                     $this->getParentForm()->setMultipart(true);
                 }
                 $tpl->parseCurrentBlock();
                 if ($pf->getMultipart()) {
                     $this->getParentForm()->setMultipart(true);
                 }
             }
 
             $tpl->setCurrentBlock("prop_radio_option");
             $tpl->setVariable("POST_VAR", $this->getPostVar());
             $tpl->setVariable("VAL_RADIO_OPTION", $option->getValue());
             $tpl->setVariable("OP_ID", $this->getFieldId() . "_" . $option->getValue());
             if ($option->getInfo() !== '') {
                 $tpl->setVariable('DESCRIBED_BY_FIELD_ID', $this->getFieldId() . "_" . $option->getValue());
             }
             $tpl->setVariable("FID", $this->getFieldId());
             if ($this->getDisabled() or $option->getDisabled()) {
                 $tpl->setVariable('DISABLED', 'disabled="disabled" ');
             }
             if ($option->getValue() == $this->getValue()) {
                 $tpl->setVariable(
                     "CHK_RADIO_OPTION",
                     'checked="checked"'
                 );
             }
             $tpl->setVariable("TXT_RADIO_OPTION", $option->getTitle());
 
 
             $tpl->parseCurrentBlock();
         }
         $tpl->setVariable("ID", $this->getFieldId());
 
         if ($this->getDisabled()) {
             $tpl->setVariable(
                 "HIDDEN_INPUT",
                 $this->getHiddenTag($this->getPostVar(), $this->getValue())
             );
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValue()

ilRadioGroupInputGUI::setValue ( string $a_value )

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

Referenced by ilObjRemoteGlossaryGUI\addCustomEditForm(), ilObjRemoteLearningModuleGUI\addCustomEditForm(), ilObjRemoteWikiGUI\addCustomEditForm(), ilObjRemoteGroupGUI\addCustomEditForm(), ilObjRemoteTestGUI\addCustomEditForm(), ilObjRemoteCourseGUI\addCustomEditForm(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilECSMappingSettingsGUI\cInitMappingForm(), ilExSubmissionTeamGUI\getAdoptForm(), ilUserStartingPointGUI\getCreateFormSpecificInputs(), ilUserProfile\getRadioInput(), ilImageMapEditorGUI\initAreaEditingForm(), ilExAssignmentEditorGUI\initAssignmentForm(), ilECSSettingsGUI\initCategoryMappingForm(), ilPCGridGUI\initCreationForm(), ilObjCourseGUI\initEditForm(), ilLTIConsumeProviderFormGUI\initForm(), ilObjNotificationSettingsGUI\initForm(), ilPCResourcesGUI\initForm(), ilPCLearningHistoryGUI\initForm(), ilPCTabsGUI\initForm(), ilContainerReferenceGUI\initForm(), ilObjUserGUI\initForm(), ilObjSessionGUI\initForm(), ilObjGroupGUI\initForm(), ilCalendarCategoryGUI\initFormCategory(), ilConditionHandlerGUI\initFormCondition(), ilCourseObjectivesGUI\initFormRandom(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilRepositorySearchGUI\initFormSearch(), ilObjCalendarSettingsGUI\initFormSettings(), ilContainerGUI\initManualSortingOptionForm(), ilCmiXapiLP\initModeOptions(), ilGlossaryPresentationGUI\initPrintViewSelectionForm(), ilLMPresentationGUI\initPrintViewSelectionForm(), ilObjContentObjectGUI\initPropertiesForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilOpenIdConnectSettingsGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilLOEditorGUI\initSettingsForm(), ilSearchBaseGUI\initStandardSearchForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), assImagemapQuestionGUI\populateQuestionSpecificFormPart(), setValueByArray(), ilObjRoleGUI\showChangeExistingObjectsConfirmation(), and ilConditionHandlerGUI\showObligatoryForm().

                                              : void
     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilRadioGroupInputGUI::setValueByArray ( array $a_values )

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

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

                                                     : void
     {
         $this->setValue((string) ($a_values[$this->getPostVar()] ?? ""));
         foreach ($this->getOptions() as $option) {
             foreach ($option->getSubItems() as $item) {
                 $item->setValueByArray($a_values);
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $options

array ilRadioGroupInputGUI::$options = array()

protected

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

Referenced by getOptions().

◆ $value

string ilRadioGroupInputGUI::$value = ""

protected

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

Referenced by getValue().

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

components/ILIAS/Form/classes/class.ilRadioGroupInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addOption()

◆ checkInput()

◆ getFormLabelFor()

◆ getInput()

◆ getItemByPostVar()

◆ getOptions()

◆ getTableFilterHTML()

◆ getValue()

◆ insert()

◆ render()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $options

◆ $value