ILIAS  trunk Revision v11.0_alpha-2638-g80c1d007f79
ilRadioOption Class Reference

This class represents an option in a radio group. More...

+ Inheritance diagram for ilRadioOption:
+ Collaboration diagram for ilRadioOption:

Public Member Functions

 __construct (string $a_title="", string $a_value="", string $a_info="")
 
 setTitle (string $a_title)
 
 getTitle ()
 
 setInfo (string $a_info)
 
 getInfo ()
 
 setValue (string $a_value)
 
 getValue ()
 
 setDisabled (bool $a_disabled)
 
 getDisabled ()
 
 addSubItem ($a_item)
 
 getSubItems ()
 
 getSubInputItemsRecursive ()
 

Protected Attributes

string $title = ""
 
string $value = ""
 
string $info = ""
 
array $sub_items = array()
 
bool $disabled = false
 

Detailed Description

This class represents an option in a radio group.

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de
Deprecated:
12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

◆ __construct()

ilRadioOption::__construct ( string  $a_title = "",
string  $a_value = "",
string  $a_info = "" 
)

Definition at line 35 of file class.ilRadioOption.php.

References setInfo(), setTitle(), and setValue().

39  {
40  $this->setTitle($a_title);
41  $this->setValue($a_value);
42  $this->setInfo($a_info);
43  }
setInfo(string $a_info)
setValue(string $a_value)
setTitle(string $a_title)
+ Here is the call graph for this function:

Member Function Documentation

◆ addSubItem()

◆ getDisabled()

ilRadioOption::getDisabled ( )

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

References $disabled.

80  : bool
81  {
82  return $this->disabled;
83  }

◆ getInfo()

ilRadioOption::getInfo ( )

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

References $info.

60  : string
61  {
62  return $this->info;
63  }

◆ getSubInputItemsRecursive()

ilRadioOption::getSubInputItemsRecursive ( )

Definition at line 98 of file class.ilRadioOption.php.

98  : array
99  {
100  $subInputItems = array();
101 
102  foreach ($this->sub_items as $subItem) {
103  if ($subItem->getType() == 'section_header') {
104  continue;
105  }
106 
107  $subInputItems[] = $subItem;
108 
109  if ($subItem instanceof ilSubEnabledFormPropertyGUI) {
110  $subInputItems = array_merge($subInputItems, $subItem->getSubInputItemsRecursive());
111  }
112  }
113 
114  return $subInputItems;
115  }
This class represents a property that may include a sub form.

◆ getSubItems()

ilRadioOption::getSubItems ( )

Definition at line 93 of file class.ilRadioOption.php.

References $sub_items.

93  : array
94  {
95  return $this->sub_items;
96  }

◆ getTitle()

ilRadioOption::getTitle ( )

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

References $title.

50  : string
51  {
52  return $this->title;
53  }

◆ getValue()

ilRadioOption::getValue ( )

Definition at line 70 of file class.ilRadioOption.php.

References $value.

70  : string
71  {
72  return $this->value;
73  }

◆ setDisabled()

ilRadioOption::setDisabled ( bool  $a_disabled)

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

References ILIAS\UI\examples\Input\Field\Checkbox\disabled().

Referenced by ilObjRemoteTestGUI\addCustomEditForm(), ilUserProfile\getRadioInput(), and ilObjExerciseGUI\listAssignmentsObject().

75  : void
76  {
77  $this->disabled = $a_disabled;
78  }
disabled()
description: > Example showing how to plug a disabled checkbox into a form
Definition: disabled.php:32
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setInfo()

ilRadioOption::setInfo ( string  $a_info)

Definition at line 55 of file class.ilRadioOption.php.

References ILIAS\UI\examples\MessageBox\Info\info().

Referenced by __construct(), ilNewsForContextBlockGUI\addToSettingsForm(), ilDclMobFieldRepresentation\buildFieldCreationInput(), ilCmiXapiSettingsGUI\buildForm(), ilECSMappingSettingsGUI\cInitMappingForm(), ilNewsItemGUI\getEditForm(), ilObjMediaCastSettingsGUI\getForm(), ilObjNewsSettingsGUI\getSettingsForm(), ilMailTemplateGUI\getTemplateForm(), ilObjMediaCastGUI\initAddCastItemForm(), ilObjCmiXapiGUI\initCreateForm(), ilObjBookingPoolGUI\initEditCustomForm(), ilLTIConsumerSettingsFormGUI\initForm(), ilPCConsultationHoursGUI\initForm(), ilPCProfileGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilContainerGUI\initListPresentationForm(), ilExAssignmentEditorGUI\initPeerReviewForm(), ilObjSCORMLearningModuleGUI\initPropertiesForm(), ilObjSCORM2004LearningModuleGUI\initPropertiesForm(), ilObjSurveyAdministrationGUI\initSettingsForm(), ilNewsForContextBlockGUI\initSettingsForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), ilPCQuestionGUI\insert(), ilObjExerciseGUI\listAssignmentsObject(), assFormulaQuestionGUI\resetSavedPreviewSession(), ilObjCertificateSettingsGUI\settings(), and ilConditionHandlerGUI\showObligatoryForm().

55  : void
56  {
57  $this->info = $a_info;
58  }
info()
description: > Example for rendering a info message box.
Definition: info.php:34
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setTitle()

ilRadioOption::setTitle ( string  $a_title)

Definition at line 45 of file class.ilRadioOption.php.

Referenced by __construct(), and ilObjPortfolioBaseGUI\initPageForm().

45  : void
46  {
47  $this->title = $a_title;
48  }
+ Here is the caller graph for this function:

◆ setValue()

Field Documentation

◆ $disabled

bool ilRadioOption::$disabled = false
protected

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

Referenced by getDisabled().

◆ $info

string ilRadioOption::$info = ""
protected

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

Referenced by getInfo().

◆ $sub_items

array ilRadioOption::$sub_items = array()
protected

Definition at line 32 of file class.ilRadioOption.php.

Referenced by getSubItems().

◆ $title

string ilRadioOption::$title = ""
protected

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

Referenced by getTitle().

◆ $value

string ilRadioOption::$value = ""
protected

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

Referenced by getValue().


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