ilFormPropertyGUI Class Reference

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

Inheritance diagram for ilFormPropertyGUI:

Collaboration diagram for ilFormPropertyGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor.
&	executeCommand ()
	Execute command.
	getType ()
	Get Type.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setPostVar ($a_postvar)
	Set Post Variable.
	getPostVar ()
	Get Post Variable.
	getFieldId ()
	Get Post Variable.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	setAlert ($a_alert)
	Set Alert Text.
	getAlert ()
	Get Alert Text.
	setRequired ($a_required)
	Set Required.
	getRequired ()
	Get Required.
	setDisabled ($a_disabled)
	Set Disabled.
	getDisabled ()
	Get Disabled.
	checkInput ()
	Check input, strip slashes etc.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	getSubForm ()
	Get sub form html.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	getItemByPostVar ($a_post_var)
	Get item by post var.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)

Protected Member Functions
	setType ($a_type)
	Set Type.

Protected Attributes
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform

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 11 of file class.ilFormPropertyGUI.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented in ilTextAreaInputGUI, ilRecurrenceInputGUI, ilCategoryWizardInputGUI, ilDurationInputGUI, ilMatchingWizardInputGUI, ilRepositorySelectorInputGUI, ilKVPWizardInputGUI, ilNumberInputGUI, ilErrorTextWizardInputGUI, ilSingleChoiceWizardInputGUI, ilSuggestedSolutionSelectorGUI, ilDateDurationInputGUI, ilCSSRectInputGUI, ilMultiSelectInputGUI, ilSelectInputGUI, ilRandomTestInputGUI, ilAnswerWizardInputGUI, ilImageWizardInputGUI, ilMatchingPairWizardInputGUI, ilAdvSelectInputGUI, ilCheckboxGroupInputGUI, ilCheckboxInputGUI, ilLocationInputGUI, ilRadioGroupInputGUI, ilTRBLColorPickerInputGUI, ilEMailInputGUI, ilFeedUrlInputGUI, ilFileWizardInputGUI, ilRadioMatrixInputGUI, ilTextWizardInputGUI, ilNumericStyleValueInputGUI, ilTRBLNumericStyleValueInputGUI, ilRandomTestROInputGUI, ilCustomInputGUI, ilRegExpInputGUI, ilWidthHeightInputGUI, ilBackgroundImageInputGUI, ilBackgroundPositionInputGUI, ilFontSizeInputGUI, ilTRBLBorderStyleInputGUI, ilTRBLBorderWidthInputGUI, ilLuceneQueryInputGUI, ilTextInputGUI, ilDateTimeInputGUI, ilImagemapFileInputGUI, ilFlashFileInputGUI, ilPasswordInputGUI, ilNonEditableValueGUI, ilUserLoginInputGUI, ilColorPickerInputGUI, ilFileInputGUI, and ilImageFileInputGUI.

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

References setDisabled(), setPostVar(), and setTitle().

        {
                $this->setTitle($a_title);
                $this->setPostVar($a_postvar);
                $this->setDisabled(false);
        }

Here is the call graph for this function:

Member Function Documentation

ilFormPropertyGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

boolean Input ok, true/false

Reimplemented in ilDateDurationInputGUI, ilTextAreaInputGUI, ilDurationInputGUI, ilDateTimeInputGUI, ilNumberInputGUI, ilKVPWizardInputGUI, ilTRBLColorPickerInputGUI, ilTextInputGUI, ilPasswordInputGUI, ilCategoryWizardInputGUI, ilErrorTextWizardInputGUI, ilSingleChoiceWizardInputGUI, ilCSSRectInputGUI, ilMatchingWizardInputGUI, ilTRBLNumericStyleValueInputGUI, ilFileInputGUI, ilSuggestedSolutionSelectorGUI, ilAnswerWizardInputGUI, ilImageWizardInputGUI, ilRepositorySelectorInputGUI, ilTRBLBorderStyleInputGUI, ilTRBLBorderWidthInputGUI, ilRandomTestInputGUI, ilCheckboxInputGUI, ilLocationInputGUI, ilMatchingPairWizardInputGUI, ilBackgroundPositionInputGUI, ilFileWizardInputGUI, ilWidthHeightInputGUI, ilCheckboxGroupInputGUI, ilRadioGroupInputGUI, ilImagemapFileInputGUI, ilMultiSelectInputGUI, ilAdvSelectInputGUI, ilSelectInputGUI, ilRadioMatrixInputGUI, ilTextWizardInputGUI, ilCustomInputGUI, ilNumericStyleValueInputGUI, ilRegExpInputGUI, ilBackgroundImageInputGUI, ilRandomTestROInputGUI, ilUserLoginInputGUI, ilEMailInputGUI, ilRecurrenceInputGUI, ilChatSmiliesCurrentSmileyFormElement, ilFlashFileInputGUI, ilHiddenInputGUI, ilFontSizeInputGUI, ilMultipleChoiceWizardInputGUI, ilFeedUrlInputGUI, ilBirthdayInputGUI, ilLuceneQueryInputGUI, ilSolutionTitleInputGUI, ilColorPickerInputGUI, ilFormulaInputGUI, and ilNonEditableValueGUI.

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

        {
                return false;           // please overwrite
        }

ilFormPropertyGUI::clearFromSession

(

)

Clear session value.

Definition at line 346 of file class.ilFormPropertyGUI.php.

References $_SESSION, getFieldId(), and getParent().

        {
                $parent = $this->getParent();
                if (!is_object($parent))
                {
                        die("You must set parent for ".get_class($this)." to use serialize feature.");
                }
                $_SESSION["form_".$parent->getId()][$this->getFieldId()] = false;
        }

Here is the call graph for this function:

& ilFormPropertyGUI::executeCommand

(

)

Execute command.

Definition at line 38 of file class.ilFormPropertyGUI.php.

References $cmd, and $ilCtrl.

        {
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd();
                
                return $this->$cmd();
        }

ilFormPropertyGUI::getAlert

(

)

Get Alert Text.

Returns

string Alert Text

Definition at line 156 of file class.ilFormPropertyGUI.php.

References $alert.

        {
                return $this->alert;
        }

ilFormPropertyGUI::getDisabled

(

)

Get Disabled.

Returns

boolean Disabled

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

Referenced by ilDateTimeInputGUI\checkInput(), ilDateDurationInputGUI\checkInput(), ilImageFileInputGUI\insert(), ilEMailInputGUI\insert(), ilUserLoginInputGUI\insert(), ilRadioMatrixInputGUI\insert(), ilTextWizardInputGUI\insert(), ilCheckboxGroupInputGUI\insert(), ilRadioGroupInputGUI\insert(), ilSuggestedSolutionSelectorGUI\insert(), ilColorPickerInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilRandomTestInputGUI\insert(), ilCSSRectInputGUI\insert(), ilFileWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilTRBLColorPickerInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilPasswordInputGUI\insert(), ilNumberInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilTextAreaInputGUI\insert(), ilBirthdayInputGUI\render(), ilSelectInputGUI\render(), ilMultiSelectInputGUI\render(), ilCheckboxInputGUI\render(), ilDateTimeInputGUI\render(), ilTextInputGUI\render(), and ilDateDurationInputGUI\render().

        {
                return $this->disabled;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getFieldId

(

)

Get Post Variable.

Returns

string Post Variable

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

References getPostVar().

Referenced by clearFromSession(), ilHiddenInputGUI\insert(), ilImageFileInputGUI\insert(), ilEMailInputGUI\insert(), ilUserLoginInputGUI\insert(), ilTextWizardInputGUI\insert(), ilCheckboxGroupInputGUI\insert(), ilRadioGroupInputGUI\insert(), ilColorPickerInputGUI\insert(), ilMatchingPairWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilCSSRectInputGUI\insert(), ilFileWizardInputGUI\insert(), ilImagemapFileInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilTRBLColorPickerInputGUI\insert(), ilImageWizardInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilPasswordInputGUI\insert(), ilKVPWizardInputGUI\insert(), ilFlashFileInputGUI\insert(), ilNumberInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilTextAreaInputGUI\insert(), readFromSession(), ilNonEditableValueGUI\render(), ilSelectInputGUI\render(), ilMultiSelectInputGUI\render(), ilCheckboxInputGUI\render(), ilRepositorySelectorInputGUI\render(), ilFileInputGUI\render(), ilTextInputGUI\render(), ilRepositorySelectorInputGUI\reset(), ilRepositorySelectorInputGUI\selectRepositoryItem(), and writeToSession().

        {
                $id = str_replace("[", "__", $this->getPostVar());
                $id = str_replace("]", "__", $id);
                
                return $id;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilFormPropertyGUI::getHiddenTag	(		$a_post_var,
			$a_value
	)

Get hidden tag (used for disabled properties)

Definition at line 372 of file class.ilFormPropertyGUI.php.

References ilUtil\prepareFormOutput().

Referenced by ilRadioGroupInputGUI\insert(), ilTextAreaInputGUI\insert(), ilSelectInputGUI\render(), and ilTextInputGUI\render().

        {
                return '<input type="hidden" name="'.$a_post_var.'" value="'.ilUtil::prepareFormOutput($a_value).'" />';
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilFormPropertyGUI::getHiddenTitle

(

)

Get hidden title.

Returns

string hidden title

Definition at line 284 of file class.ilFormPropertyGUI.php.

        {
                return $this->hidden_title;
        }

ilFormPropertyGUI::getInfo

(

)

Get Information Text.

Returns

string Information Text

Reimplemented in ilNonEditableValueGUI.

Definition at line 136 of file class.ilFormPropertyGUI.php.

References $info.

        {
                return $this->info;
        }

ilFormPropertyGUI::getItemByPostVar

(

$a_post_var

)

Get item by post var.

Returns

mixed false or item object

Reimplemented in ilRadioGroupInputGUI, ilCheckboxGroupInputGUI, and ilSubEnabledFormPropertyGUI.

Definition at line 294 of file class.ilFormPropertyGUI.php.

References getPostVar().

        {
                if ($this->getPostVar() == $a_post_var)
                {
                        return $this;
                }
                
                return false;
        }

Here is the call graph for this function:

ilFormPropertyGUI::getParent

(

)

Get Parent GUI object.

Returns

object parent gui object

Definition at line 246 of file class.ilFormPropertyGUI.php.

Referenced by clearFromSession(), getParentForm(), readFromSession(), ilRepositorySelectorInputGUI\render(), and writeToSession().

        {
                return $this->parent_gui;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getParentForm

(

)

Get Parent Form.

Returns

object Parent Form

Definition at line 226 of file class.ilFormPropertyGUI.php.

References getParent().

Referenced by ilCheckboxGroupInputGUI\insert(), and ilRadioGroupInputGUI\insert().

        {
                return $this->getParent();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilFormPropertyGUI::getPostVar

(

)

Get Post Variable.

Returns

string Post Variable

Definition at line 103 of file class.ilFormPropertyGUI.php.

References $postvar.

Referenced by ilFormulaInputGUI\checkInput(), ilNonEditableValueGUI\checkInput(), ilColorPickerInputGUI\checkInput(), ilLuceneQueryInputGUI\checkInput(), ilBirthdayInputGUI\checkInput(), ilFeedUrlInputGUI\checkInput(), ilMultipleChoiceWizardInputGUI\checkInput(), ilFontSizeInputGUI\checkInput(), ilFlashFileInputGUI\checkInput(), ilEMailInputGUI\checkInput(), ilUserLoginInputGUI\checkInput(), ilRegExpInputGUI\checkInput(), ilBackgroundImageInputGUI\checkInput(), ilNumericStyleValueInputGUI\checkInput(), ilCustomInputGUI\checkInput(), ilRadioMatrixInputGUI\checkInput(), ilTextWizardInputGUI\checkInput(), ilAdvSelectInputGUI\checkInput(), ilSelectInputGUI\checkInput(), ilImagemapFileInputGUI\checkInput(), ilMultiSelectInputGUI\checkInput(), ilCheckboxGroupInputGUI\checkInput(), ilRadioGroupInputGUI\checkInput(), ilFileWizardInputGUI\checkInput(), ilWidthHeightInputGUI\checkInput(), ilBackgroundPositionInputGUI\checkInput(), ilMatchingPairWizardInputGUI\checkInput(), ilLocationInputGUI\checkInput(), ilCheckboxInputGUI\checkInput(), ilRandomTestInputGUI\checkInput(), ilTRBLBorderStyleInputGUI\checkInput(), ilTRBLBorderWidthInputGUI\checkInput(), ilRepositorySelectorInputGUI\checkInput(), ilImageWizardInputGUI\checkInput(), ilAnswerWizardInputGUI\checkInput(), ilSuggestedSolutionSelectorGUI\checkInput(), ilFileInputGUI\checkInput(), ilTRBLNumericStyleValueInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilCSSRectInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilErrorTextWizardInputGUI\checkInput(), ilCategoryWizardInputGUI\checkInput(), ilPasswordInputGUI\checkInput(), ilTextInputGUI\checkInput(), ilTRBLColorPickerInputGUI\checkInput(), ilKVPWizardInputGUI\checkInput(), ilNumberInputGUI\checkInput(), ilDateTimeInputGUI\checkInput(), ilDurationInputGUI\checkInput(), ilTextAreaInputGUI\checkInput(), ilDateDurationInputGUI\checkInput(), ilImageFileInputGUI\getDeletionFlag(), ilFlashFileInputGUI\getDeletionFlag(), getFieldId(), ilSubEnabledFormPropertyGUI\getItemByPostVar(), ilCheckboxGroupInputGUI\getItemByPostVar(), ilRadioGroupInputGUI\getItemByPostVar(), getItemByPostVar(), ilHiddenInputGUI\insert(), ilRandomTestROInputGUI\insert(), ilImageFileInputGUI\insert(), ilEMailInputGUI\insert(), ilUserLoginInputGUI\insert(), ilFontSizeInputGUI\insert(), ilRadioMatrixInputGUI\insert(), ilBackgroundImageInputGUI\insert(), ilAdvSelectInputGUI\insert(), ilNumericStyleValueInputGUI\insert(), ilTextWizardInputGUI\insert(), ilCheckboxGroupInputGUI\insert(), ilRadioGroupInputGUI\insert(), ilWidthHeightInputGUI\insert(), ilLocationInputGUI\insert(), ilSuggestedSolutionSelectorGUI\insert(), ilTRBLBorderStyleInputGUI\insert(), ilBackgroundPositionInputGUI\insert(), ilColorPickerInputGUI\insert(), ilMatchingPairWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilTRBLBorderWidthInputGUI\insert(), ilTRBLNumericStyleValueInputGUI\insert(), ilRandomTestInputGUI\insert(), ilCSSRectInputGUI\insert(), ilFileWizardInputGUI\insert(), ilImagemapFileInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilTRBLColorPickerInputGUI\insert(), ilImageWizardInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilErrorTextWizardInputGUI\insert(), ilPasswordInputGUI\insert(), ilKVPWizardInputGUI\insert(), ilDurationInputGUI\insert(), ilFlashFileInputGUI\insert(), ilNumberInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilTextAreaInputGUI\insert(), ilBirthdayInputGUI\render(), ilNonEditableValueGUI\render(), ilSelectInputGUI\render(), ilMultiSelectInputGUI\render(), ilCheckboxInputGUI\render(), ilRepositorySelectorInputGUI\render(), ilFileInputGUI\render(), ilDateTimeInputGUI\render(), ilTextInputGUI\render(), ilDateDurationInputGUI\render(), ilBirthdayInputGUI\setValueByArray(), ilFileInputGUI\setValueByArray(), ilFlashFileInputGUI\setValueByArray(), ilUserLoginInputGUI\setValueByArray(), ilRandomTestInputGUI\setValueByArray(), ilChatSmiliesCurrentSmileyFormElement\setValueByArray(), ilEMailInputGUI\setValueByArray(), ilHiddenInputGUI\setValueByArray(), ilRepositorySelectorInputGUI\setValueByArray(), ilImagemapFileInputGUI\setValueByArray(), ilRadioMatrixInputGUI\setValueByArray(), ilCheckboxGroupInputGUI\setValueByArray(), ilRadioGroupInputGUI\setValueByArray(), ilAdvSelectInputGUI\setValueByArray(), ilSelectInputGUI\setValueByArray(), ilMultiSelectInputGUI\setValueByArray(), ilCheckboxInputGUI\setValueByArray(), ilLocationInputGUI\setValueByArray(), ilNonEditableValueGUI\setValueByArray(), ilPasswordInputGUI\setValueByArray(), ilTextInputGUI\setValueByArray(), ilSuggestedSolutionSelectorGUI\setValueByArray(), ilNumberInputGUI\setValueByArray(), ilCSSRectInputGUI\setValueByArray(), ilBackgroundImageInputGUI\setValueByArray(), ilNumericStyleValueInputGUI\setValueByArray(), ilFontSizeInputGUI\setValueByArray(), ilWidthHeightInputGUI\setValueByArray(), ilDateTimeInputGUI\setValueByArray(), ilTRBLBorderStyleInputGUI\setValueByArray(), ilDurationInputGUI\setValueByArray(), ilBackgroundPositionInputGUI\setValueByArray(), ilTRBLNumericStyleValueInputGUI\setValueByArray(), ilTRBLBorderWidthInputGUI\setValueByArray(), ilDateDurationInputGUI\setValueByArray(), ilTextAreaInputGUI\setValueByArray(), and ilRepositorySelectorInputGUI\showRepositorySelection().

        {
                return $this->postvar;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getRequired

(

)

Get Required.

Returns

boolean Required

Definition at line 176 of file class.ilFormPropertyGUI.php.

References $required.

Referenced by ilFormulaInputGUI\checkInput(), ilBirthdayInputGUI\checkInput(), ilFeedUrlInputGUI\checkInput(), ilMultipleChoiceWizardInputGUI\checkInput(), ilFontSizeInputGUI\checkInput(), ilFlashFileInputGUI\checkInput(), ilEMailInputGUI\checkInput(), ilUserLoginInputGUI\checkInput(), ilBackgroundImageInputGUI\checkInput(), ilRegExpInputGUI\checkInput(), ilNumericStyleValueInputGUI\checkInput(), ilCustomInputGUI\checkInput(), ilRadioMatrixInputGUI\checkInput(), ilTextWizardInputGUI\checkInput(), ilAdvSelectInputGUI\checkInput(), ilSelectInputGUI\checkInput(), ilImagemapFileInputGUI\checkInput(), ilMultiSelectInputGUI\checkInput(), ilRadioGroupInputGUI\checkInput(), ilCheckboxGroupInputGUI\checkInput(), ilFileWizardInputGUI\checkInput(), ilMatchingPairWizardInputGUI\checkInput(), ilLocationInputGUI\checkInput(), ilRepositorySelectorInputGUI\checkInput(), ilImageWizardInputGUI\checkInput(), ilSuggestedSolutionSelectorGUI\checkInput(), ilFileInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilCSSRectInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilErrorTextWizardInputGUI\checkInput(), ilCategoryWizardInputGUI\checkInput(), ilPasswordInputGUI\checkInput(), ilTextInputGUI\checkInput(), ilKVPWizardInputGUI\checkInput(), ilNumberInputGUI\checkInput(), and ilTextAreaInputGUI\checkInput().

        {
                return $this->required;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getSubForm

(

)

Get sub form html.

Reimplemented in ilSubEnabledFormPropertyGUI.

Definition at line 255 of file class.ilFormPropertyGUI.php.

        {
                return "";
        }

ilFormPropertyGUI::getTitle

(

)

Get Title.

Returns

string Title

Reimplemented in ilNonEditableValueGUI.

Definition at line 83 of file class.ilFormPropertyGUI.php.

References $title.

        {
                return $this->title;
        }

ilFormPropertyGUI::getType

(

)

Get Type.

Returns

string Type

Reimplemented in ilNonEditableValueGUI.

Definition at line 63 of file class.ilFormPropertyGUI.php.

References $type.

        {
                return $this->type;
        }

ilFormPropertyGUI::hideSubForm

(

)

Sub form hidden on init?

Reimplemented in ilCheckboxInputGUI.

Definition at line 264 of file class.ilFormPropertyGUI.php.

        {
                return false;
        }

ilFormPropertyGUI::readFromSession

(

)

Read from session.

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

References $_SESSION, getFieldId(), getParent(), and unserializeData().

        {
                $parent = $this->getParent();
                if (!is_object($parent))
                {
                        die("You must set parent for ".get_class($this)." to use serialize feature.");
                }
                $this->unserializeData($_SESSION["form_".$parent->getId()][$this->getFieldId()]);
        }

Here is the call graph for this function:

ilFormPropertyGUI::serializeData

(

)

serialize data

Reimplemented in ilDateTimeInputGUI, and ilCheckboxInputGUI.

Definition at line 307 of file class.ilFormPropertyGUI.php.

Referenced by writeToSession().

        {
                return serialize($this->getValue());
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setAlert

(

$a_alert

)

Set Alert Text.

Parameters

string

$a_alert

Alert Text

Definition at line 146 of file class.ilFormPropertyGUI.php.

Referenced by ilFormulaInputGUI\checkInput(), ilLuceneQueryInputGUI\checkInput(), ilBirthdayInputGUI\checkInput(), ilFeedUrlInputGUI\checkInput(), ilMultipleChoiceWizardInputGUI\checkInput(), ilFontSizeInputGUI\checkInput(), ilFlashFileInputGUI\checkInput(), ilRecurrenceInputGUI\checkInput(), ilEMailInputGUI\checkInput(), ilUserLoginInputGUI\checkInput(), ilRegExpInputGUI\checkInput(), ilBackgroundImageInputGUI\checkInput(), ilNumericStyleValueInputGUI\checkInput(), ilCustomInputGUI\checkInput(), ilRadioMatrixInputGUI\checkInput(), ilTextWizardInputGUI\checkInput(), ilSelectInputGUI\checkInput(), ilAdvSelectInputGUI\checkInput(), ilImagemapFileInputGUI\checkInput(), ilMultiSelectInputGUI\checkInput(), ilCheckboxGroupInputGUI\checkInput(), ilRadioGroupInputGUI\checkInput(), ilFileWizardInputGUI\checkInput(), ilBackgroundPositionInputGUI\checkInput(), ilMatchingPairWizardInputGUI\checkInput(), ilLocationInputGUI\checkInput(), ilRandomTestInputGUI\checkInput(), ilTRBLBorderWidthInputGUI\checkInput(), ilRepositorySelectorInputGUI\checkInput(), ilImageWizardInputGUI\checkInput(), ilAnswerWizardInputGUI\checkInput(), ilSuggestedSolutionSelectorGUI\checkInput(), ilFileInputGUI\checkInput(), ilTRBLNumericStyleValueInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilCSSRectInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilErrorTextWizardInputGUI\checkInput(), ilCategoryWizardInputGUI\checkInput(), ilPasswordInputGUI\checkInput(), ilTextInputGUI\checkInput(), ilKVPWizardInputGUI\checkInput(), ilNumberInputGUI\checkInput(), ilDateTimeInputGUI\checkInput(), ilTextAreaInputGUI\checkInput(), ilDateDurationInputGUI\checkInput(), and ilCourseRegistrationGUI\fillRegistrationType().

        {
                $this->alert = $a_alert;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setDisabled

(

$a_disabled

)

Set Disabled.

Parameters

boolean

$a_disabled

Disabled

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

Referenced by __construct(), ilTestEvaluationGUI\evalSettings(), ilObjPaymentSettingsGUI\getERPform(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilObjiLincClassroomGUI\initSettingsForm(), and ilObjSurveyGUI\propertiesObject().

        {
                $this->disabled = $a_disabled;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setHiddenTitle

(

$a_val

)

Set hidden title (for screenreaders)

Parameters

string

hidden title

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

Referenced by ilImageFileInputGUI\__construct(), and ilFileInputGUI\__construct().

        {
                $this->hidden_title = $a_val;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setInfo

(

$a_info

)

Set Information Text.

Parameters

string

$a_info

Information Text

Reimplemented in ilNonEditableValueGUI.

Definition at line 126 of file class.ilFormPropertyGUI.php.

Referenced by ilSCORMCertificateAdapter\addAdditionalFormElements(), ilObjExternalToolsSettingsGUI\editGoogleMapsObject(), ilObjExternalToolsSettingsGUI\editjsMathObject(), assFileUploadGUI\editQuestion(), SurveyMatrixQuestionGUI\editQuestion(), ilObjNewsSettingsGUI\editSettings(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilObjLearningResourcesSettingsGUI\editSettings(), ilObjPaymentSettingsGUI\getERPform(), ilObjMediaCastGUI\initAddCastItemForm(), ilObjAuthSettingsGUI\initAuthModeDetermination(), ilSetupGUI\initBasicSettingsForm(), ilObjSystemFolderGUI\initBasicSettingsForm(), ilObjSystemFolderGUI\initCronJobsForm(), ilObjMailGUI\initForm(), ilObjChatServerGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilCourseItemAdministrationGUI\initFormEdit(), ilExternalFeedBlockGUIGen\initFormFeedBlock(), ilPDExternalFeedBlockGUI\initFormFeedBlock(), ilExternalFeedBlockGUI\initFormFeedBlock(), ilNewsItemGUIGen\initFormNewsItem(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilObjTaggingSettingsGUI\initFormSettings(), ilObjMediaCastSettingsGUI\initFormSettings(), ilObjForumGUI\initForumCreateForm(), ilObjMDSettingsGUI\initGeneralSettingsForm(), ilPersonalProfileGUI\initGeneralSettingsForm(), ilObjContentObjectGUI\initImportForm(), ilObjGroupGUI\initInfoEditor(), ilObjSystemFolderGUI\initJavaServerIniForm(), ilObjUserFolderGUI\initLoginSettingsForm(), ilMailOptionsGUI\initMailOptionsForm(), ilPersonalProfileGUI\initMailOptionsForm(), ilObjMediaObjectsSettingsGUI\initMediaObjectsSettingsForm(), ilShopNewsGUI\initNewsForm(), ilObjStyleSheetGUI\initPropertiesForm(), ilObjContentObjectGUI\initPropertiesForm(), ilPersonalProfileGUI\initPublicProfileForm(), ilShopNewsGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilObjMediaCastGUI\initSettingsForm(), ilNewsForContextBlockGUI\initSettingsForm(), ilObjFileGUI\initSingleUploadForm(), ilObjForumGUI\initTopicCreateForm(), ilObjSystemFolderGUI\initWebServicesForm(), ilObjFileGUI\initZipUploadForm(), ilObjSurveyGUI\inviteObject(), ilObjSurveyQuestionPoolGUI\propertiesObject(), ilObjQuestionPoolGUI\propertiesObject(), ilObjSurveyGUI\propertiesObject(), ilObjAdvancedEditingGUI\repositorySettingsObject(), ilRadiusSettingsGUI\settings(), and ilObjPrivacySecurityGUI\showSecurity().

        {
                $this->info = $a_info;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setParent

(

$a_val

)

Set Parent GUI object.

Parameters

object

parent gui object

Definition at line 236 of file class.ilFormPropertyGUI.php.

Referenced by setParentForm().

        {
                $this->parent_gui = $a_val;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setParentForm

(

$a_parentform

)

Set Parent Form.

Parameters

object

$a_parentform

Parent Form

Definition at line 216 of file class.ilFormPropertyGUI.php.

References setParent().

        {
                $this->setParent($a_parentform);
        }

Here is the call graph for this function:

ilFormPropertyGUI::setPostVar

(

$a_postvar

)

Set Post Variable.

Parameters

string

$a_postvar

Post Variable

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

Referenced by __construct(), and ilObjMediaCastGUI\initAddCastItemForm().

        {
                $this->postvar = $a_postvar;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setRequired

(

$a_required

)

Set Required.

Parameters

boolean

$a_required

Required

Definition at line 166 of file class.ilFormPropertyGUI.php.

Referenced by ilRandomTestROInputGUI\__construct(), ilRandomTestInputGUI\__construct(), ilSCORMCertificateAdapter\addAdditionalFormElements(), ilCertificateGUI\certificateEditor(), SurveyTextQuestionGUI\editQuestion(), SurveyMetricQuestionGUI\editQuestion(), SurveyMultipleChoiceQuestionGUI\editQuestion(), SurveySingleChoiceQuestionGUI\editQuestion(), assTextSubsetGUI\editQuestion(), SurveyMatrixQuestionGUI\editQuestion(), assMultipleChoiceGUI\editQuestion(), assImagemapQuestionGUI\editQuestion(), assSingleChoiceGUI\editQuestion(), assFlashQuestionGUI\editQuestion(), assClozeTestGUI\editQuestion(), assOrderingQuestionGUI\editQuestion(), assMatchingQuestionGUI\editQuestion(), ilCourseRegistrationGUI\fillAgreement(), ilObjMediaCastGUI\initAddCastItemForm(), ilSetupGUI\initBasicSettingsForm(), ilECSSettingsGUI\initCategoryMappingForm(), ilSetupGUI\initClientIniForm(), ilObjStyleSheetGUI\initColorForm(), ilCalendarRecurrenceGUI\initForm(), ilObjChatServerGUI\initForm(), ilPCMapGUI\initForm(), ilMailingListsGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjUserGUI\initForm(), ilBookmarkAdministrationGUI\initFormBookmarkFolder(), ilConditionHandlerInterface\initFormCondition(), ilObjLinkResourceGUI\initFormLink(), ilObjSearchSettingsGUI\initFormLuceneSettings(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilObjLinkResourceGUI\initFormSettings(), ilObjForumGUI\initForumImportForm(), ilObjStyleSheetGUI\initImageForm(), ilBookmarkAdministrationGUI\initImportBookmarksForm(), ilNoteGUI\initNoteForm(), ilPersonalProfileGUI\initPasswordForm(), ilObjExerciseGUI\initPropertiesForm(), ilObjForumGUI\initReplyEditForm(), ilECSSettingsGUI\initSettingsForm(), ilObjiLincClassroomGUI\initSettingsForm(), ilObjWikiGUI\initSettingsForm(), ilObjiLincCourseGUI\initSettingsForm(), ilObjFileGUI\initSingleUploadForm(), ilObjChatServerGUI\initSmiliesEditForm(), ilObjChatServerGUI\initSmiliesForm(), ilObjSAHSLearningModuleGUI\initUploadForm(), ilObjFileGUI\initZipUploadForm(), SurveyQuestionGUI\material(), ilRadiusSettingsGUI\settings(), ilObjCertificateSettingsGUI\settings(), and ilMailFormGUI\showForm().

        {
                $this->required = $a_required;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setTitle

(

$a_title

)

Set Title.

Parameters

string

$a_title

Title

Reimplemented in ilNonEditableValueGUI.

Definition at line 73 of file class.ilFormPropertyGUI.php.

Referenced by __construct(), ilObjContentObjectGUI\initCreationForm(), and ilObjWikiGUI\initSettingsForm().

        {
                $this->title = $a_title;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setType (   $a_type )

protected

Set Type.

Parameters

string

$a_type

Type

Reimplemented in ilNonEditableValueGUI.

Definition at line 53 of file class.ilFormPropertyGUI.php.

Referenced by ilImageFileInputGUI\__construct(), ilFileInputGUI\__construct(), ilColorPickerInputGUI\__construct(), ilFlashFileInputGUI\__construct(), ilDateTimeInputGUI\__construct(), ilRegExpInputGUI\__construct(), ilFontSizeInputGUI\__construct(), ilWidthHeightInputGUI\__construct(), ilCustomInputGUI\__construct(), ilBackgroundImageInputGUI\__construct(), ilBackgroundPositionInputGUI\__construct(), ilHiddenInputGUI\__construct(), ilTRBLBorderStyleInputGUI\__construct(), ilTRBLBorderWidthInputGUI\__construct(), ilRadioMatrixInputGUI\__construct(), ilNumericStyleValueInputGUI\__construct(), ilTRBLNumericStyleValueInputGUI\__construct(), ilFeedUrlInputGUI\__construct(), ilTRBLColorPickerInputGUI\__construct(), ilRadioGroupInputGUI\__construct(), ilAdvSelectInputGUI\__construct(), ilCheckboxInputGUI\__construct(), ilCheckboxGroupInputGUI\__construct(), ilLocationInputGUI\__construct(), ilMultiSelectInputGUI\__construct(), ilSelectInputGUI\__construct(), ilSuggestedSolutionSelectorGUI\__construct(), ilDateDurationInputGUI\__construct(), ilRepositorySelectorInputGUI\__construct(), ilDurationInputGUI\__construct(), and ilTextAreaInputGUI\__construct().

        {
                $this->type = $a_type;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::unserializeData

(

$a_data

)

unserialize data

Reimplemented in ilDateTimeInputGUI, and ilCheckboxInputGUI.

Definition at line 315 of file class.ilFormPropertyGUI.php.

References $data.

Referenced by readFromSession().

        {
                $data = unserialize($a_data);

                if ($data)
                {
                        $this->setValue($data);
                }
                else
                {
                        $this->setValue(false);
                }
        }

Here is the caller graph for this function:

ilFormPropertyGUI::writeToSession

(

)

Write to session.

Definition at line 332 of file class.ilFormPropertyGUI.php.

References $_SESSION, getFieldId(), getParent(), and serializeData().

Referenced by ilRepositorySelectorInputGUI\reset(), and ilRepositorySelectorInputGUI\selectRepositoryItem().

        {
                $parent = $this->getParent();
                if (!is_object($parent))
                {
                        die("You must set parent for ".get_class($this)." to use serialize feature.");
                }
                $_SESSION["form_".$parent->getId()][$this->getFieldId()] =
                        $this->serializeData();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

ilFormPropertyGUI::$alert

protected

Definition at line 17 of file class.ilFormPropertyGUI.php.

Referenced by getAlert().

ilFormPropertyGUI::$info

protected

Definition at line 16 of file class.ilFormPropertyGUI.php.

Referenced by getInfo().

ilFormPropertyGUI::$parentform

protected

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

ilFormPropertyGUI::$parentgui

protected

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

ilFormPropertyGUI::$postvar

protected

Definition at line 15 of file class.ilFormPropertyGUI.php.

Referenced by getPostVar().

ilFormPropertyGUI::$required = false

protected

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

Referenced by getRequired().

ilFormPropertyGUI::$title

protected

Definition at line 14 of file class.ilFormPropertyGUI.php.

Referenced by getTitle(), and ilRepositorySelectorInputGUI\render().

ilFormPropertyGUI::$type

protected

Definition at line 13 of file class.ilFormPropertyGUI.php.

Referenced by ilFontSizeInputGUI\checkInput(), ilBackgroundImageInputGUI\checkInput(), ilBackgroundPositionInputGUI\checkInput(), ilTRBLBorderWidthInputGUI\checkInput(), and getType().

---

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

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