ilRadioGroupInputGUI Class Reference

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

Inheritance diagram for ilRadioGroupInputGUI:

Collaboration diagram for ilRadioGroupInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	addOption ($a_option)
	Add Option. 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...
	insert ($a_tpl)
	Insert property html. More...
	render ()
	Insert property html. More...
	getItemByPostVar ($a_post_var)
	Get item by post var. More...
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...
	getFormLabelFor ()
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...
	stripSlashesAddSpaceFallback ($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...
Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Attributes
	$options = array()
	$value
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
	$ctrl
	$lng
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi = false
	$multi_sortable = false
	$multi_addremove = true
	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...
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 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 33 of file class.ilRadioGroupInputGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References $DIC, 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

(

$a_option

)

Add Option.

Parameters

object

$a_option

RadioOption object

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

Referenced by FormMailCodesGUI\__construct(), ilExerciseCertificateAdapter\addAdditionalFormElements(), ilTestCertificateAdapter\addAdditionalFormElements(), ilPhantomJSRenderer\addConfigElementsToForm(), ilTestExpressPageObjectGUI\addQuestion(), ilObjTestSettingsGeneralGUI\addQuestionBehaviourProperties(), ilObjTestGUI\addQuestionObject(), ilObjTestSettingsScoringResultsGUI\addScoringSettingsFormSection(), ilIncomingMailInputGUI\addSubOptions(), ilObjTestSettingsGeneralGUI\addTestFinishProperties(), ilObjTestSettingsGeneralGUI\addTestSequenceProperties(), ilTermsOfServiceUserHasLanguageCriterionGUI\appendOption(), ilTermsOfServiceUserHasGlobalRoleCriterionGUI\appendOption(), ilObjQuestionPoolGUI\buildCreateQuestionForm(), ilAssConfigurableMultiOptionQuestionFeedback\completeSpecificFormProperties(), ilSurveyConstraintsGUI\constraintForm(), ilObjTestGUI\createQuestionObject(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilForumSettingsGUI\getCustomForm(), ilObjForumAdministrationGUI\getSettingsForm(), ilTrUserObjectsPropsTableGUI\initFilter(), ilRegistrationSettingsGUI\initForm(), ilObjStudyProgrammeAdminGUI\initFormSettings(), ilExAssignmentEditorGUI\initPeerReviewForm(), ilObjMediaCastGUI\initSettingsForm(), ilObjFileAccessSettingsGUI\initWebDAVSettingsForm(), ilPCQuestionGUI\insert(), assQuestionGUI\suggestedsolution(), and ilPCPlaceHolderGUI\textCOSelectionGUI().

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

Here is the caller graph for this function:

checkInput()

ilRadioGroupInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

boolean Input ok, true/false

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

References $_POST, ilFormPropertyGUI\$lng, $ok, getOptions(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

    {
        $lng = $this->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;
        }
        
        $ok = true;
        foreach ($this->getOptions() as $option) {
            foreach ($option->getSubItems() as $item) {
                if ($_POST[$this->getPostVar()] == $option->getValue()) {
                    if (!$item->checkInput()) {
                        $ok = false;
                    }
                }
            }
        }
        return $ok;
    }

Here is the call graph for this function:

getFormLabelFor()

ilRadioGroupInputGUI::getFormLabelFor

(

)

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

                                      {
        return "";
    }

getItemByPostVar()

ilRadioGroupInputGUI::getItemByPostVar

(

$a_post_var

)

Get item by post var.

Returns

mixed false or item object

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

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

    {
        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 false;
    }

Here is the call graph for this function:

getOptions()

ilRadioGroupInputGUI::getOptions

(

)

Get Options.

Returns

array Array of RadioOption objects

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

References $options.

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

    {
        return $this->options;
    }

Here is the caller graph for this function:

getTableFilterHTML()

ilRadioGroupInputGUI::getTableFilterHTML

(

)

Get input item HTML to be inserted into table filters.

Returns

string

Implements ilTableFilterItem.

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

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

    {
        return $this->render();
    }

Here is the call graph for this function:

getValue()

ilRadioGroupInputGUI::getValue

(

)

Get Value.

Returns

string Value

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

References $value.

Referenced by render().

    {
        return $this->value;
    }

Here is the caller graph for this function:

insert()

ilRadioGroupInputGUI::insert

(

$a_tpl

)

Insert property html.

Returns

int Size

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

References $html, and 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:

render()

ilRadioGroupInputGUI::render

(

)

Insert property html.

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

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

Referenced by getTableFilterHTML(), and insert().

    {
        $tpl = new ilTemplate("tpl.prop_radio.html", true, true, "Services/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());
                $tpl->parseCurrentBlock();
            }
            
            
            if (count($option->getSubItems()) > 0) {
                if ($option->getValue() != $this->getValue()) {
                    // #10930
                    $tpl->setCurrentBlock("prop_radio_opt_hide");
                    $tpl->setVariable("HOP_ID", $this->getFieldId() . "_" . $option->getValue());
                    $tpl->parseCurrentBlock();
                }
                $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");
            if (!$this->getDisabled()) {
                $tpl->setVariable("POST_VAR", $this->getPostVar());
            }
            $tpl->setVariable("VAL_RADIO_OPTION", $option->getValue());
            $tpl->setVariable("OP_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

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

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

Referenced by ilObjRemoteGlossaryGUI\addCustomEditForm(), ilObjRemoteLearningModuleGUI\addCustomEditForm(), ilObjRemoteWikiGUI\addCustomEditForm(), ilObjRemoteGroupGUI\addCustomEditForm(), ilObjRemoteTestGUI\addCustomEditForm(), ilObjRemoteCourseGUI\addCustomEditForm(), ilUserProfile\addStandardFieldsToForm(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilObjTestDynamicQuestionSetConfigGUI\buildForm(), ilObjSystemFolderGUI\checkObject(), ilECSMappingSettingsGUI\cInitMappingForm(), ilExSubmissionTeamGUI\createTeamObject(), ilSetupGUI\displaySessions(), ilPCResourcesGUI\edit(), ilForumSettingsGUI\getCustomForm(), ilObjUserGUI\getValues(), ilImageMapEditorGUI\initAreaEditingForm(), ilExAssignmentEditorGUI\initAssignmentForm(), ilECSSettingsGUI\initCategoryMappingForm(), ilObjPortfolioGUI\initCreateForm(), ilObjCourseGUI\initEditForm(), ilObjNotificationSettingsGUI\initForm(), ilUserProfileInfoSettingsGUI\initForm(), ilPCTabsGUI\initForm(), ilContainerReferenceGUI\initForm(), ilObjGroupGUI\initForm(), ilObjSessionGUI\initForm(), ilConditionHandlerGUI\initFormCondition(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilRepositorySearchGUI\initFormSearch(), ilObjCalendarSettingsGUI\initFormSettings(), ilContainerGUI\initManualSortingOptionForm(), ilObjPortfolioGUI\initPDFSelectionForm(), ilWikiPageGUI\initPrintViewSelectionForm(), ilGlossaryPresentationGUI\initPrintViewSelectionForm(), ilLMPresentationGUI\initPrintViewSelectionForm(), ilObjContentObjectGUI\initPropertiesForm(), ilObjSurveyGUI\initPropertiesForm(), ilSetupGUI\initRegistrationForm(), ilOrgUnitGlobalSettingsGUI\initSettingsForm(), ilObjRepositorySettingsGUI\initSettingsForm(), ilOpenIdConnectSettingsGUI\initSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilLOEditorGUI\initSettingsForm(), ilObjGlossaryGUI\initSettingsForm(), ilSearchBaseGUI\initStandardSearchForm(), ilObjSAHSLearningModuleGUI\initUploadForm(), ilMDEditorGUI\listQuickEditCopyright(), assImagemapQuestionGUI\populateQuestionSpecificFormPart(), ilStartUpGUI\purgePlaceholders(), setValueByArray(), and ilObjRoleGUI\showChangeExistingObjectsConfirmation().

    {
        $this->value = $a_value;
    }

Here is the caller graph for this function:

setValueByArray()

ilRadioGroupInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

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

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

    {
        $this->setValue($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

ilRadioGroupInputGUI::$options = array()

protected

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

Referenced by getOptions().

$value

ilRadioGroupInputGUI::$value

protected

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

Referenced by getValue().

---

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

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