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
	$hidden_title = ""

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, ilMultiSelectInputGUI, ilDurationInputGUI, ilCategoryWizardInputGUI, ilMatchingWizardInputGUI, ilRepositorySelectorInputGUI, ilKVPWizardInputGUI, ilNumberInputGUI, ilMatrixRowWizardInputGUI, ilErrorTextWizardInputGUI, ilSingleChoiceWizardInputGUI, ilSuggestedSolutionSelectorGUI, ilDateDurationInputGUI, ilCheckboxInputGUI, ilCSSRectInputGUI, ilRandomTestInputGUI, ilAnswerWizardInputGUI, ilImageWizardInputGUI, ilMatchingPairWizardInputGUI, ilCheckboxGroupInputGUI, ilLocationInputGUI, ilRadioGroupInputGUI, ilTRBLColorPickerInputGUI, ilEMailInputGUI, ilFeedUrlInputGUI, ilFileWizardInputGUI, ilRadioMatrixInputGUI, ilTextWizardInputGUI, ilNumericStyleValueInputGUI, ilTRBLNumericStyleValueInputGUI, ilRandomTestROInputGUI, ilCustomInputGUI, ilRegExpInputGUI, ilBackgroundImageInputGUI, ilBackgroundPositionInputGUI, ilFontSizeInputGUI, ilTRBLBorderWidthInputGUI, ilTextInputGUI, ilLuceneQueryInputGUI, ilDateTimeInputGUI, ilAlphabetInputGUI, ilSelectInputGUI, ilFileInputGUI, ilPasswordInputGUI, ilImagemapFileInputGUI, ilNestedListInputGUI, ilScaleInputGUI, ilAdvSelectInputGUI, ilFlashFileInputGUI, ilCountrySelectInputGUI, ilUserLoginInputGUI, ilScheduleInputGUI, ilColorPickerInputGUI, ilWidthHeightInputGUI, ilTRBLBorderStyleInputGUI, and ilImageFileInputGUI.

Definition at line 29 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 ilTextAreaInputGUI, ilDateDurationInputGUI, ilDateTimeInputGUI, ilDurationInputGUI, ilTextInputGUI, ilNumberInputGUI, ilCombinationInputGUI, ilKVPWizardInputGUI, ilTRBLColorPickerInputGUI, ilPasswordInputGUI, ilCategoryWizardInputGUI, ilErrorTextWizardInputGUI, ilSingleChoiceWizardInputGUI, ilFileInputGUI, ilCSSRectInputGUI, ilMatchingWizardInputGUI, ilTRBLNumericStyleValueInputGUI, ilMatrixRowWizardInputGUI, ilSuggestedSolutionSelectorGUI, ilMultiSelectInputGUI, ilAnswerWizardInputGUI, ilImageWizardInputGUI, ilRepositorySelectorInputGUI, ilTRBLBorderWidthInputGUI, ilCheckboxInputGUI, ilRandomTestInputGUI, ilLocationInputGUI, ilMatchingPairWizardInputGUI, ilBackgroundPositionInputGUI, ilTRBLBorderStyleInputGUI, ilCheckboxGroupInputGUI, ilFileWizardInputGUI, ilRadioGroupInputGUI, ilImagemapFileInputGUI, ilRadioMatrixInputGUI, ilTextWizardInputGUI, ilCustomInputGUI, ilWidthHeightInputGUI, ilNumericStyleValueInputGUI, ilRegExpInputGUI, ilBackgroundImageInputGUI, ilAlphabetInputGUI, ilSelectInputGUI, ilAdvSelectInputGUI, ilNestedListInputGUI, ilRandomTestROInputGUI, ilRecurrenceInputGUI, ilUserLoginInputGUI, ilEMailInputGUI, ilScheduleInputGUI, ilChatroomSmiliesCurrentSmileyFormElement, ilFlashFileInputGUI, ilHiddenInputGUI, ilFontSizeInputGUI, ilMultipleChoiceWizardInputGUI, ilBirthdayInputGUI, ilFeedUrlInputGUI, ilLuceneQueryInputGUI, ilSolutionTitleInputGUI, ilColorPickerInputGUI, ilNonEditableValueGUI, and ilFormulaInputGUI.

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

        {
                return false;           // please overwrite
        }

ilFormPropertyGUI::clearFromSession ( )

Clear session value.

Definition at line 347 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 39 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 157 of file class.ilFormPropertyGUI.php.

References $alert.

        {
                return $this->alert;
        }

ilFormPropertyGUI::getDisabled ( )

Get Disabled.

Returns: boolean Disabled

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

        {
                return $this->disabled;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getFieldId ( )

Get Post Variable.

Returns: string Post Variable

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

References getPostVar().

        {
                $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 373 of file class.ilFormPropertyGUI.php.

References ilUtil\prepareFormOutput().

Referenced by ilEMailInputGUI\insert(), ilTextAreaInputGUI\insert(), ilSelectInputGUI\render(), ilRadioGroupInputGUI\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 285 of file class.ilFormPropertyGUI.php.

References $hidden_title.

        {
                return $this->hidden_title;
        }

ilFormPropertyGUI::getInfo ( )

Get Information Text.

Returns: string Information Text

Reimplemented in ilNonEditableValueGUI.

Definition at line 137 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 295 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 247 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 227 of file class.ilFormPropertyGUI.php.

References getParent().

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

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

References $postvar.

        {
                return $this->postvar;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getRequired ( )

Get Required.

Returns: boolean Required

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

References $required.

        {
                return $this->required;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getSubForm ( )

Get sub form html.

Reimplemented in ilSubEnabledFormPropertyGUI.

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

        {
                return "";
        }

ilFormPropertyGUI::getTitle ( )

Get Title.

Returns: string Title

Reimplemented in ilNonEditableValueGUI.

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

References $title.

        {
                return $this->title;
        }

ilFormPropertyGUI::getType ( )

Get Type.

Returns: string Type

Reimplemented in ilNonEditableValueGUI.

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

References $type.

        {
                return $this->type;
        }

ilFormPropertyGUI::hideSubForm ( )

Sub form hidden on init?

Reimplemented in ilCheckboxInputGUI.

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

        {
                return false;
        }

ilFormPropertyGUI::readFromSession ( )

Read from session.

Definition at line 360 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, ilDurationInputGUI, ilCheckboxInputGUI, and ilCombinationInputGUI.

Definition at line 308 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 147 of file class.ilFormPropertyGUI.php.

        {
                $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 187 of file class.ilFormPropertyGUI.php.

Referenced by __construct(), ilUserProfile\addStandardFieldsToForm(), ilObjPaymentSettingsGUI\getERPform(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilObjRoleGUI\initFormRoleProperties(), ilObjSurveyGUI\initPropertiesForm(), ilObjiLincClassroomGUI\initSettingsForm(), and ilObjTestGUI\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 275 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 127 of file class.ilFormPropertyGUI.php.

Referenced by ilSCORMCertificateAdapter\addAdditionalFormElements(), ilObjAssessmentFolderGUI\defaultsObject(), ilObjSurveyGUI\defineQuestionblock(), ilSetupGUI\displaySessions(), ilPCQuestionOverviewGUI\edit(), ilObjExternalToolsSettingsGUI\editjsMathObject(), assFileUploadGUI\editQuestion(), SurveyMatrixQuestionGUI\editQuestion(), ilObjNewsSettingsGUI\editSettings(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilObjLearningResourcesSettingsGUI\editSettings(), ilObjAuthSettingsGUI\getApacheAuthSettingsForm(), ilChatroomFormFactory\getClientSettingsForm(), ilObjPaymentSettingsGUI\getERPform(), ilChatroomFormFactory\getSettingsForm(), ilObjSurveyGUI\importExternalMailRecipientsObject(), ilObjMediaCastGUI\initAddCastItemForm(), ilObjExerciseGUI\initAssignmentForm(), ilObjAuthSettingsGUI\initAuthModeDetermination(), ilSetupGUI\initBasicSettingsForm(), ilObjSystemFolderGUI\initBasicSettingsForm(), ilSetupGUI\initControlStructureForm(), ilObjSystemFolderGUI\initCronJobsForm(), ilObjBookingPoolGUI\initEditCustomForm(), ilObjExerciseGUI\initEditCustomForm(), ilObjRootFolderGUI\initEditForm(), ilObjCategoryGUI\initEditForm(), ilObjMailGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilBookingTypeGUI\initForm(), ilBookingScheduleGUI\initForm(), ilCalendarAppointmentGUI\initForm(), ilSkillCategoryGUI\initForm(), ilSkillTemplateReferenceGUI\initForm(), ilBasicSkillGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilECSMappingSettingsGUI\initFormCSettings(), ilCourseItemAdministrationGUI\initFormEdit(), ilExternalFeedBlockGUIGen\initFormFeedBlock(), ilPDExternalFeedBlockGUI\initFormFeedBlock(), ilExternalFeedBlockGUI\initFormFeedBlock(), ilObjUserFolderGUI\initFormGeneralSettings(), ilNewsItemGUI\initFormNewsItem(), ilNewsItemGUIGen\initFormNewsItem(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilConsultationHoursGUI\initFormSequence(), ilCASSettingsGUI\initFormSettings(), ilObjBlogAdministrationGUI\initFormSettings(), ilObjPortfolioAdministrationGUI\initFormSettings(), ilObjTaggingSettingsGUI\initFormSettings(), ilObjMediaCastSettingsGUI\initFormSettings(), ilObjCalendarSettingsGUI\initFormSettings(), ilObjForumGUI\initForumCreateForm(), ilObjAdvancedEditingGUI\initGeneralPageSettingsForm(), ilObjMDSettingsGUI\initGeneralSettingsForm(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilObjContentObjectGUI\initImportForm(), ilObjGroupGUI\initInfoEditor(), ilObjSystemFolderGUI\initJavaServerIniForm(), ilObjUserFolderGUI\initLoginSettingsForm(), ilMailOptionsGUI\initMailOptionsForm(), ilPersonalSettingsGUI\initMailOptionsForm(), ilObjMediaObjectsSettingsGUI\initMediaObjectsSettingsForm(), ilShopNewsGUI\initNewsForm(), ilObjAdvancedEditingGUI\initPageEditorForm(), ilObjStyleSheetGUI\initPropertiesForm(), ilObjContentObjectGUI\initPropertiesForm(), ilObjSurveyGUI\initPropertiesForm(), ilObjSystemFolderGUI\initProxyForm(), ilPersonalProfileGUI\initPublicProfileForm(), ilPermission2GUI\initRoleForm(), ilShopNewsGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilObjWikiGUI\initSettingsForm(), ilConsultationHoursGUI\initSettingsForm(), ilObjMediaCastGUI\initSettingsForm(), ilNewsForContextBlockGUI\initSettingsForm(), ilObjFileGUI\initSingleUploadForm(), ilObjForumGUI\initTopicCreateForm(), ilObjSystemFolderGUI\initWebServicesForm(), ilObjFileGUI\initZipUploadForm(), ilObjSurveyGUI\inviteObject(), ilObjSurveyQuestionPoolGUI\propertiesObject(), ilObjQuestionPoolGUI\propertiesObject(), ilRadiusSettingsGUI\settings(), ilOpenIdSettingsGUI\settings(), ilObjUserTrackingGUI\settingsObject(), ilConditionHandlerInterface\showObligatoryForm(), ilObjPrivacySecurityGUI\showPrivacy(), ilSCORM2004ScoGUI\showProperties(), 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 237 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 217 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 94 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 167 of file class.ilFormPropertyGUI.php.

        {
                $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 74 of file class.ilFormPropertyGUI.php.

Referenced by __construct(), and ilObjSCORM2004LearningModuleGUI\initGlossaryCreationForm().

        {
                $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 54 of file class.ilFormPropertyGUI.php.

        {
                $this->type = $a_type;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::unserializeData ( $a_data )

unserialize data

Reimplemented in ilDateTimeInputGUI, ilDurationInputGUI, ilCheckboxInputGUI, and ilCombinationInputGUI.

Definition at line 316 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 333 of file class.ilFormPropertyGUI.php.

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

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

        {
                $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();
        }