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

Inheritance diagram for ilPropertyFormGUI:

Collaboration diagram for ilPropertyFormGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	executeCommand ()
	Execute command. More...

	setTableWidth ($a_width)
	Set table width. More...

	getTableWidth ()
	get table width More...

	setMode ($a_mode)
	Set Mode ('std', 'subform'). More...

	getMode ()
	Get Mode ('std', 'subform'). More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setTitleIcon ($a_titleicon)
	Set TitleIcon. More...

	getTitleIcon ()
	Get TitleIcon. More...

	setDescription ($a_val)
	Set description. More...

	getDescription ()
	Get description. More...

	setTopAnchor ($a_val)
	Set top anchor. More...

	getTopAnchor ()
	Get top anchor. More...

	setShowTopButtons ($a_val)
	Get show top buttons. More...

	getShowTopButtons ()
	Set show top buttons. More...

	addItem ($a_item)
	Add Item (Property, SectionHeader). More...

	removeItemByPostVar ($a_post_var, $a_remove_unused_headers=false)
	Remove Item. More...

	getItemByPostVar ($a_post_var)
	Get Item by POST variable. More...

	setItems ($a_items)
	Set Items. More...

	getItems ()
	Get Items. More...

	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...

	setDisableStandardMessage ($a_val)
	Set disable standard message. More...

	getDisableStandardMessage ()
	Get disable standard message. More...

	getHideLabels ()
	Get a value indicating whether the labels should be hidden or not. More...

	setHideLabels ($a_value=true)
	Set a value indicating whether the labels should be hidden or not. More...

	setValuesByArray ($a_values, $a_restrict_to_value_keys=false)
	Set form values from an array. More...

	setValuesByPost ()
	Set form values from POST values. More...

	checkInput ()
	Check Post Input. More...

	getInput ($a_post_var, $ensureValidation=true)
	Returns the value of a HTTP-POST variable, identified by the passed id. More...

	addCustomProperty ( $a_title, $a_html, $a_info="", $a_alert="", $a_required=false)
	Add a custom property. More...

	addCommandButton ($a_cmd, $a_text, $a_id="")
	Add Command button. More...

	getCommandButtons ()
	Return all Command buttons. More...

	clearCommandButtons ()
	Remove all command buttons. More...

	getContent ()
	Get Content. More...

	insertItem ($item, $a_sub_item=false)

	getHTML ()
	Get HTML. More...

	getFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Get file upload data. More...

	hasFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Was any file uploaded? More...

	moveFileUpload ($a_target_directory, $a_field, $a_target_name=null, $a_index=null, $a_sub_index=null)
	Move upload to target directory. More...

Public Member Functions inherited from ilFormGUI
	setFormAction ($a_formaction)
	Set FormAction. More...

	getFormAction ()
	Get FormAction. More...

	setTarget ($a_target)
	Set Target. More...

	getTarget ()
	Get Target. More...

	setMultipart ($a_multipart)
	Set Enctype Multipart/Formdata true/false. More...

	getMultipart ()
	Get Enctype Multipart/Formdata true/false. More...

	setId ($a_id)
	Set Id. More...

	getId ()
	Get Id. More...

	setName ($a_name)
	Set Name. More...

	getName ()
	Get Name. More...

	setKeepOpen ($a_keepopen)
	Set Keep Form Tag Open. More...

	getKeepOpen ()
	Get Keep Form Tag Open. More...

	setOpenTag ($a_open)
	Enable/Disable Open Form Tag. More...

	getOpenTag ()
	Get Open Form Tag Enabled. More...

	setCloseTag ($a_val)
	Set close tag. More...

	getCloseTag ()
	Get close tag. More...

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

	getHTML ()
	Get HTML. More...

	getContent ()
	Get Content. More...

Protected Member Functions
	hideRequired ($a_type)

	rebuildUploadedFiles ()
	try to rebuild files More...

Protected Attributes
	$lng

	$ctrl

	$tpl

	$user

	$settings

	$mode = "std"

	$check_input_called = false

	$disable_standard_message = false

	$top_anchor = "il_form_top"

	$titleicon = false

	$description = ""

	$tbl_width = false

	$show_top_buttons = true

	$hide_labels = false

Protected Attributes inherited from ilFormGUI
	$formaction

	$multipart = false

	$keepopen = false

	$opentag = true

	$id

	$name

	$prevent_double_submission = false

Private Attributes
	$buttons = array()

	$items = array()

Detailed Description

This class represents a property form user interface.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$ @ilCtrl_Calls ilPropertyFormGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPropertyFormGUI::__construct ( )

Constructor.

Parameters

Reimplemented in ilAssOrderingQuestionAuthoringFormGUI, and ilAssQuestionAuthoringFormGUI.

Definition at line 92 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
        $this->rebuildUploadedFiles();
    }

References $DIC, $lng, rebuildUploadedFiles(), ilFormGUI\setPreventDoubleSubmission(), settings(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ addCommandButton()

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

Add Command button.

Parameters

string	Command
string	Text

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

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

Referenced by FormMailCodesGUI\__construct(), arConfigFormGUI\addCommandButtons(), ilAssQuestionAuthoringFormGUI\addGenericAssessmentQuestionCommandButtons(), ilAssOrderingQuestionAuthoringFormGUI\addSpecificOrderingQuestionCommandButtons(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilAsyncPropertyFormGUI\cloneForm(), ilMailOptionsFormGUI\init(), ILIAS\Modules\OrgUnit\ARHelper\BaseForm\initButtons(), ilOrgUnitDefaultPermissionFormGUI\initButtons(), ilMemcacheServerFormGUI\initButtons(), arEditGUI\initCommandButtons(), ilObjBibliographicAdminLibrariesFormGUI\initForm(), ilPersonalChatSettingsFormGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilOrgUnitTypeFormGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), and ilStudyProgrammeTypeFormGUI\initForm().

Here is the caller graph for this function:

◆ addCustomProperty()

ilPropertyFormGUI::addCustomProperty	(	$a_title,
		$a_html,
		$a_info = `""`,
		$a_alert = `""`,
		$a_required = `false`
	)

Add a custom property.

Parameters

string	Title
string	HTML.
string	Info text.
string	Alert text.
boolean	Required field. (Default false)

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

      {
        $this->properties[] = array("type" => "custom",
            "title" => $a_title,
            "html" => $a_html,
            "info" => $a_info);
    }

◆ addItem()

ilPropertyFormGUI::addItem ( $a_item )

Add Item (Property, SectionHeader).

Parameters

object $a_property Item object

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

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

Referenced by FormMailCodesGUI\__construct(), ilObjRemoteCourseGUI\addCustomEditForm(), ilObjRemoteGlossaryGUI\addCustomEditForm(), ilObjRemoteGroupGUI\addCustomEditForm(), ilObjRemoteLearningModuleGUI\addCustomEditForm(), ilObjRemoteTestGUI\addCustomEditForm(), ilObjRemoteWikiGUI\addCustomEditForm(), ilAdvancedMDFieldDefinitionFloat\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionInteger\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionSelect\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionText\addCustomFieldToDefinitionForm(), ilForumCronNotification\addCustomSettingsToForm(), ilConsultationHourCron\addCustomSettingsToForm(), ilLoggerCronCleanErrorFiles\addCustomSettingsToForm(), ilMailCronNotification\addCustomSettingsToForm(), ilMailCronOrphanedMails\addCustomSettingsToForm(), ilCronDeleteInactivatedUserAccounts\addCustomSettingsToForm(), ilCronDeleteInactiveUserAccounts\addCustomSettingsToForm(), ilDAVCronDiskQuota\addCustomSettingsToForm(), SurveyMatrixQuestionGUI\addFieldsToEditForm(), SurveyMetricQuestionGUI\addFieldsToEditForm(), SurveyMultipleChoiceQuestionGUI\addFieldsToEditForm(), SurveySingleChoiceQuestionGUI\addFieldsToEditForm(), SurveyTextQuestionGUI\addFieldsToEditForm(), arEditGUI\addFormField(), ilCharSelectorGUI\addFormProperties(), ilPersonalProfileGUI\addLocationToForm(), ilECSObjectSettings\addSettingsToForm(), ilSkillTreeNodeGUI\addStatusInput(), ilAdvancedMDFieldDefinition\addToFieldDefinitionForm(), ilTaxMDGUI\addToMDForm(), ilOrgUnitTypeFormGUI\addTranslationInputs(), ilStudyProgrammeTypeFormGUI\addTranslationInputs(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilAsyncPropertyFormGUI\cloneForm(), getContent(), ilExAssignmentEditorGUI\handleDisabledPeerFields(), ilMailOptionsFormGUI\init(), ilCourseLPBadgeGUI\initConfigForm(), ilUserProfileBadgeGUI\initConfigForm(), ilObjPortfolioGUI\initCopyPageFormOptions(), ilObjPortfolioTemplateGUI\initCopyPageFormOptions(), ilExcCriteriaText\initCustomForm(), ilObjPortfolioTemplateGUI\initDidacticTemplate(), ilObjBibliographicGUI\initEditCustomForm(), ilObjBlogGUI\initEditCustomForm(), ilObjBookingPoolGUI\initEditCustomForm(), ilObjDataCollectionGUI\initEditCustomForm(), ilObjExerciseGUI\initEditCustomForm(), ilObjItemGroupGUI\initEditCustomForm(), ilObjMediaPoolGUI\initEditCustomForm(), ilObjPollGUI\initEditCustomForm(), ilObjPortfolioBaseGUI\initEditCustomForm(), ilObjPortfolioTemplateGUI\initEditCustomForm(), ilObjBibliographicAdminLibrariesFormGUI\initForm(), ilPersonalChatSettingsFormGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilOrgUnitTypeFormGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilStudyProgrammeTypeFormGUI\initForm(), arConfigFormGUI\initForm(), ilMemcacheServerFormGUI\initForm(), ilOrgUnitAuthorityFormGUI\initFormElements(), ilOrgUnitPositionFormGUI\initFormElements(), ilOrgUnitDefaultPermissionFormGUI\initFormElements(), insertItem(), ilAdministrationSettingsFormHandler\parseFieldDefinition(), ilAssQuestionSkillAssignmentPropertyFormGUI\populateFullProperties(), ilAssQuestionSkillAssignmentPropertyFormGUI\populateLimitedProperties(), ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation(), and ilAdvancedMDFieldDefinition\prepareDefinitionFormConfirmation().

Here is the caller graph for this function:

◆ checkInput()

ilPropertyFormGUI::checkInput ( )

Check Post Input.

This method also strips slashes and html from input and sets the alert texts for the items, if the input was not ok.

Returns: boolean ok true/false

Reimplemented in ilAsyncPropertyFormGUI.

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

    {
        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 missint completely (if post_max_size exceeded)
        if (count($this->items) > 0 && !is_array($_POST)) {
            $ok = false;
        }
        
        $this->check_input_called = true;
        
        
        
        // try to keep uploads for another try
        if (!$ok && $_POST["ilfilehash"] && sizeof($_FILES)) {
            $hash = $_POST["ilfilehash"];
 
            foreach ($_FILES as $field => $data) {
                // we support up to 2 nesting levels (see test/assesment)
                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, $idx, $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, $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()) {
                    ilUtil::sendFailure($txt);
                }
 
                return $ok;
        }
    }

References $_POST, $data, $DIC, $file, $http, $ok, GuzzleHttp\Psr7\$stream, $txt, getDisableStandardMessage(), ILIAS\Filesystem\Stream\Streams\ofString(), and ilUtil\sendFailure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearCommandButtons()

ilPropertyFormGUI::clearCommandButtons ( )

Remove all command buttons.

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

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

Referenced by ilAssOrderingQuestionAuthoringFormGUI\renewOrderingCommandButtons().

Here is the caller graph for this function:

◆ executeCommand()

ilPropertyFormGUI::executeCommand ( )

Execute command.

Reimplemented in ilPersonalChatSettingsFormGUI.

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

    {
        $ilCtrl = $this->ctrl;
        
        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd();
 
        switch ($next_class) {
            case 'ilformpropertydispatchgui':
                $ilCtrl->saveParameter($this, 'postvar');
                include_once './Services/Form/classes/class.ilFormPropertyDispatchGUI.php';
                $form_prop_dispatch = new ilFormPropertyDispatchGUI();
                $item = $this->getItemByPostVar($_REQUEST["postvar"]);
                $form_prop_dispatch->setItem($item);
                return $ilCtrl->forwardCommand($form_prop_dispatch);
                break;
 
        }
        return false;
    }

References $ctrl, $ilCtrl, and getItemByPostVar().

Here is the call graph for this function:

◆ getCommandButtons()

ilPropertyFormGUI::getCommandButtons ( )

Return all Command buttons.

Returns: array

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

    {
        return $this->buttons;
    }

References $buttons.

Referenced by ilAsyncPropertyFormGUI\cloneForm().

Here is the caller graph for this function:

◆ getContent()

ilPropertyFormGUI::getContent ( )

Get Content.

Reimplemented from ilFormGUI.

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

    {
        global $DIC;
        $lng = $this->lng;
        $tpl = $DIC["tpl"];
        $ilSetting = $this->settings;
    
        include_once("./Services/YUI/classes/class.ilYuiUtil.php");
        ilYuiUtil::initEvent();
        ilYuiUtil::initDom();
        ilYuiUtil::initAnimation();
 
        $tpl->addJavaScript("./Services/JavaScript/js/Basic.js");
        $tpl->addJavaScript("Services/Form/js/Form.js");
 
        $this->tpl = new ilTemplate("tpl.property_form.html", true, true, "Services/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];
        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) {
                // 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();
            }
 
            if (is_object($ilSetting)) {
                if ($ilSetting->get('char_selector_availability') > 0) {
                    require_once 'Services/UIComponent/CharSelector/classes/class.ilCharSelectorGUI.php';
                    if (ilCharSelectorGUI::_isAllowed()) {
                        $char_selector = ilCharSelectorGUI::_getCurrentGUI();
                        if ($char_selector->getConfig()->getAvailability() == ilCharSelectorConfig::ENABLED) {
                            $char_selector->addToPage();
                            $this->tpl->TouchBlock('char_selector');
                        }
                    }
                }
            }
            
            $this->tpl->setCurrentBlock("header");
            $this->tpl->setVariable("TXT_TITLE", $this->getTitle());
            $this->tpl->setVariable("LABEL", $this->getTopAnchor());
            $this->tpl->setVariable("TXT_DESCRIPTION", $this->getDescription());
            $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 = $_POST["ilfilehash"];
                if (!$hash) {
                    $hash = md5(uniqid(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 $_POST, $DIC, $ilSetting, $lng, $settings, $tpl, ilCharSelectorGUI\_getCurrentGUI(), ilCharSelectorGUI\_isAllowed(), addItem(), ilCharSelectorConfig\ENABLED, getDescription(), getMode(), ilFormGUI\getMultipart(), getShowTopButtons(), getTableWidth(), getTitle(), getTitleIcon(), getTopAnchor(), ilYuiUtil\initAnimation(), ilYuiUtil\initDom(), ilYuiUtil\initEvent(), insertItem(), and setTitle().

Here is the call graph for this function:

◆ getDescription()

ilPropertyFormGUI::getDescription ( )

Get description.

Returns: string description

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

    {
        return $this->description;
    }

References $description.

Referenced by getContent().

Here is the caller graph for this function:

◆ getDisableStandardMessage()

ilPropertyFormGUI::getDisableStandardMessage ( )

Get disable standard message.

Returns: boolean disable standard message

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

    {
        return $this->disable_standard_message;
    }

References $disable_standard_message.

Referenced by checkInput().

Here is the caller graph for this function:

◆ getFileUpload()

ilPropertyFormGUI::getFileUpload	(	$a_field,
		$a_index = `null`,
		$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 997 of file class.ilPropertyFormGUI.php.

    {
        $res = array();
        if ($a_index) {
            if ($_FILES[$a_field]["tmp_name"][$a_index][$a_sub_index]) {
                $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" => true
                );
            }
        } elseif ($a_sub_index) {
            if ($_FILES[$a_field]["tmp_name"][$a_index]) {
                $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" => true
                );
            }
        } else {
            if ($_FILES[$a_field]["tmp_name"]) {
                $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" => true
                );
            }
        }
        return $res;
    }

References $res.

Referenced by hasFileUpload(), and moveFileUpload().

Here is the caller graph for this function:

◆ getHideLabels()

ilPropertyFormGUI::getHideLabels ( )

Get a value indicating whether the labels should be hidden or not.

Returns: boolean true, to hide the labels; otherwise, false.

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

    {
        return $this->hide_labels;
    }

References $hide_labels.

Referenced by insertItem().

Here is the caller graph for this function:

◆ getHTML()

ilPropertyFormGUI::getHTML ( )

Get HTML.

Reimplemented from ilFormGUI.

Reimplemented in ilAsyncPropertyFormGUI.

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

    {
        $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;
                }
            }
        }
        
        return $html;
    }

References $html.

Referenced by ilIndividualAssessmentSettingsGUI\renderForm(), arGUI\save(), and ilPersonalChatSettingsFormGUI\showChatOptions().

Here is the caller graph for this function:

◆ getInput()

ilPropertyFormGUI::getInput	(	$a_post_var,
		$ensureValidation = `true`
	)

Returns the value of a HTTP-POST variable, identified by the passed id.

Parameters

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

Returns: string The value of a HTTP-POST variable, identified by the passed id @access public

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

    {
        // this check ensures, that checkInput has been called (incl. stripSlashes())
        if (!$this->check_input_called && $ensureValidation) {
            die("Error: ilPropertyFormGUI->getInput() called without calling checkInput() first.");
        }
        
        return $_POST[$a_post_var];
    }

References $_POST.

Referenced by ilAdvancedMDFieldDefinitionSelect\buildConfirmedObjects(), ilDclTableViewEditFormGUI\createTableView(), ilOrgUnitAuthorityFormGUI\fillObject(), ilOrgUnitDefaultPermissionFormGUI\fillObject(), ilObjOrgUnitSettingsFormGUI\fillObject(), ilOrgUnitTypeAdvancedMetaDataFormGUI\fillObject(), ilOrgUnitTypeFormGUI\fillObject(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillObject(), ilStudyProgrammeTypeFormGUI\fillObject(), ilMemcacheServerFormGUI\fillObject(), ilCourseLPBadgeGUI\getConfigFromForm(), ilCharSelectorGUI\getFormValues(), ilAdvancedMDFieldDefinitionFloat\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionInteger\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionSelect\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionSelectMulti\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionText\importCustomDefinitionFormPostValues(), ilExcCriteriaText\importCustomForm(), ilAdvancedMDFieldDefinition\importDefinitionFormPostValues(), SurveyMatrixQuestionGUI\importEditFormValues(), SurveyMetricQuestionGUI\importEditFormValues(), SurveyMultipleChoiceQuestionGUI\importEditFormValues(), SurveySingleChoiceQuestionGUI\importEditFormValues(), SurveyTextQuestionGUI\importEditFormValues(), ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation(), ilAdvancedMDFieldDefinition\prepareDefinitionFormConfirmation(), ilExAssignmentEditorGUI\processForm(), ilExAssignmentEditorGUI\processPeerReviewForm(), ilMailOptionsFormGUI\save(), ilPersonalChatSettingsFormGUI\saveChatOptions(), ilForumCronNotification\saveCustomSettings(), ilConsultationHourCron\saveCustomSettings(), ilLoggerCronCleanErrorFiles\saveCustomSettings(), ilMailCronOrphanedMails\saveCustomSettings(), ilSCCronTrash\saveCustomSettings(), ilObjBibliographicAdminLibrariesFormGUI\saveObject(), arConfigFormGUI\saveValueForItem(), arEditGUI\setDateTimeRecordField(), arEditGUI\setNumericRecordField(), arEditGUI\setTextRecordField(), ilObjBibliographicGUI\updateCustom(), ilObjBlogGUI\updateCustom(), ilObjBookingPoolGUI\updateCustom(), ilObjDataCollectionGUI\updateCustom(), ilObjExerciseGUI\updateCustom(), ilObjItemGroupGUI\updateCustom(), ilObjMediaPoolGUI\updateCustom(), ilObjPollGUI\updateCustom(), ilObjPortfolioBaseGUI\updateCustom(), ilObjPortfolioGUI\updateCustom(), ilObjPortfolioTemplateGUI\updateCustom(), ilForumSettingsGUI\updateCustomValues(), ilDclTableViewEditFormGUI\updateTableView(), ilObjOrgUnitSettingsFormGUI\updateTranslation(), ilObjPollGUI\validateCustom(), SurveyMultipleChoiceQuestionGUI\validateEditForm(), and ilCourseLPBadgeGUI\validateForm().

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

Returns: array

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

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

◆ getItemByPostVar()

ilPropertyFormGUI::getItemByPostVar ( $a_post_var )

Get Item by POST variable.

Parameters

string $a_postvar Post Var

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

    {
        foreach ($this->items as $key => $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 false;
    }

References $key, and $ret.

Referenced by ilCronDeleteInactiveUserAccounts\addCustomSettingsToForm(), ilTestRandomQuestionSetPoolDefinitionFormGUI\applySubmit(), executeCommand(), ilExcCriteriaText\exportCustomForm(), ilExcCriteriaGUI\exportForm(), ilExcCriteriaCatalogueGUI\exportForm(), ilExAssignmentEditorGUI\getAssignmentValues(), ilAssOrderingQuestionAuthoringFormGUI\getOrderingElementInputField(), ilExAssignmentEditorGUI\handleDisabledFields(), ilExAssignmentEditorGUI\handleDisabledPeerFields(), ilCourseLPBadgeGUI\importConfigToForm(), ilUserProfileBadgeGUI\importConfigToForm(), ilAdvancedMDFieldDefinition\importDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation(), ilAdvancedMDFieldDefinition\prepareDefinitionFormConfirmation(), ilExAssignmentEditorGUI\processForm(), ilExAssignmentEditorGUI\processPeerReviewForm(), ilAssOrderingQuestionAuthoringFormGUI\renewOrderingElementInput(), ilTestRandomQuestionSetGeneralConfigFormGUI\save(), ilCronDeleteInactiveUserAccounts\saveCustomSettings(), ilObjTestSettingsGeneralGUI\saveQuestionBehaviourProperties(), ilObjTestSettingsScoringResultsGUI\saveResultMiscOptionsSettings(), ilBadgeManagementGUI\setBadgeFormValues(), ilExAssignmentEditorGUI\setDisabledFieldValues(), ilExAssignmentEditorGUI\setDisabledPeerReviewFieldValues(), ilCharSelectorGUI\setFormValues(), ilObjBadgeAdministrationGUI\setImageTemplateFormValues(), ilObjBlogGUI\updateCustom(), ilObjPollGUI\updateCustom(), ilObjPortfolioBaseGUI\updateCustom(), ilObjPortfolioTemplateGUI\updateCustom(), ilObjPollGUI\validateCustom(), SurveyMultipleChoiceQuestionGUI\validateEditForm(), ilCourseLPBadgeGUI\validateForm(), assImagemapQuestionGUI\writeAnswerSpecificPostData(), and assKprimChoiceGUI\writeQuestionSpecificPostData().

Here is the caller graph for this function:

◆ getItems()

ilPropertyFormGUI::getItems ( )

Get Items.

Returns: array array of item objects

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

    {
        return $this->items;
    }

References $items.

Referenced by ilAsyncPropertyFormGUI\cloneForm(), ilUserFormSettings\exportToForm(), arConfigFormGUI\fillForm(), ilAsyncPropertyFormGUI\getErrors(), ilUserFormSettings\importFromForm(), ilAssQuestionAuthoringFormGUI\replaceFormItemByPostVar(), and arConfigFormGUI\saveObject().

Here is the caller graph for this function:

◆ getMode()

ilPropertyFormGUI::getMode ( )

Get Mode ('std', 'subform').

Returns: string Mode ('std', 'subform')

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

    {
        return $this->mode;
    }

References $mode.

Referenced by getContent(), and insertItem().

Here is the caller graph for this function:

◆ getShowTopButtons()

ilPropertyFormGUI::getShowTopButtons ( )

Set show top buttons.

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

    {
        return $this->show_top_buttons;
    }

References $show_top_buttons.

Referenced by getContent().

Here is the caller graph for this function:

◆ getTableWidth()

ilPropertyFormGUI::getTableWidth ( )

final

get table width

@access public

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

    {
        return $this->tbl_width;
    }

References $tbl_width.

Referenced by getContent().

Here is the caller graph for this function:

◆ getTitle()

ilPropertyFormGUI::getTitle ( )

Get Title.

Returns: string Title

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

    {
        return $this->title;
    }

References $title.

Referenced by getContent().

Here is the caller graph for this function:

◆ getTitleIcon()

ilPropertyFormGUI::getTitleIcon ( )

Get TitleIcon.

Returns: string TitleIcon

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

    {
        return $this->titleicon;
    }

References $titleicon.

Referenced by getContent().

Here is the caller graph for this function:

◆ getTopAnchor()

ilPropertyFormGUI::getTopAnchor ( )

Get top anchor.

Returns: string top anchor

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

    {
        return $this->top_anchor;
    }

References $top_anchor.

Referenced by getContent().

Here is the caller graph for this function:

◆ hasFileUpload()

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

Was any file uploaded?

Parameters

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

Returns: bool

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

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

References $data, and getFileUpload().

Here is the call graph for this function:

◆ hideRequired()

ilPropertyFormGUI::hideRequired ( $a_type )

protected

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

    {
        // #15818
        return in_array($a_type, array("non_editable_value"));
    }

References $a_type.

Referenced by insertItem().

Here is the caller graph for this function:

◆ insertItem()

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

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

    {
        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("./Services/Form/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(implode("~", $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->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") {
                    $this->tpl->setVariable("LAB_ID", $item->getFieldId());
                }
                $this->tpl->parseCurrentBlock();
            } 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") {
                    $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("icon_alert.svg")
                );
                $this->tpl->setVariable(
                    "ALT_ALERT",
                    $lng->txt("alert")
                );
                $this->tpl->setVariable(
                    "TXT_ALERT",
                    $item->getAlert()
                );
                $this->tpl->parseCurrentBlock();
            }
            
            // subitems
            $sf = null;
            if ($item->getType() != "non_editable_value" or 1) {
                $sf = $item->getSubForm();
                if ($item->hideSubForm() && is_object($sf)) {
                    $this->tpl->setCurrentBlock("sub_form_hide");
                    $this->tpl->setVariable("DSFID", $item->getFieldId());
                    $this->tpl->parseCurrentBlock();
                }
            }
            
 
            $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", ilJsonUtil::encode($cfg));*/
            $this->tpl->parseCurrentBlock();
        }
        
        
        $this->tpl->touchBlock("item");
    }

References $cfg, $DIC, $lng, $tpl, addItem(), getHideLabels(), ilUtil\getImagePath(), getMode(), hideRequired(), and ilFormGUI\setMultipart().

Referenced by getContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moveFileUpload()

ilPropertyFormGUI::moveFileUpload	(	$a_target_directory,
		$a_field,
		$a_target_name = `null`,
		$a_index = `null`,
		$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)
mixed	$a_index	form field index (if array)
mixed	$a_sub_index	form field subindex (if array)

Returns: string target file name incl. path

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

    {
        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 (!ilUtil::moveUploadedFile($data["tmp_name"], $data["name"], $target_file)) {
                    return;
                }
            } else {
                if (!rename($data["tmp_name"], $target_file)) {
                    return;
                }
            }
            
            return $target_file;
        }
    }

References $data, and getFileUpload().

Here is the call graph for this function:

◆ rebuildUploadedFiles()

ilPropertyFormGUI::rebuildUploadedFiles ( )

protected

try to rebuild files

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

    {
        if (isset($_POST["ilfilehash"]) && $_POST["ilfilehash"]) {
            $temp_path = ilUtil::getDataDir() . "/temp";
            if (is_dir($temp_path)) {
                $temp_files = glob($temp_path . "/" . session_id() . "~~" . $_POST["ilfilehash"] . "~~*");
                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 (!$_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);
                            }
                        } elseif ($idx != "") {
                            if (!$_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);
                            }
                        } else {
                            if (!$_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);
                            }
                        }
                    }
                }
            }
        }
    }

References $_POST, $file, ilFormGUI\$name, $type, and ilUtil\getDataDir().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeItemByPostVar()

ilPropertyFormGUI::removeItemByPostVar	(	$a_post_var,
		$a_remove_unused_headers = `false`
	)

Remove Item.

Parameters

string $a_postvar Post Var

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

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

References $key.

Referenced by ilObjItemGroupGUI\initEditCustomForm().

Here is the caller graph for this function:

◆ setDescription()

ilPropertyFormGUI::setDescription ( $a_val )

Set description.

Parameters

string description

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

    {
        $this->description = $a_val;
    }

◆ setDisableStandardMessage()

ilPropertyFormGUI::setDisableStandardMessage ( $a_val )

Set disable standard message.

Parameters

boolean disable standard message

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

    {
        $this->disable_standard_message = $a_val;
    }

◆ setHideLabels()

ilPropertyFormGUI::setHideLabels ( $a_value = true )

Set a value indicating whether the labels should be hidden or not.

Parameters

boolean $a_value Indicates whether the labels should be hidden.

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

    {
        $this->hide_labels = $a_value;
    }

◆ setItems()

ilPropertyFormGUI::setItems ( $a_items )

Set Items.

Parameters

array $a_items array of item objects

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

    {
        $this->items = $a_items;
    }

Referenced by ilAssQuestionAuthoringFormGUI\replaceFormItemByPostVar().

Here is the caller graph for this function:

◆ setMode()

ilPropertyFormGUI::setMode ( $a_mode )

Set Mode ('std', 'subform').

Parameters

string $a_mode Mode ('std', 'subform')

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

    {
        $this->mode = $a_mode;
    }

◆ setShowTopButtons()

ilPropertyFormGUI::setShowTopButtons ( $a_val )

Get show top buttons.

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

    {
        $this->show_top_buttons = $a_val;
    }

◆ setTableWidth()

ilPropertyFormGUI::setTableWidth ( $a_width )

final

Set table width.

@access public

Parameters

string table width

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

    {
        $this->tbl_width = $a_width;
    }

◆ setTitle()

ilPropertyFormGUI::setTitle ( $a_title )

Set Title.

Parameters

string $a_title Title

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

    {
        $this->title = $a_title;
    }

Referenced by FormMailCodesGUI\__construct(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), getContent(), ilMailOptionsFormGUI\init(), ILIAS\Modules\OrgUnit\ARHelper\BaseForm\initButtons(), ilOrgUnitDefaultPermissionFormGUI\initButtons(), ilMemcacheServerFormGUI\initButtons(), ilObjExerciseGUI\initEditCustomForm(), ilObjBibliographicAdminLibrariesFormGUI\initForm(), ilPersonalChatSettingsFormGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilOrgUnitTypeFormGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilStudyProgrammeTypeFormGUI\initForm(), arConfigFormGUI\initForm(), and arEditGUI\initFormTitle().

Here is the caller graph for this function:

◆ setTitleIcon()

ilPropertyFormGUI::setTitleIcon ( $a_titleicon )

Set TitleIcon.

Parameters

string $a_titleicon TitleIcon

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

    {
        $this->titleicon = $a_titleicon;
    }

◆ setTopAnchor()

ilPropertyFormGUI::setTopAnchor ( $a_val )

Set top anchor.

Parameters

string top anchor

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

    {
        $this->top_anchor = $a_val;
    }

◆ setValuesByArray()

ilPropertyFormGUI::setValuesByArray	(	$a_values,
		$a_restrict_to_value_keys = `false`
	)

Set form values from an array.

Parameters

array $a_values Value array (key is post variable name, value is value)

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

    {
        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 ilObjBibliographicAdminLibrariesFormGUI\fillForm(), ilOrgUnitAuthorityFormGUI\fillForm(), ilOrgUnitPositionFormGUI\fillForm(), ilOrgUnitDefaultPermissionFormGUI\fillForm(), arConfigFormGUI\fillForm(), ilMemcacheServerFormGUI\fillForm(), ilIndividualAssessmentMemberGUI\fillForm(), ilIndividualAssessmentSettingsGUI\fillForm(), ilIndividualAssessmentSettingsGUI\fillInfoForm(), ilExAssignmentEditorGUI\getAssignmentValues(), ilMailOptionsFormGUI\populate(), and ilPersonalChatSettingsFormGUI\showChatOptions().

Here is the caller graph for this function:

◆ setValuesByPost()

ilPropertyFormGUI::setValuesByPost ( )

Set form values from POST values.

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

    {
        foreach ($this->items as $item) {
            $item->setValueByArray($_POST);
        }
    }

References $_POST.

Referenced by ilObjOrgUnitSettingsFormGUI\fillObject(), ilOrgUnitTypeAdvancedMetaDataFormGUI\fillObject(), ilOrgUnitTypeFormGUI\fillObject(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillObject(), and ilStudyProgrammeTypeFormGUI\fillObject().

Here is the caller graph for this function:

Field Documentation

◆ $buttons

ilPropertyFormGUI::$buttons = array()

private

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

Referenced by getCommandButtons().

◆ $check_input_called

ilPropertyFormGUI::$check_input_called = false

protected

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

◆ $ctrl

ilPropertyFormGUI::$ctrl

protected

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

Referenced by executeCommand(), ilSCORM2004TrackingItemsPerScoFilterGUI\parse(), and ilSCORM2004TrackingItemsPerUserFilterGUI\parse().

◆ $description

ilPropertyFormGUI::$description = ""

protected

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

Referenced by ilOrgUnitTypeFormGUI\fillObject(), ilStudyProgrammeTypeFormGUI\fillObject(), and getDescription().

◆ $disable_standard_message

ilPropertyFormGUI::$disable_standard_message = false

protected

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

Referenced by getDisableStandardMessage().

◆ $hide_labels

ilPropertyFormGUI::$hide_labels = false

protected

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

Referenced by getHideLabels().

◆ $items

ilPropertyFormGUI::$items = array()

private

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

Referenced by getItems().

◆ $lng

ilPropertyFormGUI::$lng

protected

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

Referenced by FormMailCodesGUI\__construct(), arConfigFormGUI\__construct(), __construct(), ilMemcacheServerFormGUI\__construct(), getContent(), ilAsyncPropertyFormGUI\getErrorMessageTemplate(), insertItem(), ilSCORM2004TrackingItemsPerScoFilterGUI\parse(), ilSCORMTrackingItemsPerScoFilterGUI\parse(), ilSCORM2004TrackingItemsPerUserFilterGUI\parse(), and ilSCORMTrackingItemsPerUserFilterGUI\parse().

◆ $mode

ilPropertyFormGUI::$mode = "std"

protected

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

Referenced by getMode().

◆ $settings

ilPropertyFormGUI::$settings

protected

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

Referenced by FormMailCodesGUI\__construct(), and getContent().

◆ $show_top_buttons

ilPropertyFormGUI::$show_top_buttons = true

protected

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

Referenced by getShowTopButtons().

◆ $tbl_width

ilPropertyFormGUI::$tbl_width = false

protected

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

Referenced by getTableWidth().

◆ $titleicon

ilPropertyFormGUI::$titleicon = false

protected

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

Referenced by getTitleIcon().

◆ $top_anchor

ilPropertyFormGUI::$top_anchor = "il_form_top"

protected

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

Referenced by getTopAnchor().

◆ $tpl

ilPropertyFormGUI::$tpl

protected

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

Referenced by ilAsyncPropertyFormGUI\addJavaScript(), ilAsyncPropertyFormGUI\addOnLoadCode(), getContent(), ilAsyncPropertyFormGUI\getErrorMessageTemplate(), and insertItem().

◆ $user

ilPropertyFormGUI::$user

protected

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

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

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

Services/Form/classes/class.ilPropertyFormGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCommandButton()

◆ addCustomProperty()

◆ addItem()

◆ checkInput()

◆ clearCommandButtons()

◆ executeCommand()

◆ getCommandButtons()

◆ getContent()

◆ getDescription()

◆ getDisableStandardMessage()

◆ getFileUpload()

◆ getHideLabels()

◆ getHTML()

◆ getInput()

◆ getInputItemsRecursive()

◆ getItemByPostVar()

◆ getItems()

◆ getMode()

◆ getShowTopButtons()

◆ getTableWidth()

◆ getTitle()

◆ getTitleIcon()

◆ getTopAnchor()

◆ hasFileUpload()

◆ hideRequired()

◆ insertItem()

◆ moveFileUpload()

◆ rebuildUploadedFiles()

◆ removeItemByPostVar()

◆ setDescription()

◆ setDisableStandardMessage()

◆ setHideLabels()

◆ setItems()

◆ setMode()

◆ setShowTopButtons()

◆ setTableWidth()

◆ setTitle()

◆ setTitleIcon()

◆ setTopAnchor()

◆ setValuesByArray()

◆ setValuesByPost()

Field Documentation

◆ $buttons

◆ $check_input_called

◆ $ctrl

◆ $description

◆ $disable_standard_message

◆ $hide_labels

◆ $items

◆ $lng

◆ $mode

◆ $settings

◆ $show_top_buttons

◆ $tbl_width

◆ $titleicon

◆ $top_anchor

◆ $tpl

◆ $user