ilPropertyFormGUI Class Reference

This class represents a property form user interface. More...

Inheritance diagram for ilPropertyFormGUI:

Collaboration diagram for ilPropertyFormGUI:

Public Member Functions
	__construct ()
	executeCommand ()
	setTableWidth (string $a_width)
	getTableWidth ()
	setMode (string $a_mode)
	getMode ()
	setTitle (string $a_title)
	getTitle ()
	setTitleIcon (string $a_titleicon)
	getTitleIcon ()
	setDescription (string $a_val)
	getDescription ()
	setTopAnchor (string $a_val)
	getTopAnchor ()
	setShowTopButtons (bool $a_val)
	getShowTopButtons ()
	setForceTopButtons (bool $a_val)
	getForceTopButtons ()
	addItem ($a_item)
	removeItemByPostVar (string $a_post_var, bool $a_remove_unused_headers=false)
	getItemByPostVar (string $a_post_var)
	setItems (array $a_items)
	getItems ()
	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...
	setDisableStandardMessage (bool $a_val)
	getDisableStandardMessage ()
	getHideLabels ()
	setHideLabels (bool $a_value=true)
	setValuesByArray (array $a_values, bool $a_restrict_to_value_keys=false)
	setValuesByPost ()
	checkInput ()
	getInput (string $a_post_var, bool $ensureValidation=true)
	Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-POST variable, identified by the passed postvar. More...
	addCommandButton (string $a_cmd, string $a_text, string $a_id="")
	getCommandButtons ()
	clearCommandButtons ()
	getContent ()
	insertItem ( $item, bool $a_sub_item=false)
	addAsyncOnloadCode (string $code)
	getHTML ()
	getHTMLAsync ()
	getFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	Get file upload data. More...
	hasFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	moveFileUpload (string $a_target_directory, string $a_field, ?string $a_target_name=null, ?string $a_index=null, ?string $a_sub_index=null)
	Move upload to target directory. More...
Public Member Functions inherited from ilFormGUI
	setFormAction (string $a_formaction)
	getFormAction ()
	setTarget (string $a_target)
	getTarget ()
	setMultipart (bool $a_multipart)
	getMultipart ()
	setId (string $a_id)
	getId ()
	setName (string $a_name)
	getName ()
	setKeepOpen (bool $a_keepopen)
	getKeepOpen ()
	setOpenTag (bool $a_open)
	getOpenTag ()
	setCloseTag (bool $a_val)
	getCloseTag ()
	setPreventDoubleSubmission (bool $a_val)
	getPreventDoubleSubmission ()
	getHTML ()
	getContent ()

Protected Member Functions
	getRequestedPostVar ()
	getFileHash ()
	hideRequired (string $a_type)
	appendOnloadCode (string $html)
	rebuildUploadedFiles ()
	checkForRequiredField ()

Protected Attributes
bool	$required_text = false
ilLanguage	$lng
ilCtrl	$ctrl
ilTemplate	$tpl
ilObjUser	$user = null
ilSetting	$settings = null
string	$mode = "std"
bool	$check_input_called = false
bool	$disable_standard_message = false
string	$top_anchor = "il_form_top"
string	$title = ''
string	$titleicon = ""
string	$description = ""
string	$tbl_width = ""
bool	$show_top_buttons = true
bool	$hide_labels = false
bool	$force_top_buttons = false
HTTP Services	$http
Refinery Factory	$refinery = null
ilGlobalTemplateInterface	$global_tpl = null
	$onload_code = []
Protected Attributes inherited from ilFormGUI
string	$formaction = ""
bool	$multipart = false
bool	$keepopen = false
bool	$opentag = true
string	$id = ''
string	$name = ''
string	$target = ''
bool	$prevent_double_submission = false

Private Attributes
array	$kept_uploads = []
array	$buttons = array()
array	$items = array()

Detailed Description

This class represents a property form user interface.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilPropertyFormGUI: ilFormPropertyDispatchGUI

Deprecated:

12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

__construct()

ilPropertyFormGUI::__construct

(

)

Reimplemented in ilMStListCoursesGUI, ilAssOrderingQuestionAuthoringFormGUI, and ilAssQuestionAuthoringFormGUI.

Definition at line 59 of file class.ilPropertyFormGUI.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
 
        $this->user = null;
        if (isset($DIC["ilUser"])) {
            $this->user = $DIC["ilUser"];
        }
 
        $this->settings = null;
        if (isset($DIC["ilSetting"])) {
            $this->settings = $DIC["ilSetting"];
        }
 
        $lng = $DIC->language();
 
        $lng->loadLanguageModule("form");
 
        // avoid double submission
        $this->setPreventDoubleSubmission(true);
 
        // do it as early as possible
        if (isset($DIC["http"])) {
            $this->http = $DIC->http();
        }
        if (isset($DIC["refinery"])) {
            $this->refinery = $DIC->refinery();
        }
        $this->rebuildUploadedFiles();
        if (isset($DIC["tpl"])) {      // some unit tests will fail otherwise
            $this->global_tpl = $DIC['tpl'];
        }
    }

References $DIC, $lng, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), rebuildUploadedFiles(), ILIAS\Repository\refinery(), ilFormGUI\setPreventDoubleSubmission(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

addAsyncOnloadCode()

ilPropertyFormGUI::addAsyncOnloadCode

(

string

$code

)

Definition at line 806 of file class.ilPropertyFormGUI.php.

                                                    : void
    {
        $this->onload_code[] = $code;
    }

addCommandButton()

ilPropertyFormGUI::addCommandButton	(	string	$a_cmd,
		string	$a_text,
		string	$a_id = ""
	)

Definition at line 467 of file class.ilPropertyFormGUI.php.

     : void {
        $this->buttons[] = array("cmd" => $a_cmd, "text" => $a_text, "id" => $a_id);
    }

Referenced by FormMailCodesGUI\__construct(), SurveyQuestionGUI\addCommandButtons(), ilPageComponentPluginGUI\addCreationButton(), ilAssQuestionAuthoringFormGUI\addGenericAssessmentQuestionCommandButtons(), assQuestionGUI\addQuestionFormCommandButtons(), ilAssOrderingQuestionAuthoringFormGUI\addSpecificOrderingQuestionCommandButtons(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilPCMediaObjectGUI\changeObjectReference(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellStyle(), ilDidacticTemplateSettingsGUI\editImportForm(), ilObjCourseGUI\editMapSettingsObject(), ilObjGroupGUI\editMapSettingsObject(), ilPCMediaObjectGUI\editStyle(), ilForumThreadFormGUI\generateDefaultForm(), ilForumThreadFormGUI\generateMinimalForm(), ilObjStyleSheetGUI\getCloneForm(), ilLTIConsumeProviderFormGUI\getContentSelectionFrame(), ilObjStyleSheetGUI\getCreateForm(), ilLTIConsumeProviderFormGUI\getDynRegError(), ilObjStyleSheetGUI\getImportForm(), ILIAS\COPage\Editor\Server\UIWrapper\getRenderedForm(), ilMailTemplateGUI\getTemplateForm(), ilMailOptionsFormGUI\init(), ilObjOrgUnitGUI\initAdvancedSettingsForm(), ilObjStudyProgrammeGUI\initAdvancedSettingsForm(), ilBiblFieldFilterFormGUI\initButtons(), ILIAS\components\OrgUnit\ARHelper\BaseForm\initButtons(), ilOrgUnitPositionFormGUI\initButtons(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreateForm(), ilLTIConsumeProviderFormGUI\initDynRegForm(), ilObjCourseGUI\initEditForm(), ilObjTalkTemplateGUI\initEditForm(), ilObjFolderGUI\initEditForm(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilAccessibilityDocumentFormGUI\initForm(), ilBiblLibraryFormGUI\initForm(), ilExtIdGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilWebDAVMountInstructionsDocumentFormGUI\initForm(), ilContainerReferenceGUI\initForm(), ilObjGroupGUI\initForm(), ilLTIConsumeProviderFormGUI\initForm(), ilLTIConsumerSettingsFormGUI\initForm(), ilCourseObjectivesGUI\initFormRandom(), ilMembershipAdministrationGUI\initFormSettings(), ilObjAdvancedEditingGUI\initGeneralPageSettingsForm(), ilCalendarCategoryGUI\initImportForm(), ilObjCourseGUI\initInfoEditor(), ilObjGroupGUI\initInfoEditor(), ilSkillRootGUI\initInputForm(), ilECSSettingsGUI\initMappingsForm(), ilObjectCustomUserFieldsGUI\initMemberForm(), ilObjContentObjectGUI\initMenuEntryForm(), ilObjContentObjectGUI\initMenuForm(), ilPageObjectGUI\initOpenedContentForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), and ilObjSCORMLearningModuleGUI\initTrackingImportForm().

Here is the caller graph for this function:

addItem()

ilPropertyFormGUI::addItem

(

$a_item

)

Parameters

ilFormPropertyGUI | ilFormSectionHeaderGUI

$a_item

Definition at line 214 of file class.ilPropertyFormGUI.php.

                                    : void
    {
        $a_item->setParentForm($this);
        $this->items[] = $a_item;
    }

Referenced by FormMailCodesGUI\__construct(), ilMemberAgreementGUI\addAgreement(), ilForumThreadFormGUI\addAliasInput(), ilForumThreadFormGUI\addAllowNotificationInput(), ilForumThreadFormGUI\addAutosaveInfo(), ilObjContentPageGUI\addAvailabilitySection(), ilForumSettingsGUI\addAvailabilitySection(), assQuestionGUI\addBasicQuestionFormProperties(), ilObjCourseAdministrationGUI\addChildContentsTo(), ilIndividualAssessmentCommonSettingsGUI\addCommonFieldsToForm(), ilObjRemoteCourseGUI\addCustomEditForm(), ilObjRemoteGlossaryGUI\addCustomEditForm(), ilObjRemoteGroupGUI\addCustomEditForm(), ilObjRemoteLearningModuleGUI\addCustomEditForm(), ilObjRemoteTestGUI\addCustomEditForm(), ilObjRemoteWikiGUI\addCustomEditForm(), ilAdvancedMDFieldDefinitionSelect\addCustomFieldToDefinitionFormInTranslationMode(), ilConsultationHourCron\addCustomSettingsToForm(), ilCleanCOPageHistoryCronjob\addCustomSettingsToForm(), ilForumCronNotification\addCustomSettingsToForm(), ilLoggerCronCleanErrorFiles\addCustomSettingsToForm(), ilMailCronOrphanedMails\addCustomSettingsToForm(), ilCronOerHarvester\addCustomSettingsToForm(), ilSCCronTrash\addCustomSettingsToForm(), ilCronDeleteInactivatedUserAccounts\addCustomSettingsToForm(), ilCronDeleteInactiveUserAccounts\addCustomSettingsToForm(), ilCronDeleteNeverLoggedInUserAccounts\addCustomSettingsToForm(), ilExAssTypePortfolioGUI\addEditFormCustomProperties(), ilExAssTypeTextGUI\addEditFormCustomProperties(), ilExAssTypeWikiTeamGUI\addEditFormCustomProperties(), SurveyMatrixQuestionGUI\addFieldsToEditForm(), SurveyMetricQuestionGUI\addFieldsToEditForm(), SurveyMultipleChoiceQuestionGUI\addFieldsToEditForm(), SurveySingleChoiceQuestionGUI\addFieldsToEditForm(), SurveyTextQuestionGUI\addFieldsToEditForm(), ilForumThreadFormGUI\addFileUploadInput(), ilObjectCommonSettingFormAdapter\addIcon(), ilMembershipRegistrationSettingsGUI\addMembershipFormElements(), ilForumThreadFormGUI\addMessageInput(), assQuestionGUI\addNumberOfTriesToFormIfNecessary(), ILIAS\MediaObjects\Video\GUIService\addPreviewInput(), ilECSObjectSettings\addSettingsToForm(), ILIAS\Blog\ReadingTime\BlogSettingsGUI\addSettingToForm(), ILIAS\LearningModule\ReadingTime\SettingsGUI\addSettingToForm(), ilSkillTreeNodeGUI\addStatusInput(), ilForumThreadFormGUI\addSubjectInput(), ilObjectCommonSettingFormAdapter\addTileImage(), ilObjectCommonSettingFormAdapter\addTitleIconVisibility(), ilTaxMDGUI\addToMDForm(), ilObjectCommonSettingFormAdapter\addTopActionsVisibility(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilAssQuestionFeedback\completeGenericFormProperties(), ilAssClozeTestFeedback\completeSpecificFormProperties(), ilAssConfigurableMultiOptionQuestionFeedback\completeSpecificFormProperties(), ilAssMultiOptionQuestionFeedback\completeSpecificFormProperties(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellStyle(), ilDidacticTemplateSettingsGUI\editImportForm(), ilObjCourseGUI\editMapSettingsObject(), ilObjGroupGUI\editMapSettingsObject(), ilPCMediaObjectGUI\editStyle(), ilObjStyleSheetGUI\getCloneForm(), ilObjStyleSheetGUI\getCreateForm(), ilForumSettingsGUI\getCustomForm(), ilObjStyleSheetGUI\getImportForm(), ilMailTemplateGUI\getTemplateForm(), ilExAssignmentEditorGUI\handleDisabledPeerFields(), ilMailOptionsFormGUI\init(), ilCourseLPBadgeGUI\initConfigForm(), ilObjPortfolioGUI\initCopyPageFormOptions(), ilObjPortfolioTemplateGUI\initCopyPageFormOptions(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreateForm(), ilExcCriteriaText\initCustomForm(), ilObjectGUI\initDidacticTemplate(), ilObjPortfolioTemplateGUI\initDidacticTemplate(), ilLTIConsumeProviderFormGUI\initDynRegForm(), ilObjContentPageGUI\initEditCustomForm(), ilObjTalkTemplateGUI\initEditCustomForm(), ilObjPollGUI\initEditCustomForm(), ilObjPortfolioBaseGUI\initEditCustomForm(), ilObjBookingPoolGUI\initEditCustomForm(), ilObjItemGroupGUI\initEditCustomForm(), ilObjCourseGUI\initEditForm(), ilObjFolderGUI\initEditForm(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilObjCourseReferenceGUI\initForm(), ilAccessibilityDocumentFormGUI\initForm(), ilBiblLibraryFormGUI\initForm(), ilBiblFieldFilterFormGUI\initForm(), ilExtIdGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilWebDAVMountInstructionsDocumentFormGUI\initForm(), ilContainerReferenceGUI\initForm(), ilObjGroupGUI\initForm(), ilLTIConsumeProviderFormGUI\initForm(), ilLTIConsumerSettingsFormGUI\initForm(), ilOrgUnitAuthorityFormGUI\initFormElements(), ilOrgUnitPositionFormGUI\initFormElements(), ilCourseObjectivesGUI\initFormRandom(), ilMembershipAdministrationGUI\initFormSettings(), ilObjAdvancedEditingGUI\initGeneralPageSettingsForm(), ilCalendarCategoryGUI\initImportForm(), ilObjCourseGUI\initInfoEditor(), ilObjGroupGUI\initInfoEditor(), ilSkillRootGUI\initInputForm(), ilContainerGUI\initListPresentationForm(), ilECSSettingsGUI\initMappingsForm(), ilObjContentObjectGUI\initMenuEntryForm(), ilObjContentObjectGUI\initMenuForm(), ilPageObjectGUI\initOpenedContentForm(), ilAdvancedMDFieldDefinitionGroupBased\initOptionForm(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), ilObjSCORMLearningModuleGUI\initTrackingImportForm(), assMatchingQuestionGUI\populateAnswerSpecificFormPart(), assNumericGUI\populateAnswerSpecificFormPart(), assTextQuestionGUI\populateAnswerSpecificFormPart(), assTextSubsetGUI\populateAnswerSpecificFormPart(), assMultipleChoiceGUI\populateAnswerSpecificFormPart(), assSingleChoiceGUI\populateAnswerSpecificFormPart(), assClozeTestGUI\populateAnswerSpecificFormPart(), assErrorTextGUI\populateAnswerSpecificFormPart(), assOrderingQuestionGUI\populateAnswerSpecificFormPart(), assKprimChoiceGUI\populateAnswerSpecificFormPart(), assErrorTextGUI\populateCorrectionsFormProperties(), assFileUploadGUI\populateCorrectionsFormProperties(), assImagemapQuestionGUI\populateCorrectionsFormProperties(), assKprimChoiceGUI\populateCorrectionsFormProperties(), assLongMenuGUI\populateCorrectionsFormProperties(), assMatchingQuestionGUI\populateCorrectionsFormProperties(), assMultipleChoiceGUI\populateCorrectionsFormProperties(), assNumericGUI\populateCorrectionsFormProperties(), assOrderingHorizontalGUI\populateCorrectionsFormProperties(), assOrderingQuestionGUI\populateCorrectionsFormProperties(), assSingleChoiceGUI\populateCorrectionsFormProperties(), assTextSubsetGUI\populateCorrectionsFormProperties(), ilAssQuestionSkillAssignmentPropertyFormGUI\populateFullProperties(), assClozeTestGUI\populateGapCombinationCorrectionFormProperty(), ilAssQuestionSkillAssignmentPropertyFormGUI\populateLimitedProperties(), assImagemapQuestionGUI\populateQuestionSpecificFormPart(), assMatchingQuestionGUI\populateQuestionSpecificFormPart(), assNumericGUI\populateQuestionSpecificFormPart(), assOrderingHorizontalGUI\populateQuestionSpecificFormPart(), assOrderingQuestionGUI\populateQuestionSpecificFormPart(), assTextQuestionGUI\populateQuestionSpecificFormPart(), assTextSubsetGUI\populateQuestionSpecificFormPart(), assMultipleChoiceGUI\populateQuestionSpecificFormPart(), assSingleChoiceGUI\populateQuestionSpecificFormPart(), assClozeTestGUI\populateQuestionSpecificFormPart(), assErrorTextGUI\populateQuestionSpecificFormPart(), assFileUploadGUI\populateQuestionSpecificFormPart(), assLongMenuGUI\populateQuestionSpecificFormPart(), assKprimChoiceGUI\populateQuestionSpecificFormPart(), assQuestionGUI\populateTaxonomyFormSection(), ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation(), ilAdvancedMDFieldDefinition\prepareDefinitionFormConfirmation(), and ILIAS\User\Profile\PersonalProfileGUI\showPublicProfileFields().

Here is the caller graph for this function:

appendOnloadCode()

ilPropertyFormGUI::appendOnloadCode ( string  $html )

protected

Definition at line 840 of file class.ilPropertyFormGUI.php.

                                                     : string
    {
        if (count($this->onload_code) > 0) {
            $html .= "<script>";
            foreach ($this->onload_code as $code) {
                $html .= $code . "\n";
            }
            $html .= "</script>";
        }
        return $html;
    }

checkForRequiredField()

ilPropertyFormGUI::checkForRequiredField ( )

protected

Definition at line 1065 of file class.ilPropertyFormGUI.php.

                                              : bool
    {
        foreach ($this->items as $item) {
            if ($item instanceof ilFormSectionHeaderGUI) {
                return false;
            } elseif ($item->getType() != "hidden") {
                if ($this->getMode() == "subform") {
                    if (!$this->hideRequired($item->getType())) {
                        if ($item->getRequired()) {
                            return true;
                        }
                    }
                } elseif (!$this->hideRequired($item->getType())) {
                    if ($item->getRequired()) {
                        return true;
                    }
                }
            }
        }
 
        return false;
    }

checkInput()

ilPropertyFormGUI::checkInput

(

)

Definition at line 345 of file class.ilPropertyFormGUI.php.

                                : bool
    {
        global $DIC;
 
        if ($this->check_input_called) {
            die("Error: ilPropertyFormGUI->checkInput() called twice.");
        }
 
        $ok = true;
        foreach ($this->items as $item) {
            $item_ok = $item->checkInput();
            if (!$item_ok) {
                $ok = false;
            }
        }
 
        // check if POST is missing completely (if post_max_size exceeded)
        $post = $this->http->request()->getParsedBody();
        if (count($this->items) > 0 && count($post) === 0) {
            $ok = false;
        }
 
        $this->check_input_called = true;
 
        // try to keep uploads for another try
        $filehash = $this->getFileHash();
        if (!$ok && !is_null($filehash) && $filehash && count($_FILES)) {
            $hash = $filehash;
 
            foreach ($_FILES as $field => $data) {
                // only try to keep files that are ok
                // see 25484: Wrong error handling when uploading icon instead of tile
                $item = $this->getItemByPostVar($field);
                if (is_null($item) || !$item->checkInput()) {
                    continue;
                }
                // we support up to 2 nesting levels (see test/assessment)
                if (is_array($data["tmp_name"])) {
                    foreach ($data["tmp_name"] as $idx => $upload) {
                        if (is_array($upload)) {
                            foreach ($upload as $idx2 => $file) {
                                if ($file && is_uploaded_file($file)) {
                                    $file_name = $data["name"][$idx][$idx2];
                                    $file_type = $data["type"][$idx][$idx2];
                                    $this->keepFileUpload($hash, $field, $file, $file_name, $file_type, (string) $idx, (string) $idx2);
                                }
                            }
                        } elseif ($upload && is_uploaded_file($upload)) {
                            $file_name = $data["name"][$idx];
                            $file_type = $data["type"][$idx];
                            $this->keepFileUpload($hash, $field, $upload, $file_name, $file_type, (string) $idx);
                        }
                    }
                } else {
                    $this->keepFileUpload($hash, $field, $data["tmp_name"], $data["name"], $data["type"]);
                }
            }
        }
        $http = $DIC->http();
        $txt = $DIC->language()->txt("form_input_not_valid");
        switch ($http->request()->getHeaderLine('Accept')) {
            // When JS asks for a valid JSON-Response, we send the success and message as JSON
            case 'application/json':
                $stream = \ILIAS\Filesystem\Stream\Streams::ofString(json_encode([
                    'success' => $ok,
                    'message' => $txt,
                ]));
                $http->saveResponse($http->response()->withBody($stream));
 
                return $ok;
 
                // Otherwise, we send it using ilUtil, and it will be rendered in the Template
            default:
 
                if (!$ok && !$this->getDisableStandardMessage()) {
                    $this->global_tpl->setOnScreenMessage('failure', $txt);
                }
 
                return $ok;
        }
    }

References $data, $DIC, $http, $post, ILIAS\FileDelivery\http(), and ILIAS\Filesystem\Stream\Streams\ofString().

Referenced by ILIAS\Survey\Settings\SettingsFormGUI\checkForm(), ilPCSectionGUI\checkInput(), ilObjUserFolderGUI\confirmaccessRestrictObject(), ilObjStyleSheetGUI\copyStyleObject(), ilAccessibilityCriterionFormGUI\fillObject(), ilBiblFieldFilterFormGUI\fillObject(), ilOrgUnitAuthorityFormGUI\fillObject(), ilObjOrgUnitSettingsFormGUI\fillObject(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillObject(), ilSkillRootGUI\importSkills(), ilObjSCORMLearningModuleGUI\importTracking(), ilMailTemplateGUI\insertTemplateCommand(), ilRegistrationGUI\join(), ilExAssignmentEditorGUI\processForm(), ilCalendarCategoryGUI\save(), ilCourseObjectivesGUI\save(), ilMailOptionsFormGUI\save(), ilMemberAgreementGUI\save(), ilObjLinkResourceGUI\saveAddLink(), ilPCMediaObjectGUI\saveAliasProperties(), ilCertificateGUI\saveCertificate(), ilObjAdvancedEditingGUI\saveGeneralPageSettingsObject(), ilObjLinkResourceGUI\saveLinkList(), ilObjectCustomUserFieldsGUI\saveMember(), ilObjContentObjectGUI\saveMenuEntry(), ilObjContentObjectGUI\saveMenuProperties(), ilBiblLibraryFormGUI\saveObject(), ilContainerReferenceGUI\saveObject(), ilObjEmployeeTalkSeriesGUI\saveObject(), ilObjGlossaryGUI\saveObject(), ilObjStyleSheetGUI\saveObject(), ilObjContentObjectGUI\saveProperties(), ilCourseObjectivesGUI\saveRandom(), ilMembershipAdministrationGUI\saveSettings(), ilObjMediaPoolGUI\saveTitlesAndDescriptions(), ilSamlSettingsGUI\saveUserAttributeMappingCommand(), ilCalendarCategoryGUI\update(), ilExtIdGUI\update(), ilObjOrgUnitGUI\updateAdvancedSettings(), ilObjStudyProgrammeGUI\updateAdvancedSettings(), ilObjCourseGUI\updateInfoObject(), ilObjLinkResourceGUI\updateLink(), ilObjContentObjectGUI\updateMenuEntry(), ilContainerReferenceGUI\updateObject(), ilObjCourseGUI\updateObject(), ilObjEmployeeTalkGUI\updateObject(), ilObjGroupGUI\updateObject(), ilObjStudyProgrammeReferenceGUI\updateObject(), ilDidacticTemplateSettingsGUI\updateTemplate(), ilMailTemplateGUI\updateTemplateCommand(), and ilCalendarCategoryGUI\uploadAppointments().

Here is the call graph for this function:

Here is the caller graph for this function:

clearCommandButtons()

ilPropertyFormGUI::clearCommandButtons

(

)

Definition at line 481 of file class.ilPropertyFormGUI.php.

                                         : void
    {
        $this->buttons = array();
    }

Referenced by ilPCMediaObjectGUI\changeObjectReference(), ilLTIConsumeProviderFormGUI\getContentSelectionFrame(), ilLTIConsumeProviderFormGUI\getDynRegError(), ilLTIConsumeProviderFormGUI\getDynRegRequest(), ilLTIConsumeProviderFormGUI\initDynRegForm(), and ilAssOrderingQuestionAuthoringFormGUI\renewOrderingCommandButtons().

Here is the caller graph for this function:

executeCommand()

ilPropertyFormGUI::executeCommand

(

)

Returns

mixed

Exceptions

ilCtrlException

Reimplemented in ilMStListCoursesGUI.

Definition at line 100 of file class.ilPropertyFormGUI.php.

    {
        $ilCtrl = $this->ctrl;
 
        $next_class = $ilCtrl->getNextClass($this);
 
        switch ($next_class) {
            case 'ilformpropertydispatchgui':
                $ilCtrl->saveParameter($this, 'postvar');
                $form_prop_dispatch = new ilFormPropertyDispatchGUI();
                $item = $this->getItemByPostVar($this->getRequestedPostVar());
                $form_prop_dispatch->setItem($item);
                return $ilCtrl->forwardCommand($form_prop_dispatch);
        }
        return false;
    }

References $ctrl, getItemByPostVar(), ilCtrl\getNextClass(), and getRequestedPostVar().

Here is the call graph for this function:

getCommandButtons()

ilPropertyFormGUI::getCommandButtons

(

)

Definition at line 476 of file class.ilPropertyFormGUI.php.

                                       : array
    {
        return $this->buttons;
    }

getContent()

ilPropertyFormGUI::getContent

(

)

Reimplemented from ilFormGUI.

Definition at line 486 of file class.ilPropertyFormGUI.php.

                                : string
    {
        global $DIC;
        $lng = $this->lng;
        $tpl = $DIC["tpl"];
        $ilSetting = $this->settings;
 
        $tpl->addJavaScript("assets/js/Basic.js");
        $tpl->addJavaScript("assets/js/Form.js");
 
        $this->tpl = new ilTemplate("tpl.property_form.html", true, true, "components/ILIAS/Form");
 
        // check if form has not title and first item is a section header
        // -> use section header for title and remove section header
        // -> command buttons are presented on top
        $fi = $this->items[0] ?? null;
        if ($this->getMode() == "std" &&
            $this->getTitle() == "" &&
            is_object($fi) && $fi->getType() == "section_header"
        ) {
            $this->setTitle($fi->getTitle());
            unset($this->items[0]);
        }
 
 
        // title icon
        if ($this->getTitleIcon() != "" && is_file($this->getTitleIcon())) {
            $this->tpl->setCurrentBlock("title_icon");
            $this->tpl->setVariable("IMG_ICON", $this->getTitleIcon());
            $this->tpl->parseCurrentBlock();
        }
 
        // title
        if ($this->getTitle() != "") {
            // commands on top
            if (count($this->buttons) > 0 && $this->getShowTopButtons() && (count($this->items) > 2 || $this->force_top_buttons)) {
                // command buttons
                foreach ($this->buttons as $button) {
                    $this->tpl->setCurrentBlock("cmd2");
                    $this->tpl->setVariable("CMD", $button["cmd"]);
                    $this->tpl->setVariable("CMD_TXT", $button["text"]);
                    if ($button["id"] != "") {
                        $this->tpl->setVariable("CMD2_ID", " id='" . $button["id"] . "_top'");
                    }
                    $this->tpl->parseCurrentBlock();
                }
                $this->tpl->setCurrentBlock("commands2");
                $this->tpl->parseCurrentBlock();
            }
 
            // required top
            $this->tpl->setCurrentBlock("header");
            if ($this->checkForRequiredField()) {
                $this->tpl->setCurrentBlock("required_text_top");
                $this->tpl->setVariable("TXT_REQUIRED_TOP", $lng->txt("required_field"));
                $this->tpl->parseCurrentBlock();
            }
 
            $this->tpl->setVariable("TXT_TITLE", $this->getTitle());
            //$this->tpl->setVariable("LABEL", $this->getTopAnchor());
            $this->tpl->setVariable("TXT_DESCRIPTION", $this->getDescription());
            $this->tpl->parseCurrentBlock();
        } elseif (!$this->required_text && $this->getMode() == "std") {
            $this->tpl->setCurrentBlock("header");
            // required top
            $this->tpl->setCurrentBlock("required_text_top");
            $this->tpl->setVariable("TXT_REQUIRED_TOP", $lng->txt("required_field"));
            $this->tpl->parseCurrentBlock();
        }
        $this->tpl->touchBlock("item");
 
        // properties
        $this->required_text = false;
        foreach ($this->items as $item) {
            if ($item->getType() != "hidden") {
                $this->insertItem($item);
            }
        }
 
        // required
        if ($this->required_text && $this->getMode() == "std") {
            $this->tpl->setCurrentBlock("required_text");
            $this->tpl->setVariable("TXT_REQUIRED", $lng->txt("required_field"));
            $this->tpl->parseCurrentBlock();
        }
 
        // command buttons
        foreach ($this->buttons as $button) {
            $this->tpl->setCurrentBlock("cmd");
            $this->tpl->setVariable("CMD", $button["cmd"]);
            $this->tpl->setVariable("CMD_TXT", $button["text"]);
 
            if ($button["id"] != "") {
                $this->tpl->setVariable("CMD_ID", " id='" . $button["id"] . "'");
            }
 
            $this->tpl->parseCurrentBlock();
        }
 
        // #18808
        if ($this->getMode() != "subform") {
            // try to keep uploads even if checking input fails
            if ($this->getMultipart()) {
                $hash = $this->getFileHash() ?? null;
                if (!$hash) {
                    $hash = md5(uniqid((string) mt_rand(), true));
                }
                $fhash = new ilHiddenInputGUI("ilfilehash");
                $fhash->setValue($hash);
                $this->addItem($fhash);
            }
        }
 
        // hidden properties
        $hidden_fields = false;
        foreach ($this->items as $item) {
            if ($item->getType() == "hidden") {
                $item->insert($this->tpl);
                $hidden_fields = true;
            }
        }
 
        if ($this->required_text || count($this->buttons) > 0 || $hidden_fields) {
            $this->tpl->setCurrentBlock("commands");
            $this->tpl->parseCurrentBlock();
        }
 
 
        if ($this->getMode() == "subform") {
            $this->tpl->touchBlock("sub_table");
        } else {
            $this->tpl->touchBlock("std_table");
            $this->tpl->setVariable('STD_TABLE_WIDTH', $this->getTableWidth());
        }
 
        return $this->tpl->get();
    }

References $DIC, $ilSetting, $lng, and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

getDescription()

ilPropertyFormGUI::getDescription

(

)

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

                                    : string
    {
        return $this->description;
    }

References $description.

getDisableStandardMessage()

ilPropertyFormGUI::getDisableStandardMessage

(

)

Definition at line 304 of file class.ilPropertyFormGUI.php.

                                               : bool
    {
        return $this->disable_standard_message;
    }

getFileHash()

ilPropertyFormGUI::getFileHash ( )

protected

Definition at line 427 of file class.ilPropertyFormGUI.php.

                                    : ?string
    {
        if (is_null($this->refinery)) {
            return null;
        }
        // try to keep uploads for another try
        $t = $this->refinery->kindlyTo()->string();
        $w = $this->http->wrapper();
        $filehash = null;
        if ($w->post()->has("ilfilehash")) {
            $filehash = $w->post()->retrieve("ilfilehash", $t);
        }
        return $filehash;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

getFileUpload()

ilPropertyFormGUI::getFileUpload	(	string	$a_field,
		?string	$a_index = null,
		?string	$a_sub_index = null
	)

Get file upload data.

Parameters

string	$a_field	form field
mixed	$a_index	form field index (if array)
mixed	$a_sub_index	form field subindex (if array)

Returns

array (tmp_name, name, type, error, size, is_upload)

Definition at line 917 of file class.ilPropertyFormGUI.php.

     : array {
        $res = array();
        if ($a_index) {
            if ($_FILES[$a_field]["tmp_name"][$a_index][$a_sub_index] ?? false) {
                $res = array(
                    "tmp_name" => $_FILES[$a_field]["tmp_name"][$a_index][$a_sub_index],
                    "name" => $_FILES[$a_field]["name"][$a_index][$a_sub_index],
                    "type" => $_FILES[$a_field]["type"][$a_index][$a_sub_index],
                    "error" => $_FILES[$a_field]["error"][$a_index][$a_sub_index],
                    "size" => $_FILES[$a_field]["size"][$a_index][$a_sub_index],
                    "is_upload" => $_FILES[$a_field]["is_upload"][$a_index][$a_sub_index] ?? true
                );
            }
        } elseif ($a_sub_index) {
            if ($_FILES[$a_field]["tmp_name"][$a_index] ?? false) {
                $res = array(
                    "tmp_name" => $_FILES[$a_field]["tmp_name"][$a_index],
                    "name" => $_FILES[$a_field]["name"][$a_index],
                    "type" => $_FILES[$a_field]["type"][$a_index],
                    "error" => $_FILES[$a_field]["error"][$a_index],
                    "size" => $_FILES[$a_field]["size"][$a_index],
                    "is_upload" => $_FILES[$a_field]["is_upload"][$a_index] ?? true
                );
            }
        } else {
            if ($_FILES[$a_field]["tmp_name"] ?? false) {
                $res = array(
                    "tmp_name" => $_FILES[$a_field]["tmp_name"],
                    "name" => $_FILES[$a_field]["name"],
                    "type" => $_FILES[$a_field]["type"],
                    "error" => $_FILES[$a_field]["error"],
                    "size" => $_FILES[$a_field]["size"],
                    "is_upload" => $_FILES[$a_field]["is_upload"] ?? true
                );
            }
        }
        return $res;
    }

References $res.

getForceTopButtons()

ilPropertyFormGUI::getForceTopButtons

(

)

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

                                        : bool
    {
        return $this->force_top_buttons;
    }

References $force_top_buttons.

getHideLabels()

ilPropertyFormGUI::getHideLabels

(

)

Definition at line 310 of file class.ilPropertyFormGUI.php.

                                   : bool
    {
        return $this->hide_labels;
    }

getHTML()

ilPropertyFormGUI::getHTML

(

)

Reimplemented from ilFormGUI.

Reimplemented in ilLTIConsumerProviderSelectionFormTableGUI, and ilAssQuestionSkillAssignmentPropertyFormGUI.

Definition at line 811 of file class.ilPropertyFormGUI.php.

                             : string
    {
        $html = parent::getHTML();
 
        // #13531 - get content that has to reside outside of the parent form tag, e.g. panels/layers
        foreach ($this->items as $item) {
            // #13536 - ilFormSectionHeaderGUI does NOT extend ilFormPropertyGUI ?!
            if (method_exists($item, "getContentOutsideFormTag")) {
                $outside = $item->getContentOutsideFormTag();
                if ($outside) {
                    $html .= $outside;
                }
            }
        }
        if ($this->ctrl->isAsynch()) {
            $html = $this->appendOnloadCode($html);
        }
        return $html;
    }

References ILIAS\Repository\ctrl().

Referenced by ilCalendarCategoryGUI\add(), ilObjLinkResourceGUI\addLink(), ilObjContentObjectGUI\addMenuEntry(), ilObjSessionGUI\attendanceListObject(), ilPCMediaObjectGUI\changeObjectReference(), ilCourseObjectivesGUI\create(), ilContainerReferenceGUI\createObject(), ilExtIdGUI\edit(), ilExcCriteriaGUI\edit(), ilCalendarCategoryGUI\edit(), ilCourseObjectivesGUI\edit(), ilObjOrgUnitGUI\editAdvancedSettings(), ilObjStudyProgrammeGUI\editAdvancedSettings(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellStyle(), ilObjGroupGUI\editInfoObject(), ilObjLinkResourceGUI\editLink(), ilObjCourseGUI\editMapSettingsObject(), ilObjGroupGUI\editMapSettingsObject(), ilObjectCustomUserFieldsGUI\editMember(), ilObjContentObjectGUI\editMenuEntry(), ilObjContentObjectGUI\editMenuProperties(), ilObjEmployeeTalkGUI\editObject(), ilObjFolderGUI\editObject(), ilContainerReferenceGUI\editObject(), ilObjCourseGUI\editObject(), ilExAssignmentEditorGUI\editPeerReviewObject(), ilObjOrgUnitGUI\editSettings(), ilObjectServiceSettingsGUI\editSettings(), ilPCMediaObjectGUI\editStyle(), ilDidacticTemplateSettingsGUI\editTemplate(), ilObjMediaPoolGUI\editTitlesAndDescriptions(), ilECSSettingsGUI\exportMappings(), ilLTIConsumeProviderFormGUI\getContentSelectionFrame(), ilObjLTIConsumerGUI\getCreationFormsHTML(), ilLTIConsumeProviderFormGUI\getDynRegError(), ilLTIConsumeProviderFormGUI\getDynRegRequest(), ilCalendarCategoryGUI\importAppointments(), ilECSSettingsGUI\importMappings(), ilSkillRootGUI\importSkills(), ilPageObjectGUI\initialOpenedContent(), ilStyleCharacteristicGUI\outputTagStyleEditScreen(), assQuestionGUI\renderEditForm(), ilAuthShibbolethSettingsGUI\save(), ilObjLinkResourceGUI\saveAddLink(), ilCertificateGUI\saveCertificate(), ilObjAdvancedEditingGUI\saveGeneralPageSettingsObject(), ilContainerReferenceGUI\saveObject(), ilObjEmployeeTalkSeriesGUI\saveObject(), ilObjGlossaryGUI\saveObject(), ilAuthShibbolethSettingsGUI\settings(), ilDidacticTemplateSettingsGUI\showEditImportForm(), ilMailTemplateGUI\showEditTemplateForm(), ilObjAdvancedEditingGUI\showGeneralPageEditorSettingsObject(), ilMailTemplateGUI\showInsertTemplateFormCommand(), ilMailOptionsGUI\showOptions(), ilCourseObjectivesGUI\showRandomTestAssignment(), ilSamlSettingsGUI\showUserAttributeMappingFormCommand(), ilObjSCORMLearningModuleGUI\trackingImportForm(), ilExtIdGUI\update(), ilObjOrgUnitGUI\updateAdvancedSettings(), ilObjStudyProgrammeGUI\updateAdvancedSettings(), ilObjLinkResourceGUI\updateLink(), and ilObjOrgUnitGUI\updateSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

getHTMLAsync()

ilPropertyFormGUI::getHTMLAsync

(

)

Definition at line 831 of file class.ilPropertyFormGUI.php.

                                  : string
    {
        $html = $this->getHTML();
        if (!$this->ctrl->isAsynch()) {
            $html = $this->appendOnloadCode($html);
        }
        return $html;
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

getInput()

ilPropertyFormGUI::getInput	(	string	$a_post_var,
		bool	$ensureValidation = true
	)

Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-POST variable, identified by the passed postvar.

Parameters

string	$a_post_var	The key used for value determination
bool	$ensureValidation	A flag whether the form input has to be validated before calling this method

Returns

mixed The value of a HTTP-POST variable, identified by the passed id

Definition at line 449 of file class.ilPropertyFormGUI.php.

      {
        // this check ensures, that checkInput has been called (incl. stripSlashes())
        if (!$this->check_input_called && $ensureValidation) {
            throw new LogicException('Error: ilPropertyFormGUI->getInput() called without calling checkInput() first.');
        }
 
        $item = $this->getItemByPostVar($a_post_var);
        if (is_object($item) && method_exists($item, "getInput")) {
            return $item->getInput();
        }
 
        $post = $this->http->request()->getParsedBody();
        return $post[$a_post_var] ?? '';
    }

References $post, and ILIAS\FileDelivery\http().

Referenced by ilSurveyRaterGUI\addExternalRater(), ilSurveyRaterGUI\addRater(), ilAdvancedMDFieldDefinitionSelect\buildConfirmedObjects(), ILIAS\Survey\Settings\SettingsFormGUI\checkForm(), ilAssQuestionSkillAssignmentsGUI\checkPointsAreInt(), ILIAS\User\Settings\SettingsImplementation\checkStartingPointValue(), ilDclBaseFieldModel\checkUniqueProp(), ilDclBaseFieldModel\checkValidityFromForm(), ilDclBooleanFieldModel\checkValidityFromForm(), ilDclTextFieldModel\checkValidityFromForm(), ilPCTabsGUI\checkWidthHeight(), ilObjStyleSheetGUI\copyStyleObject(), ilCmiXapiLP\fetchModeOption(), ilAccessibilityCriterionFormGUI\fillObject(), ilBiblFieldFilterFormGUI\fillObject(), ilOrgUnitAuthorityFormGUI\fillObject(), ilObjOrgUnitSettingsFormGUI\fillObject(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillObject(), ilAccessibilityUserHasLanguageCriterionGUI\getConfigByForm(), ilCourseLPBadgeGUI\getConfigFromForm(), ilDclBaseFieldModel\getConfirmationGUI(), ilLTIConsumeProviderFormGUI\getDynRegRequest(), ILIAS\Survey\Settings\SettingsFormGUI\getTutorIdsFromForm(), ILIAS\Survey\Settings\SettingsFormGUI\getTutorResIdsFromForm(), ilECSObjectSettings\handleSettingsUpdate(), ilAdvancedMDFieldDefinitionFloat\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionGroupBased\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionInteger\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionText\importCustomDefinitionFormPostValues(), ilExcCriteriaText\importCustomForm(), ilAdvancedMDFieldDefinition\importDefinitionFormPostValues(), SurveyMatrixQuestionGUI\importEditFormValues(), SurveyMetricQuestionGUI\importEditFormValues(), SurveyMultipleChoiceQuestionGUI\importEditFormValues(), SurveySingleChoiceQuestionGUI\importEditFormValues(), SurveyTextQuestionGUI\importEditFormValues(), ilExAssTypePortfolioGUI\importFormToAssignment(), ilExAssTypeTextGUI\importFormToAssignment(), ilExAssTypeWikiTeamGUI\importFormToAssignment(), ilObjSCORMLearningModuleGUI\importTracking(), ilAdvancedMDFieldDefinitionSelect\importTranslatedFormPostValues(), ilLTIConsumerSettingsFormGUI\initObject(), ilLTIConsumeProviderFormGUI\initProvider(), ilMailTemplateGUI\insertTemplateCommand(), ilContainerReferenceGUI\loadPropertiesFromSettingsForm(), ilObjCourseReferenceGUI\loadPropertiesFromSettingsForm(), ilAdvancedMDSettingsGUI\loadRecordFormData(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), ilAdvancedMDFieldDefinition\prepareDefinitionFormConfirmation(), ilExAssignmentEditorGUI\processForm(), ilConsultationHoursGUI\rewriteBookingIdsForAppointments(), ilCalendarCategoryGUI\save(), ilCourseObjectivesGUI\save(), ilMailOptionsFormGUI\save(), ilPCMediaObjectGUI\saveAliasProperties(), ilCertificateGUI\saveCertificate(), ilObjCourseAdministrationGUI\saveChildSettings(), assErrorTextGUI\saveCorrectionsFormProperties(), assFileUploadGUI\saveCorrectionsFormProperties(), assKprimChoiceGUI\saveCorrectionsFormProperties(), assLongMenuGUI\saveCorrectionsFormProperties(), assNumericGUI\saveCorrectionsFormProperties(), assOrderingHorizontalGUI\saveCorrectionsFormProperties(), assOrderingQuestionGUI\saveCorrectionsFormProperties(), ilMemberAgreementGUI\saveCourseDefinedFields(), ilConsultationHourCron\saveCustomSettings(), ilCleanCOPageHistoryCronjob\saveCustomSettings(), ilForumCronNotification\saveCustomSettings(), ilLoggerCronCleanErrorFiles\saveCustomSettings(), ilMailCronOrphanedMails\saveCustomSettings(), ilCronOerHarvester\saveCustomSettings(), ilSCCronTrash\saveCustomSettings(), ILIAS\Survey\Settings\SettingsFormGUI\saveForm(), ilObjAdvancedEditingGUI\saveGeneralPageSettingsObject(), ilAssQuestionFeedback\saveGenericFormProperties(), ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\SelfRegistration\saveLegacyForm(), ilObjLinkResourceGUI\saveLinkList(), ilContainerGUI\saveListPresentation(), ilObjContentObjectGUI\saveMenuEntry(), ilObjContentObjectGUI\saveMenuProperties(), assClozeTestGUI\saveNumericGapCorrectionFormProperty(), ilBiblLibraryFormGUI\saveObject(), ilContainerReferenceGUI\saveObject(), ilObjEmployeeTalkSeriesGUI\saveObject(), ilObjGlossaryGUI\saveObject(), ilObjStyleSheetGUI\saveObject(), ILIAS\MediaObjects\Video\GUIService\savePreviewInput(), ilObjContentObjectGUI\saveProperties(), ilCourseObjectivesGUI\saveRandom(), ilCmiXapiRegistrationGUI\saveRegistration(), ilLTIProviderObjectSettingGUI\saveRoleSelection(), ILIAS\Blog\ReadingTime\BlogSettingsGUI\saveSettingFromForm(), ILIAS\LearningModule\ReadingTime\SettingsGUI\saveSettingFromForm(), ilMembershipAdministrationGUI\saveSettings(), ilCmiXapiSettingsGUI\saveSettings(), ilContainerGUI\saveSortingSettings(), ilAssConfigurableMultiOptionQuestionFeedback\saveSpecificFormProperties(), ilAssMultiOptionQuestionFeedback\saveSpecificFormProperties(), ilStyleCharacteristicGUI\saveTagStyle(), ilObjMediaPoolGUI\saveTitlesAndDescriptions(), ilSamlSettingsGUI\saveUserAttributeMappingCommand(), ilDclBaseRecordFieldModel\setValueFromForm(), ilDclCopyRecordFieldModel\setValueFromForm(), ilDclTextRecordFieldModel\setValueFromForm(), ilPCSectionGUI\setValuesFromForm(), ilDclBaseFieldModel\storePropertiesFromForm(), ilCalendarCategoryGUI\update(), ilObjExerciseGUI\updateCustom(), ilObjContentPageGUI\updateCustom(), ilObjTalkTemplateGUI\updateCustom(), ilObjItemGroupGUI\updateCustom(), ilObjPollGUI\updateCustom(), ilObjPortfolioBaseGUI\updateCustom(), ilObjPortfolioGUI\updateCustom(), ilObjPortfolioTemplateGUI\updateCustom(), ilForumSettingsGUI\updateCustomValues(), ilAdvancedMDFieldTranslations\updateFromForm(), ilObjCourseGUI\updateInfoObject(), ilObjLinkResourceGUI\updateLink(), ilObjContentObjectGUI\updateMenuEntry(), ilObjCourseGUI\updateObject(), ilObjEmployeeTalkGUI\updateObject(), ilObjGroupGUI\updateObject(), ilObjStudyProgrammeReferenceGUI\updateObject(), ilObjectServiceSettingsGUI\updateServiceSettingsForm(), ilDidacticTemplateSettingsGUI\updateTemplate(), ilMailTemplateGUI\updateTemplateCommand(), ilObjOrgUnitSettingsFormGUI\updateTranslation(), ilCalendarCategoryGUI\uploadAppointments(), ilObjEmployeeTalkGUI\validateCustom(), ilObjPollGUI\validateCustom(), SurveyMultipleChoiceQuestionGUI\validateEditForm(), ilCourseLPBadgeGUI\validateForm(), and assLongMenuGUI\writeQuestionSpecificPostData().

Here is the call graph for this function:

Here is the caller graph for this function:

getInputItemsRecursive()

ilPropertyFormGUI::getInputItemsRecursive

(

)

returns a flat array of all input items including the possibly existing subitems recursively

Definition at line 280 of file class.ilPropertyFormGUI.php.

                                            : array
    {
        $inputItems = array();
 
        foreach ($this->items as $item) {
            if ($item->getType() == 'section_header') {
                continue;
            }
 
            $inputItems[] = $item;
 
            if ($item instanceof ilSubEnabledFormPropertyGUI) {
                $inputItems = array_merge($inputItems, $item->getSubInputItemsRecursive());
            }
        }
 
        return $inputItems;
    }

Referenced by ilTestSettingsChangeConfirmationGUI\populateParametersFromPropertyForm().

Here is the caller graph for this function:

getItemByPostVar()

ilPropertyFormGUI::getItemByPostVar

(

string

$a_post_var

)

Definition at line 251 of file class.ilPropertyFormGUI.php.

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

References ilFormPropertyGUI\getItemByPostVar().

Referenced by assMultipleChoiceGUI\addBasicQuestionFormProperties(), ilCronDeleteInactiveUserAccounts\addCustomSettingsToForm(), ilTestRandomQuestionSetPoolDefinitionFormGUI\applySubmit(), ILIAS\Survey\Settings\SettingsFormGUI\checkForm(), ilPCSectionGUI\checkInput(), ilDclBaseFieldModel\checkUniqueProp(), ilPCTabsGUI\checkWidthHeight(), ilObjUserFolderGUI\confirmaccessRestrictObject(), executeCommand(), ilExcCriteriaText\exportCustomForm(), assOrderingQuestionGUI\fetchSolutionListFromSubmittedForm(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillForm(), ilStudyProgrammeTypeCustomIconsFormGUI\fillForm(), ilDclBaseRecordRepresentation\fillFormInput(), ilDclTextRecordRepresentation\fillFormInput(), ilAccessibilityCriterionFormGUI\fillObject(), ilDclBaseRecordModel\fillStandardFieldFormInput(), ILIAS\Test\Settings\TestSettingsGUI\formPropertyExists(), ilExAssignmentEditorGUI\getAssignmentValues(), ilLTIConsumeProviderFormGUI\getDynRegRequest(), ilAssOrderingQuestionAuthoringFormGUI\getOrderingElementInputField(), ilStyleCharacteristicGUI\getValues(), ilNewsItemGUI\getValuesNewsItem(), ilExAssignmentEditorGUI\handleDisabledFields(), ilExAssignmentEditorGUI\handleDisabledPeerFields(), ilCourseLPBadgeGUI\importConfigToForm(), ilObjContentPageGUI\initEditCustomForm(), ilAssClozeTestFeedback\initFbPropsForNumericGap(), ilAssClozeTestFeedback\initFbPropsForSelectGap(), ilAssClozeTestFeedback\initFbPropsForTextGap(), ilAssClozeTestFeedback\initFeedbackFieldsPerGapQuestion(), ilAssQuestionFeedback\initGenericFormProperties(), ilLTIConsumeProviderFormGUI\initProvider(), ilAssClozeTestFeedback\initSpecificFormProperties(), ilAssConfigurableMultiOptionQuestionFeedback\initSpecificFormProperties(), ilAssMultiOptionQuestionFeedback\initSpecificFormProperties(), ilMailTemplateGUI\insertTemplateCommand(), assMatchingQuestionGUI\isValidTermAndDefinitionAmount(), ilContainerReferenceGUI\loadPropertiesFromSettingsForm(), ilObjCourseReferenceGUI\loadPropertiesFromSettingsForm(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation(), ilAdvancedMDFieldDefinition\prepareDefinitionFormConfirmation(), assOrderingQuestionGUI\prepareReprintableCorrectionsForm(), ilExAssignmentEditorGUI\processForm(), ilAssOrderingQuestionAuthoringFormGUI\renewOrderingElementInput(), ilMailOptionsFormGUI\save(), ilTestRandomQuestionSetGeneralConfigFormGUI\save(), assImagemapQuestionGUI\saveCorrectionsFormProperties(), assKprimChoiceGUI\saveCorrectionsFormProperties(), assMultipleChoiceGUI\saveCorrectionsFormProperties(), assSingleChoiceGUI\saveCorrectionsFormProperties(), assTextSubsetGUI\saveCorrectionsFormProperties(), ilCronDeleteInactiveUserAccounts\saveCustomSettings(), ilCronDeleteNeverLoggedInUserAccounts\saveCustomSettings(), ilAssClozeTestFeedback\saveFbPropsForNumericGap(), ilAssClozeTestFeedback\saveFbPropsForSelectGap(), ilAssClozeTestFeedback\saveFbPropsForTextGap(), ilAssClozeTestFeedback\saveFeedbackFieldsPerGapQuestion(), ILIAS\Survey\Settings\SettingsFormGUI\saveForm(), assClozeTestGUI\saveGapCombinationCorrectionFormProperties(), ilObjAdvancedEditingGUI\saveGeneralPageSettingsObject(), ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\SelfRegistration\saveLegacyForm(), ilAccessibilityCriterionFormGUI\saveObject(), ilObjEmployeeTalkSeriesGUI\saveObject(), ILIAS\MediaObjects\Video\GUIService\savePreviewInput(), ilAssClozeTestFeedback\saveSpecificFormProperties(), ilStyleCharacteristicGUI\saveTagStyle(), assClozeTestGUI\saveTextOrSelectGapCorrectionFormProperty(), ilBadgeManagementGUI\setBadgeFormValues(), ilExAssignmentEditorGUI\setDisabledFieldValues(), ilExAssignmentEditorGUI\setDisabledPeerReviewFieldValues(), ilSessionMembershipRegistrationSettingsGUI\setFormValues(), ilObjBadgeAdministrationGUI\setImageTemplateFormValues(), ilDclBaseRecordModel\setStandardFieldFromForm(), ilDclFileRecordFieldModel\setValueFromForm(), ilPCSectionGUI\setValuesFromForm(), ilExtIdGUI\update(), ilObjPollGUI\updateCustom(), ilObjPortfolioTemplateGUI\updateCustom(), ilObjCourseGUI\updateInfoObject(), ilObjCourseGUI\updateObject(), ilObjGroupGUI\updateObject(), ilDidacticTemplateSettingsGUI\updateTemplate(), ilMailTemplateGUI\updateTemplateCommand(), ILIAS\User\Profile\Fields\Standard\Avatar\uploadUserPicture(), ilObjPollGUI\validateCustom(), SurveyMultipleChoiceQuestionGUI\validateEditForm(), ilCourseLPBadgeGUI\validateForm(), assImagemapQuestionGUI\writeAnswerSpecificPostData(), assKprimChoiceGUI\writeAnswerSpecificPostData(), assKprimChoiceGUI\writeQuestionSpecificPostData(), and assMultipleChoiceGUI\writeQuestionSpecificPostData().

Here is the call graph for this function:

Here is the caller graph for this function:

getItems()

ilPropertyFormGUI::getItems

(

)

Definition at line 271 of file class.ilPropertyFormGUI.php.

                              : array
    {
        return $this->items;
    }

Referenced by ilUserFormSettings\importFromForm(), and ilAssQuestionAuthoringFormGUI\replaceFormItemByPostVar().

Here is the caller graph for this function:

getMode()

ilPropertyFormGUI::getMode

(

)

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

                             : string
    {
        return $this->mode;
    }

References $mode.

getRequestedPostVar()

ilPropertyFormGUI::getRequestedPostVar ( )

protected

Definition at line 117 of file class.ilPropertyFormGUI.php.

                                            : ?string
    {
        $t = $this->refinery->kindlyTo()->string();
        $w = $this->http->wrapper();
        if ($w->post()->has("postvar")) {
            return $w->post()->retrieve("postvar", $t);
        }
        if ($w->query()->has("postvar")) {
            return $w->query()->retrieve("postvar", $t);
        }
        return null;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

getShowTopButtons()

ilPropertyFormGUI::getShowTopButtons

(

)

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

                                       : bool
    {
        return $this->show_top_buttons;
    }

References $show_top_buttons.

getTableWidth()

ilPropertyFormGUI::getTableWidth ( )

final

Definition at line 135 of file class.ilPropertyFormGUI.php.

                                         : string
    {
        return $this->tbl_width;
    }

References $tbl_width.

getTitle()

ilPropertyFormGUI::getTitle

(

)

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

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by ilObjLTIConsumerGUI\getCreationFormsHTML().

Here is the caller graph for this function:

getTitleIcon()

ilPropertyFormGUI::getTitleIcon

(

)

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

                                  : string
    {
        return $this->titleicon;
    }

References $titleicon.

getTopAnchor()

ilPropertyFormGUI::getTopAnchor

(

)

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

                                  : string
    {
        return $this->top_anchor;
    }

References $top_anchor.

hasFileUpload()

ilPropertyFormGUI::hasFileUpload	(	string	$a_field,
		?string	$a_index = null,
		?string	$a_sub_index = null
	)

Definition at line 960 of file class.ilPropertyFormGUI.php.

     : bool {
        $data = $this->getFileUpload($a_field, $a_index, $a_sub_index);
        return (bool) ($data["tmp_name"] ?? false);
    }

hideRequired()

ilPropertyFormGUI::hideRequired ( string  $a_type )

protected

Definition at line 624 of file class.ilPropertyFormGUI.php.

                                                   : bool
    {
        // #15818
        return $a_type == "non_editable_value";
    }

insertItem()

ilPropertyFormGUI::insertItem	(		$item,
		bool	$a_sub_item = false
	)

Parameters

ilFormPropertyGUI | ilFormSectionHeaderGUI

$item

Definition at line 633 of file class.ilPropertyFormGUI.php.

     : void {
        global $DIC;
        $tpl = $DIC["tpl"];
        $lng = $this->lng;
 
 
        //$cfg = array();
 
        //if(method_exists($item, "getMulti") && $item->getMulti())
        if ($item instanceof ilMultiValuesItem && $item->getMulti()) {
            $tpl->addJavascript("assets/js/ServiceFormMulti.js");
 
            $this->tpl->setCurrentBlock("multi_in");
            $this->tpl->setVariable("ID", $item->getFieldId());
            $this->tpl->parseCurrentBlock();
 
            $this->tpl->touchBlock("multi_out");
 
 
            // add hidden item to enable preset multi items
            // not used yet, should replace hidden field stuff
            $multi_values = $item->getMultiValues();
            if (is_array($multi_values) && sizeof($multi_values) > 1) {
                $multi_value = new ilHiddenInputGUI("ilMultiValues~" . $item->getPostVar());
                $multi_value->setValue(base64_encode(json_encode($multi_values)));
                $this->addItem($multi_value);
            }
            //$cfg["multi_values"] = $multi_values;
        }
 
        $item->insert($this->tpl);
 
        if ($item->getType() == "file" || $item->getType() == "image_file") {
            $this->setMultipart(true);
        }
 
        if ($item->getType() != "section_header") {
            //$cfg["id"] = $item->getFieldId();
 
            // info text
            if ($item->getInfo() != "") {
                $this->tpl->setCurrentBlock("description");
                $this->tpl->setVariable(
                    "PROPERTY_DESCRIPTION",
                    $item->getInfo()
                );
                $this->tpl->setVariable(
                    "DESCRIPTION_FOR_ID",
                    $item->getFieldId()
                );
                $this->tpl->parseCurrentBlock();
            }
 
            if ($this->getMode() == "subform") {
                // required
                if (!$this->hideRequired($item->getType())) {
                    if ($item->getRequired()) {
                        $this->tpl->touchBlock("sub_required");
                        $this->required_text = true;
                    }
                }
 
                // hidden title (for accessibility, e.g. file upload)
                if ($item->getHiddenTitle() != "") {
                    $this->tpl->setCurrentBlock("sub_hid_title");
                    $this->tpl->setVariable(
                        "SPHID_TITLE",
                        $item->getHiddenTitle()
                    );
                    $this->tpl->parseCurrentBlock();
                }
 
                $this->tpl->setCurrentBlock("sub_prop_start");
                $this->tpl->setVariable("PROPERTY_TITLE", $item->getTitle());
                $this->tpl->setVariable("PROPERTY_CLASS", "il_" . $item->getType());
                if ($item->getType() != "non_editable_value" && $item->getFormLabelFor() != "") {
                    $this->tpl->setVariable("FOR_ID", ' for="' . $item->getFormLabelFor() . '" ');
                }
                $this->tpl->setVariable("LAB_ID", $item->getFieldId());
            } else {
                // required
                if (!$this->hideRequired($item->getType())) {
                    if ($item->getRequired()) {
                        $this->tpl->touchBlock("required");
                        $this->required_text = true;
                    }
                }
 
                // hidden title (for accessibility, e.g. file upload)
                if ($item->getHiddenTitle() != "") {
                    $this->tpl->setCurrentBlock("std_hid_title");
                    $this->tpl->setVariable(
                        "PHID_TITLE",
                        $item->getHiddenTitle()
                    );
                    $this->tpl->parseCurrentBlock();
                }
 
                $this->tpl->setCurrentBlock("std_prop_start");
                $this->tpl->setVariable("PROPERTY_TITLE", $item->getTitle());
                if ($item->getType() != "non_editable_value" && $item->getFormLabelFor() != "") {
                    $this->tpl->setVariable("FOR_ID", ' for="' . $item->getFormLabelFor() . '" ');
                }
                $this->tpl->setVariable("LAB_ID", $item->getFieldId());
                if ($this->getHideLabels()) {
                    $this->tpl->setVariable("HIDE_LABELS_STYLE", " ilFormOptionHidden");
                }
            }
            $this->tpl->parseCurrentBlock();
 
            // alert
            if ($item->getType() != "non_editable_value" && $item->getAlert() != "") {
                $this->tpl->setCurrentBlock("alert");
                $this->tpl->setVariable(
                    "IMG_ALERT",
                    ilUtil::getImagePath("standard/icon_alert.svg")
                );
                $this->tpl->setVariable(
                    "ALT_ALERT",
                    $lng->txt("alert")
                );
                $this->tpl->setVariable(
                    "TXT_ALERT",
                    $item->getAlert()
                );
                $this->tpl->setVariable(
                    "ALERT_FOR_ID",
                    $item->getFieldId()
                );
                $this->tpl->parseCurrentBlock();
            }
 
            // subitems
            $sf = null;
            if ($item->getType() != "non_editable_value" or 1) {
                $sf = $item->getSubForm();
                if ($item->hideSubForm() && is_object($sf)) {
                    if ($this->global_tpl) {
                        $dsfid = $item->getFieldId();
                        $this->global_tpl->addOnloadCode(
                            "il.Form.hideSubForm('subform_$dsfid');"
                        );
                    }
                    $this->addAsyncOnloadCode("il.Form.hideSubForm('subform_$dsfid');");
                }
            }
 
            $sf_content = "";
            if (is_object($sf)) {
                $sf_content = $sf->getContent();
                if ($sf->getMultipart()) {
                    $this->setMultipart(true);
                }
                $this->tpl->setCurrentBlock("sub_form");
                $this->tpl->setVariable("PROP_SUB_FORM", $sf_content);
                $this->tpl->setVariable("SFID", $item->getFieldId());
                $this->tpl->parseCurrentBlock();
            }
 
            $this->tpl->setCurrentBlock("prop");
            /* not used yet
            $this->tpl->setVariable("ID", $item->getFieldId());
            $this->tpl->setVariable("CFG", json_encode($cfg, JSON_THROW_ON_ERROR));*/
            $this->tpl->parseCurrentBlock();
        }
 
 
        $this->tpl->touchBlock("item");
    }

References ilTemplate\setCurrentBlock().

Here is the call graph for this function:

moveFileUpload()

ilPropertyFormGUI::moveFileUpload	(	string	$a_target_directory,
		string	$a_field,
		?string	$a_target_name = null,
		?string	$a_index = null,
		?string	$a_sub_index = null
	)

Move upload to target directory.

Parameters

string	$a_target_directory	target directory (without filename!)
string	$a_field	form field
	?string	$a_target_name target file name (if different from uploaded file)
	?string	$a_index form field index (if array)
	?string	$a_sub_index form field subindex (if array)

Returns

string target file name incl. path

Exceptions

ilException

Definition at line 980 of file class.ilPropertyFormGUI.php.

     : string {
        if (!is_dir($a_target_directory)) {
            return "";
        }
 
        $data = $this->getFileUpload($a_field, $a_index, $a_sub_index);
        if ($data["tmp_name"] && file_exists($data["tmp_name"])) {
            if ($a_target_name) {
                $data["name"] = $a_target_name;
            }
 
            $target_file = $a_target_directory . "/" . $data["name"];
            $target_file = str_replace("//", "/", $target_file);
 
            if ($data["is_upload"]) {
                if (!ilFileUtils::moveUploadedFile($data["tmp_name"], $data["name"], $target_file)) {
                    return "";
                }
            } else {
                if (!ilFileUtils::rename($data["tmp_name"], $target_file)) {
                    return "";
                }
            }
 
            return $target_file;
        }
        return "";
    }

rebuildUploadedFiles()

ilPropertyFormGUI::rebuildUploadedFiles ( )

protected

Definition at line 1015 of file class.ilPropertyFormGUI.php.

                                             : void
    {
        $file_hash = (string) $this->getFileHash();
        if ($file_hash != "") {
            $temp_path = ilFileUtils::getDataDir() . "/temp";
            if (is_dir($temp_path)) {
                $temp_files = glob($temp_path . "/" . session_id() . "~~" . $file_hash . "~~*");
                if (is_array($temp_files)) {
                    foreach ($temp_files as $full_file) {
                        $file = explode("~~", basename($full_file));
                        $field = $file[2];
                        $idx = $file[3];
                        $idx2 = $file[4];
                        $type = $file[5] . "/" . $file[6];
                        $name = $file[7];
 
                        if ($idx2 != "") {
                            if (!isset($_FILES[$field]["tmp_name"][$idx][$idx2])) {
                                $_FILES[$field]["tmp_name"][$idx][$idx2] = $full_file;
                                $_FILES[$field]["name"][$idx][$idx2] = $name;
                                $_FILES[$field]["type"][$idx][$idx2] = $type;
                                $_FILES[$field]["error"][$idx][$idx2] = 0;
                                $_FILES[$field]["size"][$idx][$idx2] = filesize($full_file);
                                $_FILES[$field]["is_upload"][$idx][$idx2] = false;
                            }
                        } elseif ($idx != "") {
                            if (!isset($_FILES[$field]["tmp_name"][$idx])) {
                                $_FILES[$field]["tmp_name"][$idx] = $full_file;
                                $_FILES[$field]["name"][$idx] = $name;
                                $_FILES[$field]["type"][$idx] = $type;
                                $_FILES[$field]["error"][$idx] = 0;
                                $_FILES[$field]["size"][$idx] = filesize($full_file);
                                $_FILES[$field]["is_upload"][$idx] = false;
                            }
                        } else {
                            if (!isset($_FILES[$field]["tmp_name"])) {
                                $_FILES[$field]["tmp_name"] = $full_file;
                                $_FILES[$field]["name"] = $name;
                                $_FILES[$field]["type"] = $type;
                                $_FILES[$field]["error"] = 0;
                                $_FILES[$field]["size"] = filesize($full_file);
                                $_FILES[$field]["is_upload"] = false;
                            }
                        }
                    }
                }
            }
        }
    }

References ilFileUtils\getDataDir().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

removeItemByPostVar()

ilPropertyFormGUI::removeItemByPostVar	(	string	$a_post_var,
		bool	$a_remove_unused_headers = false
	)

Definition at line 220 of file class.ilPropertyFormGUI.php.

     : void {
        foreach ($this->items as $key => $item) {
            if (method_exists($item, "getPostVar") && $item->getPostVar() == $a_post_var) {
                unset($this->items[$key]);
            }
        }
 
        // remove section headers if they do not contain any items anymore
        if ($a_remove_unused_headers) {
            $unset_keys = array();
            $last_item = null;
            $last_key = null;
            foreach ($this->items as $key => $item) {
                if ($item instanceof ilFormSectionHeaderGUI && $last_item instanceof ilFormSectionHeaderGUI) {
                    $unset_keys[] = $last_key;
                }
                $last_item = $item;
                $last_key = $key;
            }
            if ($last_item instanceof ilFormSectionHeaderGUI) {
                $unset_keys[] = $last_key;
            }
            foreach ($unset_keys as $key) {
                unset($this->items[$key]);
            }
        }
    }

Referenced by ilLTIConsumeProviderFormGUI\getDynRegError(), ilObjItemGroupGUI\initEditCustomForm(), and assTextQuestionGUI\populateCorrectionsFormProperties().

Here is the caller graph for this function:

setDescription()

ilPropertyFormGUI::setDescription

(

string

$a_val

)

Definition at line 171 of file class.ilPropertyFormGUI.php.

                                                 : void
    {
        $this->description = $a_val;
    }

setDisableStandardMessage()

ilPropertyFormGUI::setDisableStandardMessage

(

bool

$a_val

)

Definition at line 299 of file class.ilPropertyFormGUI.php.

                                                          : void
    {
        $this->disable_standard_message = $a_val;
    }

setForceTopButtons()

ilPropertyFormGUI::setForceTopButtons

(

bool

$a_val

)

Definition at line 201 of file class.ilPropertyFormGUI.php.

                                                   : void
    {
        $this->force_top_buttons = $a_val;
    }

setHideLabels()

ilPropertyFormGUI::setHideLabels

(

bool

$a_value = true

)

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

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

setItems()

ilPropertyFormGUI::setItems

(

array

$a_items

)

Definition at line 266 of file class.ilPropertyFormGUI.php.

                                            : void
    {
        $this->items = $a_items;
    }

Referenced by ilAssQuestionAuthoringFormGUI\replaceFormItemByPostVar().

Here is the caller graph for this function:

setMode()

ilPropertyFormGUI::setMode

(

string

$a_mode

)

Definition at line 141 of file class.ilPropertyFormGUI.php.

                                           : void
    {
        $this->mode = $a_mode;
    }

setShowTopButtons()

ilPropertyFormGUI::setShowTopButtons

(

bool

$a_val

)

Definition at line 191 of file class.ilPropertyFormGUI.php.

                                                  : void
    {
        $this->show_top_buttons = $a_val;
    }

Referenced by ilDidacticTemplateSettingsGUI\editImportForm(), and ilDidacticTemplateSettingsGUI\initEditTemplate().

Here is the caller graph for this function:

setTableWidth()

ilPropertyFormGUI::setTableWidth ( string  $a_width )

final

Definition at line 130 of file class.ilPropertyFormGUI.php.

                                                        : void
    {
        $this->tbl_width = $a_width;
    }

Referenced by assMultipleChoiceGUI\buildEditForm(), ilForumThreadFormGUI\generateInputItems(), and ilObjGroupGUI\initForm().

Here is the caller graph for this function:

setTitle()

ilPropertyFormGUI::setTitle

(

string

$a_title

)

Definition at line 151 of file class.ilPropertyFormGUI.php.

                                             : void
    {
        $this->title = $a_title;
    }

Referenced by FormMailCodesGUI\__construct(), ilLTIConsumerProviderSelectionFormTableGUI\__construct(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), assMultipleChoiceGUI\buildEditForm(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellStyle(), ilDidacticTemplateSettingsGUI\editImportForm(), ilObjCourseGUI\editMapSettingsObject(), ilObjGroupGUI\editMapSettingsObject(), ilPCMediaObjectGUI\editStyle(), ilForumThreadFormGUI\generateInputItems(), ilObjStyleSheetGUI\getCloneForm(), ilLTIConsumeProviderFormGUI\getContentSelectionFrame(), ilObjStyleSheetGUI\getCreateForm(), ilForumSettingsGUI\getCustomForm(), ilLTIConsumeProviderFormGUI\getDynRegError(), ilObjStyleSheetGUI\getImportForm(), ilMailTemplateGUI\getTemplateForm(), ilMailOptionsFormGUI\init(), ILIAS\components\OrgUnit\ARHelper\BaseForm\initButtons(), ilOrgUnitPositionFormGUI\initButtons(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreateForm(), ilLTIConsumeProviderFormGUI\initDynRegForm(), ilObjCourseGUI\initEditForm(), ilObjFolderGUI\initEditForm(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilAccessibilityDocumentFormGUI\initForm(), ilBiblLibraryFormGUI\initForm(), ilBiblFieldFilterFormGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilWebDAVMountInstructionsDocumentFormGUI\initForm(), ilContainerReferenceGUI\initForm(), ilObjGroupGUI\initForm(), ilLTIConsumeProviderFormGUI\initForm(), ilLTIConsumerSettingsFormGUI\initForm(), ilCourseObjectivesGUI\initFormRandom(), ilMembershipAdministrationGUI\initFormSettings(), ilObjAdvancedEditingGUI\initGeneralPageSettingsForm(), ilCalendarCategoryGUI\initImportForm(), ilObjCourseGUI\initInfoEditor(), ilObjGroupGUI\initInfoEditor(), ilSkillRootGUI\initInputForm(), ilECSSettingsGUI\initMappingsForm(), ilObjectCustomUserFieldsGUI\initMemberForm(), ilObjContentObjectGUI\initMenuEntryForm(), ilObjContentObjectGUI\initMenuForm(), ilPageObjectGUI\initOpenedContentForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), ilObjSCORMLearningModuleGUI\initTrackingImportForm(), and ilObjContentObjectGUI\saveProperties().

Here is the caller graph for this function:

setTitleIcon()

ilPropertyFormGUI::setTitleIcon

(

string

$a_titleicon

)

Definition at line 161 of file class.ilPropertyFormGUI.php.

                                                     : void
    {
        $this->titleicon = $a_titleicon;
    }

Referenced by ilForumThreadFormGUI\generateInputItems(), and ilObjGroupGUI\initForm().

Here is the caller graph for this function:

setTopAnchor()

ilPropertyFormGUI::setTopAnchor

(

string

$a_val

)

Definition at line 181 of file class.ilPropertyFormGUI.php.

                                               : void
    {
        $this->top_anchor = $a_val;
    }

setValuesByArray()

ilPropertyFormGUI::setValuesByArray	(	array	$a_values,
		bool	$a_restrict_to_value_keys = false
	)

Definition at line 320 of file class.ilPropertyFormGUI.php.

     : void {
        foreach ($this->items as $item) {
            if (!($a_restrict_to_value_keys) ||
                in_array($item->getPostVar(), array_keys($a_values))) {
                $item->setValueByArray($a_values);
            }
        }
    }

Referenced by ilChatroomFormFactory\applyValues(), ilObjEmployeeTalkGUI\editObject(), ilObjFolderGUI\editObject(), ilBiblLibraryFormGUI\fillForm(), ilBiblFieldFilterFormGUI\fillForm(), ilOrgUnitAuthorityFormGUI\fillForm(), ilOrgUnitPositionFormGUI\fillForm(), ilDclBaseFieldModel\fillPropertiesForm(), ilExAssignmentEditorGUI\getAssignmentValues(), ilMediaPoolPageGUI\getMediaPoolPageValues(), ilExAssignmentEditorGUI\getPeerReviewValues(), ilNewsItemGUI\getValuesNewsItem(), ilRegistrationSettingsGUI\initFormValues(), ilMailOptionsFormGUI\populate(), ilObjMailGUI\populateExternalSettingsForm(), ilMailTemplateGUI\populateFormWithTemplate(), ilObjMailGUI\populateGeneralSettingsForm(), ilObjWikiSettingsGUI\populateWithCurrentSettings(), and ilSamlSettingsGUI\showUserAttributeMappingFormCommand().

Here is the caller graph for this function:

setValuesByPost()

ilPropertyFormGUI::setValuesByPost

(

)

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

    {
        global $DIC;
 
        if (!isset($DIC["http"])) {
            return null;
        }
 
        foreach ($this->items as $item) {
            $item->setValueByArray($DIC->http()->request()->getParsedBody());
        }
    }

References $DIC.

Referenced by ilDidacticTemplateSettingsGUI\checkInput(), ilObjOrgUnitSettingsFormGUI\fillObject(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillObject(), ilDidacticTemplateSettingsGUI\handleUpdateFailure(), ilSkillRootGUI\importSkills(), ilObjSCORMLearningModuleGUI\importTracking(), ilMailTemplateGUI\insertTemplateCommand(), ilRegistrationGUI\join(), ilAuthShibbolethSettingsGUI\save(), ilCalendarCategoryGUI\save(), ilCourseObjectivesGUI\save(), ilMemberAgreementGUI\save(), ilCertificateGUI\saveCertificate(), ilObjAdvancedEditingGUI\saveGeneralPageSettingsObject(), ilObjLinkResourceGUI\saveLinkList(), ilObjectCustomUserFieldsGUI\saveMember(), ilObjContentObjectGUI\saveMenuEntry(), ilAccessibilityCriterionFormGUI\saveObject(), ilAccessibilityDocumentFormGUI\saveObject(), ilContainerReferenceGUI\saveObject(), ilObjEmployeeTalkSeriesGUI\saveObject(), ilObjGlossaryGUI\saveObject(), ilWebDAVMountInstructionsDocumentFormGUI\saveObject(), ilCourseObjectivesGUI\saveRandom(), ilMembershipAdministrationGUI\saveSettings(), ilSamlSettingsGUI\saveUserAttributeMappingCommand(), ilMailOptionsGUI\showOptions(), ilCalendarCategoryGUI\update(), ilExtIdGUI\update(), ilObjCourseGUI\updateInfoObject(), ilObjLinkResourceGUI\updateLink(), ilObjContentObjectGUI\updateMenuEntry(), ilContainerReferenceGUI\updateObject(), ilObjCourseGUI\updateObject(), ilObjEmployeeTalkGUI\updateObject(), ilObjGroupGUI\updateObject(), ilWebDAVMountInstructionsDocumentFormGUI\updateObject(), and ilMailTemplateGUI\updateTemplateCommand().

Here is the caller graph for this function:

Field Documentation

$buttons

array ilPropertyFormGUI::$buttons = array()

private

Definition at line 40 of file class.ilPropertyFormGUI.php.

$check_input_called

bool ilPropertyFormGUI::$check_input_called = false

protected

Definition at line 43 of file class.ilPropertyFormGUI.php.

$ctrl

ilCtrl ilPropertyFormGUI::$ctrl

protected

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

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\__construct(), ilTestRandomQuestionSetPoolDefinitionFormGUI\__construct(), executeCommand(), and ilSCORM2004TrackingItemsPerScoFilterGUI\parse().

$description

string ilPropertyFormGUI::$description = ""

protected

Definition at line 48 of file class.ilPropertyFormGUI.php.

Referenced by getDescription().

$disable_standard_message

bool ilPropertyFormGUI::$disable_standard_message = false

protected

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

$force_top_buttons

bool ilPropertyFormGUI::$force_top_buttons = false

protected

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

Referenced by getForceTopButtons().

$global_tpl

ilGlobalTemplateInterface ilPropertyFormGUI::$global_tpl = null

protected

Definition at line 56 of file class.ilPropertyFormGUI.php.

$hide_labels

bool ilPropertyFormGUI::$hide_labels = false

protected

Definition at line 51 of file class.ilPropertyFormGUI.php.

$http

HTTP Services ilPropertyFormGUI::$http

protected

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

$items

array ilPropertyFormGUI::$items = array()

private

Definition at line 41 of file class.ilPropertyFormGUI.php.

$kept_uploads

array ilPropertyFormGUI::$kept_uploads = []

private

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

$lng

ilLanguage ilPropertyFormGUI::$lng

protected

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

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\__construct(), __construct(), ilTestRandomQuestionSetPoolDefinitionFormGUI\__construct(), ilObjOrgUnitSettingsFormGUI\__construct(), FormMailCodesGUI\__construct(), ilLTIConsumeProviderFormGUI\getContentSelectionFrame(), ilLTIConsumeProviderFormGUI\getDynRegError(), ilLTIConsumeProviderFormGUI\getDynRegRequest(), ilLTIConsumeProviderFormGUI\initDynRegForm(), ilWebDAVMountInstructionsDocumentFormGUI\initForm(), ilLTIConsumeProviderFormGUI\initForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), ilSCORM2004TrackingItemsPerScoFilterGUI\parse(), ilSCORMTrackingItemsPerScoFilterGUI\parse(), ilSCORM2004TrackingItemsPerUserFilterGUI\parse(), and ilSCORMTrackingItemsPerUserFilterGUI\parse().

$mode

string ilPropertyFormGUI::$mode = "std"

protected

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

Referenced by getMode().

$onload_code

ilPropertyFormGUI::$onload_code = []

protected

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

$refinery

Refinery Factory ilPropertyFormGUI::$refinery = null

protected

Definition at line 54 of file class.ilPropertyFormGUI.php.

$required_text

bool ilPropertyFormGUI::$required_text = false

protected

Definition at line 34 of file class.ilPropertyFormGUI.php.

$settings

ilSetting ilPropertyFormGUI::$settings = null

protected

Definition at line 39 of file class.ilPropertyFormGUI.php.

Referenced by FormMailCodesGUI\__construct().

$show_top_buttons

bool ilPropertyFormGUI::$show_top_buttons = true

protected

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

Referenced by getShowTopButtons().

$tbl_width

string ilPropertyFormGUI::$tbl_width = ""

protected

Definition at line 49 of file class.ilPropertyFormGUI.php.

Referenced by getTableWidth().

$title

string ilPropertyFormGUI::$title = ''

protected

Definition at line 46 of file class.ilPropertyFormGUI.php.

Referenced by getTitle(), ilAccessibilityDocumentFormGUI\initForm(), and ilWebDAVMountInstructionsDocumentFormGUI\initForm().

$titleicon

string ilPropertyFormGUI::$titleicon = ""

protected

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

Referenced by getTitleIcon().

$top_anchor

string ilPropertyFormGUI::$top_anchor = "il_form_top"

protected

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

Referenced by getTopAnchor().

$tpl

ilTemplate ilPropertyFormGUI::$tpl

protected

Definition at line 37 of file class.ilPropertyFormGUI.php.

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\__construct(), ilAssOrderingQuestionAuthoringFormGUI\__construct(), ilObjOrgUnitSettingsFormGUI\__construct(), and ilStudyProgrammeTypeAdvancedMetaDataFormGUI\__construct().

$user

ilObjUser ilPropertyFormGUI::$user = null

protected

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

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\__construct(), ilSCORM2004TrackingItemsPerUserFilterGUI\parse(), and ilSCORMTrackingItemsPerUserFilterGUI\parse().

---

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

• components/ILIAS/Form/classes/class.ilPropertyFormGUI.php