ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilPropertyFormGUI Class Reference

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 ilAddAnswerModalFormGUI, ilAssOrderingQuestionAuthoringFormGUI, and ilAssQuestionAuthoringFormGUI.

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

93 {
94 global $DIC;
95
96 $this->lng = $DIC->language();
97 $this->ctrl = $DIC->ctrl();
98
99 $this->user = null;
100 if (isset($DIC["ilUser"])) {
101 $this->user = $DIC["ilUser"];
102 }
103
104 $this->settings = null;
105 if (isset($DIC["ilSetting"])) {
106 $this->settings = $DIC["ilSetting"];
107 }
108
109 $lng = $DIC->language();
110
111 $lng->loadLanguageModule("form");
112
113 // avoid double submission
114 $this->setPreventDoubleSubmission(true);
115
116 // do it as early as possible
117 $this->rebuildUploadedFiles();
118 }
user()
Definition: user.php:4
setPreventDoubleSubmission($a_val)
Set prevent double submission.
rebuildUploadedFiles()
try to rebuild files
global $DIC
Definition: saml.php:7
settings()
Definition: settings.php:2

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

+ Here is the call graph for this function:

Member Function Documentation

◆ addCommandButton()

◆ addCustomProperty()

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

Add a custom property.

Parameters
stringTitle
stringHTML.
stringInfo text.
stringAlert text.
booleanRequired field. (Default false)

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

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

◆ addItem()

ilPropertyFormGUI::addItem (   $a_item)

Add Item (Property, SectionHeader).

Parameters
object$a_propertyItem object

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

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

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(), ilCronOerHarvester\addCustomSettingsToForm(), ilCronDeleteInactivatedUserAccounts\addCustomSettingsToForm(), ilCronDeleteInactiveUserAccounts\addCustomSettingsToForm(), ilDAVCronDiskQuota\addCustomSettingsToForm(), SurveyMatrixQuestionGUI\addFieldsToEditForm(), SurveyMetricQuestionGUI\addFieldsToEditForm(), SurveyMultipleChoiceQuestionGUI\addFieldsToEditForm(), SurveySingleChoiceQuestionGUI\addFieldsToEditForm(), SurveyTextQuestionGUI\addFieldsToEditForm(), arEditGUI\addFormField(), ilCharSelectorGUI\addFormProperties(), ilPersonalProfileGUI\addLocationToForm(), ilObjTestSettingsGeneralGUI\addQuestionBehaviourProperties(), ilECSObjectSettings\addSettingsToForm(), ilSkillTreeNodeGUI\addStatusInput(), ilAdvancedMDFieldDefinition\addToFieldDefinitionForm(), ilTaxMDGUI\addToMDForm(), ilOrgUnitTypeFormGUI\addTranslationInputs(), ilStudyProgrammeTypeFormGUI\addTranslationInputs(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilAddAnswerModalFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilAsyncPropertyFormGUI\cloneForm(), getContent(), ilExAssignmentEditorGUI\handleDisabledPeerFields(), ilMailOptionsFormGUI\init(), ilCourseLPBadgeGUI\initConfigForm(), ilUserProfileBadgeGUI\initConfigForm(), ilObjPortfolioGUI\initCopyPageFormOptions(), ilObjPortfolioTemplateGUI\initCopyPageFormOptions(), ilExcCriteriaText\initCustomForm(), ilObjPortfolioTemplateGUI\initDidacticTemplate(), ilObjContentPageGUI\initEditCustomForm(), ilObjBibliographicGUI\initEditCustomForm(), ilObjBlogGUI\initEditCustomForm(), ilObjBookingPoolGUI\initEditCustomForm(), ilObjDataCollectionGUI\initEditCustomForm(), ilObjExerciseGUI\initEditCustomForm(), ilObjItemGroupGUI\initEditCustomForm(), ilObjMediaPoolGUI\initEditCustomForm(), ilObjPollGUI\initEditCustomForm(), ilObjPortfolioBaseGUI\initEditCustomForm(), ilObjPortfolioTemplateGUI\initEditCustomForm(), ilBiblLibraryFormGUI\initForm(), ilBiblFieldFilterFormGUI\initForm(), ilPersonalChatSettingsFormGUI\initForm(), ilDclTableViewEditFormGUI\initForm(), ilFileVersionFormGUI\initForm(), ilForumThreadFormGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilOrgUnitTypeFormGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilStudyProgrammeTypeFormGUI\initForm(), arConfigFormGUI\initForm(), ilMemcacheServerFormGUI\initForm(), ilTermsOfServiceSettingsFormGUI\initForm(), ilTermsOfServiceDocumentFormGUI\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 466 of file class.ilPropertyFormGUI.php.

467 {
468 global $DIC;
469
470 if ($this->check_input_called) {
471 die("Error: ilPropertyFormGUI->checkInput() called twice.");
472 }
473
474 $ok = true;
475 foreach ($this->items as $item) {
476 $item_ok = $item->checkInput();
477 if (!$item_ok) {
478 $ok = false;
479 }
480 }
481
482 // check if POST is missint completely (if post_max_size exceeded)
483 if (count($this->items) > 0 && !is_array($_POST)) {
484 $ok = false;
485 }
486
487 $this->check_input_called = true;
488
489
490
491 // try to keep uploads for another try
492 if (!$ok && $_POST["ilfilehash"] && sizeof($_FILES)) {
493 $hash = $_POST["ilfilehash"];
494
495 foreach ($_FILES as $field => $data) {
496 // only try to keep files that are ok
497 // see 25484: Wrong error handling when uploading icon instead of tile
498 $item = $this->getItemByPostVar($field);
499 if (!$item->checkInput()) {
500 continue;
501 }
502 // we support up to 2 nesting levels (see test/assesment)
503 if (is_array($data["tmp_name"])) {
504 foreach ($data["tmp_name"] as $idx => $upload) {
505 if (is_array($upload)) {
506 foreach ($upload as $idx2 => $file) {
507 if ($file && is_uploaded_file($file)) {
508 $file_name = $data["name"][$idx][$idx2];
509 $file_type = $data["type"][$idx][$idx2];
510 $this->keepFileUpload($hash, $field, $file, $file_name, $file_type, $idx, $idx2);
511 }
512 }
513 } elseif ($upload && is_uploaded_file($upload)) {
514 $file_name = $data["name"][$idx];
515 $file_type = $data["type"][$idx];
516 $this->keepFileUpload($hash, $field, $upload, $file_name, $file_type, $idx);
517 }
518 }
519 } else {
520 $this->keepFileUpload($hash, $field, $data["tmp_name"], $data["name"], $data["type"]);
521 }
522 }
523 }
524 $http = $DIC->http();
525 $txt = $DIC->language()->txt("form_input_not_valid");
526 switch ($http->request()->getHeaderLine('Accept')) {
527 // When JS asks for a valid JSON-Response, we send the success and message as JSON
528 case 'application/json':
530 'success' => $ok,
531 'message' => $txt,
532 ]));
533 $http->saveResponse($http->response()->withBody($stream));
534
535 return $ok;
536
537 // Otherwise we send it using ilUtil and it will be rendered in the Template
538 default:
539
540 if (!$ok && !$this->getDisableStandardMessage()) {
542 }
543
544 return $ok;
545 }
546 }
$_POST["username"]
static ofString($string)
Creates a new stream with an initial value.
Definition: Streams.php:30
getDisableStandardMessage()
Get disable standard message.
getItemByPostVar($a_post_var)
Get Item by POST variable.
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
$txt
Definition: error.php:11
$stream
PHP stream implementation.
$http
Definition: raiseError.php:7
$data
Definition: bench.php:6

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

Referenced by ilBiblFieldFilterFormGUI\fillObject(), ilOrgUnitAuthorityFormGUI\fillObject(), ilOrgUnitDefaultPermissionFormGUI\fillObject(), ilObjOrgUnitSettingsFormGUI\fillObject(), ilOrgUnitTypeAdvancedMetaDataFormGUI\fillObject(), ilOrgUnitTypeFormGUI\fillObject(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillObject(), ilStudyProgrammeTypeFormGUI\fillObject(), arConfigFormGUI\fillObject(), ilMemcacheServerFormGUI\fillObject(), ilTermsOfServiceSettingsFormGUI\fillObject(), ilTermsOfServiceCriterionFormGUI\fillObject(), ilExAssignmentEditorGUI\processForm(), ilExAssignmentEditorGUI\processPeerReviewForm(), ilMailOptionsFormGUI\save(), ilPersonalChatSettingsFormGUI\saveChatOptions(), ilObjectCustomIconConfigurationGUI\saveForm(), ilBiblLibraryFormGUI\saveObject(), and arEditGUI\setArFieldsAfterSubmit().

+ 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 615 of file class.ilPropertyFormGUI.php.

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

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.

124 {
126
127 $next_class = $ilCtrl->getNextClass($this);
128 $cmd = $ilCtrl->getCmd();
129
130 switch ($next_class) {
131 case 'ilformpropertydispatchgui':
132 $ilCtrl->saveParameter($this, 'postvar');
133 include_once './Services/Form/classes/class.ilFormPropertyDispatchGUI.php';
134 $form_prop_dispatch = new ilFormPropertyDispatchGUI();
135 $item = $this->getItemByPostVar($_REQUEST["postvar"]);
136 $form_prop_dispatch->setItem($item);
137 return $ilCtrl->forwardCommand($form_prop_dispatch);
138 break;
139
140 }
141 return false;
142 }
global $ilCtrl
Definition: ilias.php:18

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 607 of file class.ilPropertyFormGUI.php.

608 {
609 return $this->buttons;
610 }

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 623 of file class.ilPropertyFormGUI.php.

624 {
625 global $DIC;
627 $tpl = $DIC["tpl"];
629
630 include_once("./Services/YUI/classes/class.ilYuiUtil.php");
634
635 $tpl->addJavaScript("./Services/JavaScript/js/Basic.js");
636 $tpl->addJavaScript("Services/Form/js/Form.js");
637
638 $this->tpl = new ilTemplate("tpl.property_form.html", true, true, "Services/Form");
639
640 // check if form has not title and first item is a section header
641 // -> use section header for title and remove section header
642 // -> command buttons are presented on top
643 $fi = $this->items[0];
644 if ($this->getMode() == "std" &&
645 $this->getTitle() == "" &&
646 is_object($fi) && $fi->getType() == "section_header"
647 ) {
648 $this->setTitle($fi->getTitle());
649 unset($this->items[0]);
650 }
651
652
653 // title icon
654 if ($this->getTitleIcon() != "" && @is_file($this->getTitleIcon())) {
655 $this->tpl->setCurrentBlock("title_icon");
656 $this->tpl->setVariable("IMG_ICON", $this->getTitleIcon());
657 $this->tpl->parseCurrentBlock();
658 }
659
660 // title
661 if ($this->getTitle() != "") {
662 // commands on top
663 if (count($this->buttons) > 0 && $this->getShowTopButtons() && count($this->items) > 2) {
664 // command buttons
665 foreach ($this->buttons as $button) {
666 $this->tpl->setCurrentBlock("cmd2");
667 $this->tpl->setVariable("CMD", $button["cmd"]);
668 $this->tpl->setVariable("CMD_TXT", $button["text"]);
669 if ($button["id"] != "") {
670 $this->tpl->setVariable("CMD2_ID", " id='" . $button["id"] . "_top'");
671 }
672 $this->tpl->parseCurrentBlock();
673 }
674 $this->tpl->setCurrentBlock("commands2");
675 $this->tpl->parseCurrentBlock();
676 }
677
678 if (is_object($ilSetting)) {
679 if ($ilSetting->get('char_selector_availability') > 0) {
680 require_once 'Services/UIComponent/CharSelector/classes/class.ilCharSelectorGUI.php';
682 $char_selector = ilCharSelectorGUI::_getCurrentGUI();
683 if ($char_selector->getConfig()->getAvailability() == ilCharSelectorConfig::ENABLED) {
684 $char_selector->addToPage();
685 $this->tpl->TouchBlock('char_selector');
686 }
687 }
688 }
689 }
690
691 $this->tpl->setCurrentBlock("header");
692 $this->tpl->setVariable("TXT_TITLE", $this->getTitle());
693 //$this->tpl->setVariable("LABEL", $this->getTopAnchor());
694 $this->tpl->setVariable("TXT_DESCRIPTION", $this->getDescription());
695 $this->tpl->parseCurrentBlock();
696 }
697 $this->tpl->touchBlock("item");
698
699 // properties
700 $this->required_text = false;
701 foreach ($this->items as $item) {
702 if ($item->getType() != "hidden") {
703 $this->insertItem($item);
704 }
705 }
706
707 // required
708 if ($this->required_text && $this->getMode() == "std") {
709 $this->tpl->setCurrentBlock("required_text");
710 $this->tpl->setVariable("TXT_REQUIRED", $lng->txt("required_field"));
711 $this->tpl->parseCurrentBlock();
712 }
713
714 // command buttons
715 foreach ($this->buttons as $button) {
716 $this->tpl->setCurrentBlock("cmd");
717 $this->tpl->setVariable("CMD", $button["cmd"]);
718 $this->tpl->setVariable("CMD_TXT", $button["text"]);
719
720 if ($button["id"] != "") {
721 $this->tpl->setVariable("CMD_ID", " id='" . $button["id"] . "'");
722 }
723
724 $this->tpl->parseCurrentBlock();
725 }
726
727 // #18808
728 if ($this->getMode() != "subform") {
729 // try to keep uploads even if checking input fails
730 if ($this->getMultipart()) {
731 $hash = $_POST["ilfilehash"];
732 if (!$hash) {
733 $hash = md5(uniqid(mt_rand(), true));
734 }
735 $fhash = new ilHiddenInputGUI("ilfilehash");
736 $fhash->setValue($hash);
737 $this->addItem($fhash);
738 }
739 }
740
741 // hidden properties
742 $hidden_fields = false;
743 foreach ($this->items as $item) {
744 if ($item->getType() == "hidden") {
745 $item->insert($this->tpl);
746 $hidden_fields = true;
747 }
748 }
749
750 if ($this->required_text || count($this->buttons) > 0 || $hidden_fields) {
751 $this->tpl->setCurrentBlock("commands");
752 $this->tpl->parseCurrentBlock();
753 }
754
755
756 if ($this->getMode() == "subform") {
757 $this->tpl->touchBlock("sub_table");
758 } else {
759 $this->tpl->touchBlock("std_table");
760 $this->tpl->setVariable('STD_TABLE_WIDTH', $this->getTableWidth());
761 }
762
763 return $this->tpl->get();
764 }
static _isAllowed()
Check if the CharSelector is allowed for the current GUI.
static _getCurrentGUI(ilObjTest $a_test_obj=null)
Get the GUI that is used for the currently available selector (other GUI instances may exist for conf...
getMultipart()
Get Enctype Multipart/Formdata true/false.
This class represents a hidden form property in a property form.
addItem($a_item)
Add Item (Property, SectionHeader).
getTableWidth()
get table width
getDescription()
Get description.
insertItem($item, $a_sub_item=false)
getMode()
Get Mode ('std', 'subform').
getShowTopButtons()
Set show top buttons.
setTitle($a_title)
Set Title.
special template class to simplify handling of ITX/PEAR
static initDom()
Init YUI Dom.
static initEvent()
Init YUI Event.
static initAnimation()
Init YUI Animation.
global $ilSetting
Definition: privfeed.php:17

References $_POST, $DIC, $ilSetting, $lng, $settings, $tpl, ilCharSelectorGUI\_getCurrentGUI(), ilCharSelectorGUI\_isAllowed(), addItem(), ilCharSelectorConfig\ENABLED, getDescription(), getMode(), ilFormGUI\getMultipart(), getShowTopButtons(), getTableWidth(), getTitle(), getTitleIcon(), 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.

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 409 of file class.ilPropertyFormGUI.php.

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_fieldform field
mixed$a_indexform field index (if array)
mixed$a_sub_indexform field subindex (if array)
Returns
array (tmp_name, name, type, error, size, is_upload)

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

1007 {
1008 $res = array();
1009 if ($a_index) {
1010 if ($_FILES[$a_field]["tmp_name"][$a_index][$a_sub_index]) {
1011 $res = array(
1012 "tmp_name" => $_FILES[$a_field]["tmp_name"][$a_index][$a_sub_index],
1013 "name" => $_FILES[$a_field]["name"][$a_index][$a_sub_index],
1014 "type" => $_FILES[$a_field]["type"][$a_index][$a_sub_index],
1015 "error" => $_FILES[$a_field]["error"][$a_index][$a_sub_index],
1016 "size" => $_FILES[$a_field]["size"][$a_index][$a_sub_index],
1017 "is_upload" => true
1018 );
1019 }
1020 } elseif ($a_sub_index) {
1021 if ($_FILES[$a_field]["tmp_name"][$a_index]) {
1022 $res = array(
1023 "tmp_name" => $_FILES[$a_field]["tmp_name"][$a_index],
1024 "name" => $_FILES[$a_field]["name"][$a_index],
1025 "type" => $_FILES[$a_field]["type"][$a_index],
1026 "error" => $_FILES[$a_field]["error"][$a_index],
1027 "size" => $_FILES[$a_field]["size"][$a_index],
1028 "is_upload" => true
1029 );
1030 }
1031 } else {
1032 if ($_FILES[$a_field]["tmp_name"]) {
1033 $res = array(
1034 "tmp_name" => $_FILES[$a_field]["tmp_name"],
1035 "name" => $_FILES[$a_field]["name"],
1036 "type" => $_FILES[$a_field]["type"],
1037 "error" => $_FILES[$a_field]["error"],
1038 "size" => $_FILES[$a_field]["size"],
1039 "is_upload" => true
1040 );
1041 }
1042 }
1043 return $res;
1044 }
foreach($_POST as $key=> $value) $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 419 of file class.ilPropertyFormGUI.php.

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 934 of file class.ilPropertyFormGUI.php.

935 {
936 $html = parent::getHTML();
937
938 // #13531 - get content that has to reside outside of the parent form tag, e.g. panels/layers
939 foreach ($this->items as $item) {
940 // #13536 - ilFormSectionHeaderGUI does NOT extend ilFormPropertyGUI ?!
941 if (method_exists($item, "getContentOutsideFormTag")) {
942 $outside = $item->getContentOutsideFormTag();
943 if ($outside) {
944 $html .= $outside;
945 }
946 }
947 }
948
949 return $html;
950 }
$html
Definition: example_001.php:87

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
stringThe key used for value determination
booleanA 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 558 of file class.ilPropertyFormGUI.php.

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

References $_POST.

Referenced by ilAdvancedMDFieldDefinitionSelect\buildConfirmedObjects(), ilDclTableViewEditFormGUI\createTableView(), ilBiblFieldFilterFormGUI\fillObject(), ilOrgUnitAuthorityFormGUI\fillObject(), ilOrgUnitDefaultPermissionFormGUI\fillObject(), ilObjOrgUnitSettingsFormGUI\fillObject(), ilOrgUnitTypeAdvancedMetaDataFormGUI\fillObject(), ilOrgUnitTypeFormGUI\fillObject(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillObject(), ilStudyProgrammeTypeFormGUI\fillObject(), ilMemcacheServerFormGUI\fillObject(), ilTermsOfServiceCriterionFormGUI\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(), ilExAssTypeTextGUI\importFormToAssignment(), ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation(), ilAdvancedMDFieldDefinition\prepareDefinitionFormConfirmation(), ilExAssignmentEditorGUI\processForm(), ilExAssignmentEditorGUI\processPeerReviewForm(), ilMailOptionsFormGUI\save(), ilPersonalChatSettingsFormGUI\saveChatOptions(), assErrorTextGUI\saveCorrectionsFormProperties(), assFileUploadGUI\saveCorrectionsFormProperties(), assKprimChoiceGUI\saveCorrectionsFormProperties(), assNumericGUI\saveCorrectionsFormProperties(), assOrderingHorizontalGUI\saveCorrectionsFormProperties(), assOrderingQuestionGUI\saveCorrectionsFormProperties(), ilForumCronNotification\saveCustomSettings(), ilConsultationHourCron\saveCustomSettings(), ilLoggerCronCleanErrorFiles\saveCustomSettings(), ilMailCronOrphanedMails\saveCustomSettings(), ilCronOerHarvester\saveCustomSettings(), ilSCCronTrash\saveCustomSettings(), ilBiblLibraryFormGUI\saveObject(), ilTermsOfServiceSettingsFormGUI\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 375 of file class.ilPropertyFormGUI.php.

376 {
377 $inputItems = array();
378
379 foreach ($this->items as $item) {
380 if ($item->getType() == 'section_header') {
381 continue;
382 }
383
384 $inputItems[] = $item;
385
386 if ($item instanceof ilSubEnabledFormPropertyGUI) {
387 $inputItems = array_merge($inputItems, $item->getSubInputItemsRecursive());
388 }
389 }
390
391 return $inputItems;
392 }
This class represents a property that may include a sub form.

◆ getItemByPostVar()

ilPropertyFormGUI::getItemByPostVar (   $a_post_var)

Get Item by POST variable.

Parameters
string$a_postvarPost Var

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

335 {
336 foreach ($this->items as $key => $item) {
337 if ($item->getType() != "section_header") {
338 //if ($item->getPostVar() == $a_post_var)
339 $ret = $item->getItemByPostVar($a_post_var);
340 if (is_object($ret)) {
341 return $ret;
342 }
343 }
344 }
345
346 return false;
347 }
$key
Definition: croninfo.php:18
$ret
Definition: parser.php:6

References $key, and $ret.

Referenced by ilCronDeleteInactiveUserAccounts\addCustomSettingsToForm(), ilTestRandomQuestionSetPoolDefinitionFormGUI\applySubmit(), checkInput(), executeCommand(), ilExcCriteriaText\exportCustomForm(), ilExcCriteriaGUI\exportForm(), ilExcCriteriaCatalogueGUI\exportForm(), ilTermsOfServiceCriterionFormGUI\fillObject(), ilExAssignmentEditorGUI\getAssignmentValues(), ilAssOrderingQuestionAuthoringFormGUI\getOrderingElementInputField(), ilNewsItemGUI\getValuesNewsItem(), ilExAssignmentEditorGUI\handleDisabledFields(), ilExAssignmentEditorGUI\handleDisabledPeerFields(), ilCourseLPBadgeGUI\importConfigToForm(), ilUserProfileBadgeGUI\importConfigToForm(), ilAdvancedMDFieldDefinition\importDefinitionFormPostValues(), ilObjPortfolioTemplateGUI\initEditCustomForm(), ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation(), ilAdvancedMDFieldDefinition\prepareDefinitionFormConfirmation(), ilExAssignmentEditorGUI\processForm(), ilExAssignmentEditorGUI\processPeerReviewForm(), ilAssOrderingQuestionAuthoringFormGUI\renewOrderingElementInput(), ilTestRandomQuestionSetGeneralConfigFormGUI\save(), assErrorTextGUI\saveCorrectionsFormProperties(), assKprimChoiceGUI\saveCorrectionsFormProperties(), ilCronDeleteInactiveUserAccounts\saveCustomSettings(), ilTermsOfServiceSettingsFormGUI\saveObject(), ilTermsOfServiceCriterionFormGUI\saveObject(), ilObjTestSettingsGeneralGUI\saveQuestionBehaviourProperties(), ilObjTestSettingsScoringResultsGUI\saveResultMiscOptionsSettings(), ilBadgeManagementGUI\setBadgeFormValues(), ilExAssignmentEditorGUI\setDisabledFieldValues(), ilExAssignmentEditorGUI\setDisabledPeerReviewFieldValues(), ilCharSelectorGUI\setFormValues(), ilObjBadgeAdministrationGUI\setImageTemplateFormValues(), ilAddAnswerModalFormGUI\setValuesByArray(), 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 ( )

◆ getMode()

ilPropertyFormGUI::getMode ( )

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

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

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

183 {
184 return $this->mode;
185 }

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 279 of file class.ilPropertyFormGUI.php.

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.

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.

203 {
204 return $this->title;
205 }

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.

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 263 of file class.ilPropertyFormGUI.php.

References $top_anchor.

◆ hasFileUpload()

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

Was any file uploaded?

Parameters
string$a_fieldform field
mixed$a_indexform field index (if array)
mixed$a_sub_indexform field subindex (if array)
Returns
bool

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

1055 {
1056 $data = $this->getFileUpload($a_field, $a_index, $a_sub_index);
1057 return (bool) $data["tmp_name"];
1058 }
getFileUpload($a_field, $a_index=null, $a_sub_index=null)
Get file upload data.

References $data, and getFileUpload().

+ Here is the call graph for this function:

◆ hideRequired()

ilPropertyFormGUI::hideRequired (   $a_type)
protected

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

767 {
768 // #15818
769 return in_array($a_type, array("non_editable_value"));
770 }
$a_type
Definition: workflow.php:92

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 772 of file class.ilPropertyFormGUI.php.

773 {
774 global $DIC;
775 $tpl = $DIC["tpl"];
776 ;
778
779
780 $cfg = array();
781
782 //if(method_exists($item, "getMulti") && $item->getMulti())
783 if ($item instanceof ilMultiValuesItem && $item->getMulti()) {
784 $tpl->addJavascript("./Services/Form/js/ServiceFormMulti.js");
785
786 $this->tpl->setCurrentBlock("multi_in");
787 $this->tpl->setVariable("ID", $item->getFieldId());
788 $this->tpl->parseCurrentBlock();
789
790 $this->tpl->touchBlock("multi_out");
791
792
793 // add hidden item to enable preset multi items
794 // not used yet, should replace hidden field stuff
795 $multi_values = $item->getMultiValues();
796 if (is_array($multi_values) && sizeof($multi_values) > 1) {
797 $multi_value = new ilHiddenInputGUI("ilMultiValues~" . $item->getPostVar());
798 $multi_value->setValue(implode("~", $multi_values));
799 $this->addItem($multi_value);
800 }
801 $cfg["multi_values"] = $multi_values;
802 }
803
804 $item->insert($this->tpl);
805
806 if ($item->getType() == "file" || $item->getType() == "image_file") {
807 $this->setMultipart(true);
808 }
809
810 if ($item->getType() != "section_header") {
811 $cfg["id"] = $item->getFieldId();
812
813 // info text
814 if ($item->getInfo() != "") {
815 $this->tpl->setCurrentBlock("description");
816 $this->tpl->setVariable(
817 "PROPERTY_DESCRIPTION",
818 $item->getInfo()
819 );
820 $this->tpl->parseCurrentBlock();
821 }
822
823 if ($this->getMode() == "subform") {
824 // required
825 if (!$this->hideRequired($item->getType())) {
826 if ($item->getRequired()) {
827 $this->tpl->touchBlock("sub_required");
828 $this->required_text = true;
829 }
830 }
831
832 // hidden title (for accessibility, e.g. file upload)
833 if ($item->getHiddenTitle() != "") {
834 $this->tpl->setCurrentBlock("sub_hid_title");
835 $this->tpl->setVariable(
836 "SPHID_TITLE",
837 $item->getHiddenTitle()
838 );
839 $this->tpl->parseCurrentBlock();
840 }
841
842 $this->tpl->setCurrentBlock("sub_prop_start");
843 $this->tpl->setVariable("PROPERTY_TITLE", $item->getTitle());
844 $this->tpl->setVariable("PROPERTY_CLASS", "il_" . $item->getType());
845 if ($item->getType() != "non_editable_value" && $item->getFormLabelFor() != "") {
846 $this->tpl->setVariable("FOR_ID", ' for="'.$item->getFormLabelFor().'" ');
847 }
848 $this->tpl->setVariable("LAB_ID", $item->getFieldId());
849 $this->tpl->parseCurrentBlock();
850 } else {
851 // required
852 if (!$this->hideRequired($item->getType())) {
853 if ($item->getRequired()) {
854 $this->tpl->touchBlock("required");
855 $this->required_text = true;
856 }
857 }
858
859 // hidden title (for accessibility, e.g. file upload)
860 if ($item->getHiddenTitle() != "") {
861 $this->tpl->setCurrentBlock("std_hid_title");
862 $this->tpl->setVariable(
863 "PHID_TITLE",
864 $item->getHiddenTitle()
865 );
866 $this->tpl->parseCurrentBlock();
867 }
868
869 $this->tpl->setCurrentBlock("std_prop_start");
870 $this->tpl->setVariable("PROPERTY_TITLE", $item->getTitle());
871 if ($item->getType() != "non_editable_value" && $item->getFormLabelFor() != "") {
872 $this->tpl->setVariable("FOR_ID", ' for="'.$item->getFormLabelFor().'" ');
873 }
874 $this->tpl->setVariable("LAB_ID", $item->getFieldId());
875 if ($this->getHideLabels()) {
876 $this->tpl->setVariable("HIDE_LABELS_STYLE", " ilFormOptionHidden");
877 }
878 $this->tpl->parseCurrentBlock();
879 }
880
881 // alert
882 if ($item->getType() != "non_editable_value" && $item->getAlert() != "") {
883 $this->tpl->setCurrentBlock("alert");
884 $this->tpl->setVariable(
885 "IMG_ALERT",
886 ilUtil::getImagePath("icon_alert.svg")
887 );
888 $this->tpl->setVariable(
889 "ALT_ALERT",
890 $lng->txt("alert")
891 );
892 $this->tpl->setVariable(
893 "TXT_ALERT",
894 $item->getAlert()
895 );
896 $this->tpl->parseCurrentBlock();
897 }
898
899 // subitems
900 $sf = null;
901 if ($item->getType() != "non_editable_value" or 1) {
902 $sf = $item->getSubForm();
903 if ($item->hideSubForm() && is_object($sf)) {
904 $this->tpl->setCurrentBlock("sub_form_hide");
905 $this->tpl->setVariable("DSFID", $item->getFieldId());
906 $this->tpl->parseCurrentBlock();
907 }
908 }
909
910
911 $sf_content = "";
912 if (is_object($sf)) {
913 $sf_content = $sf->getContent();
914 if ($sf->getMultipart()) {
915 $this->setMultipart(true);
916 }
917 $this->tpl->setCurrentBlock("sub_form");
918 $this->tpl->setVariable("PROP_SUB_FORM", $sf_content);
919 $this->tpl->setVariable("SFID", $item->getFieldId());
920 $this->tpl->parseCurrentBlock();
921 }
922
923 $this->tpl->setCurrentBlock("prop");
924 /* not used yet
925 $this->tpl->setVariable("ID", $item->getFieldId());
926 $this->tpl->setVariable("CFG", ilJsonUtil::encode($cfg));*/
927 $this->tpl->parseCurrentBlock();
928 }
929
930
931 $this->tpl->touchBlock("item");
932 }
setMultipart($a_multipart)
Set Enctype Multipart/Formdata true/false.
getHideLabels()
Get a value indicating whether the labels should be hidden or not.
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Interface for multi values support.
catch(Exception $e) if(isset( $_POST[ 'cancel'])) if(isset($_POST['continue'])) $cfg

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_directorytarget directory (without filename!)
string$a_fieldform field
string$a_target_nametarget file name (if different from uploaded file)
mixed$a_indexform field index (if array)
mixed$a_sub_indexform field subindex (if array)
Returns
string target file name incl. path

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

1071 {
1072 if (!is_dir($a_target_directory)) {
1073 return;
1074 }
1075
1076 $data = $this->getFileUpload($a_field, $a_index, $a_sub_index);
1077 if ($data["tmp_name"] && file_exists($data["tmp_name"])) {
1078 if ($a_target_name) {
1079 $data["name"] = $a_target_name;
1080 }
1081
1082 $target_file = $a_target_directory . "/" . $data["name"];
1083 $target_file = str_replace("//", "/", $target_file);
1084
1085 if ($data["is_upload"]) {
1086 if (!ilUtil::moveUploadedFile($data["tmp_name"], $data["name"], $target_file)) {
1087 return;
1088 }
1089 } else {
1090 if (!rename($data["tmp_name"], $target_file)) {
1091 return;
1092 }
1093 }
1094
1095 return $target_file;
1096 }
1097 }

References $data, and getFileUpload().

+ Here is the call graph for this function:

◆ rebuildUploadedFiles()

ilPropertyFormGUI::rebuildUploadedFiles ( )
protected

try to rebuild files

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

1103 {
1104 if (isset($_POST["ilfilehash"]) && $_POST["ilfilehash"]) {
1105 $temp_path = ilUtil::getDataDir() . "/temp";
1106 if (is_dir($temp_path)) {
1107 $reload = array();
1108
1109 $temp_files = glob($temp_path . "/" . session_id() . "~~" . $_POST["ilfilehash"] . "~~*");
1110 if (is_array($temp_files)) {
1111 foreach ($temp_files as $full_file) {
1112 $file = explode("~~", basename($full_file));
1113 $field = $file[2];
1114 $idx = $file[3];
1115 $idx2 = $file[4];
1116 $type = $file[5] . "/" . $file[6];
1117 $name = $file[7];
1118
1119 if ($idx2 != "") {
1120 if (!$_FILES[$field]["tmp_name"][$idx][$idx2]) {
1121 $_FILES[$field]["tmp_name"][$idx][$idx2] = $full_file;
1122 $_FILES[$field]["name"][$idx][$idx2] = $name;
1123 $_FILES[$field]["type"][$idx][$idx2] = $type;
1124 $_FILES[$field]["error"][$idx][$idx2] = 0;
1125 $_FILES[$field]["size"][$idx][$idx2] = filesize($full_file);
1126 }
1127 } elseif ($idx != "") {
1128 if (!$_FILES[$field]["tmp_name"][$idx]) {
1129 $_FILES[$field]["tmp_name"][$idx] = $full_file;
1130 $_FILES[$field]["name"][$idx] = $name;
1131 $_FILES[$field]["type"][$idx] = $type;
1132 $_FILES[$field]["error"][$idx] = 0;
1133 $_FILES[$field]["size"][$idx] = filesize($full_file);
1134 }
1135 } else {
1136 if (!$_FILES[$field]["tmp_name"]) {
1137 $_FILES[$field]["tmp_name"] = $full_file;
1138 $_FILES[$field]["name"] = $name;
1139 $_FILES[$field]["type"] = $type;
1140 $_FILES[$field]["error"] = 0;
1141 $_FILES[$field]["size"] = filesize($full_file);
1142 }
1143 }
1144 }
1145 }
1146 }
1147 }
1148 }
static getDataDir()
get data directory (outside webspace)
$type

References $_POST, 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_postvarPost Var

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

301 {
302 foreach ($this->items as $key => $item) {
303 if (method_exists($item, "getPostVar") && $item->getPostVar() == $a_post_var) {
304 unset($this->items[$key]);
305 }
306 }
307
308 // remove section headers if they do not contain any items anymore
309 if ($a_remove_unused_headers) {
310 $unset_keys = array();
311 $last_item = null;
312 $last_key = null;
313 foreach ($this->items as $key => $item) {
314 if ($item instanceof ilFormSectionHeaderGUI && $last_item instanceof ilFormSectionHeaderGUI) {
315 $unset_keys[] = $last_key;
316 }
317 $last_item = $item;
318 $last_key = $key;
319 }
320 if ($last_item instanceof ilFormSectionHeaderGUI) {
321 $unset_keys[] = $last_key;
322 }
323 foreach ($unset_keys as $key) {
324 unset($this->items[$key]);
325 }
326 }
327 }
This class represents a section header in a property form.

References $key.

Referenced by ilObjItemGroupGUI\initEditCustomForm().

+ Here is the caller graph for this function:

◆ setDescription()

ilPropertyFormGUI::setDescription (   $a_val)

Set description.

Parameters
stringdescription

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

233 {
234 $this->description = $a_val;
235 }

◆ setDisableStandardMessage()

ilPropertyFormGUI::setDisableStandardMessage (   $a_val)

Set disable standard message.

Parameters
booleandisable standard message

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

400 {
401 $this->disable_standard_message = $a_val;
402 }

◆ setHideLabels()

ilPropertyFormGUI::setHideLabels (   $a_value = true)

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

Parameters
boolean$a_valueIndicates whether the labels should be hidden.

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

430 {
431 $this->hide_labels = $a_value;
432 }

◆ setItems()

ilPropertyFormGUI::setItems (   $a_items)

Set Items.

Parameters
array$a_itemsarray of item objects

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

355 {
356 $this->items = $a_items;
357 }

Referenced by ilAssQuestionAuthoringFormGUI\replaceFormItemByPostVar().

+ Here is the caller graph for this function:

◆ setMode()

ilPropertyFormGUI::setMode (   $a_mode)

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

Parameters
string$a_modeMode ('std', 'subform')

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

173 {
174 $this->mode = $a_mode;
175 }

◆ setShowTopButtons()

ilPropertyFormGUI::setShowTopButtons (   $a_val)

Get show top buttons.

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

272 {
273 $this->show_top_buttons = $a_val;
274 }

◆ setTableWidth()

ilPropertyFormGUI::setTableWidth (   $a_width)
final

Set table width.

@access public

Parameters
stringtable width

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

152 {
153 $this->tbl_width = $a_width;
154 }

Referenced by ilForumThreadFormGUI\initForm().

+ Here is the caller graph for this function:

◆ setTitle()

◆ setTitleIcon()

ilPropertyFormGUI::setTitleIcon (   $a_titleicon)

Set TitleIcon.

Parameters
string$a_titleiconTitleIcon

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

213 {
214 $this->titleicon = $a_titleicon;
215 }

Referenced by ilForumThreadFormGUI\initForm().

+ Here is the caller graph for this function:

◆ setTopAnchor()

ilPropertyFormGUI::setTopAnchor (   $a_val)

Set top anchor.

Parameters
stringtop anchor
Deprecated:

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

254 {
255 $this->top_anchor = $a_val;
256 }

◆ setValuesByArray()

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

Set form values from an array.

Parameters
array$a_valuesValue array (key is post variable name, value is value)

Reimplemented in ilAddAnswerModalFormGUI.

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

440 {
441 foreach ($this->items as $item) {
442 if (!($a_restrict_to_value_keys) ||
443 in_array($item->getPostVar(), array_keys($a_values))) {
444 $item->setValueByArray($a_values);
445 }
446 }
447 }

Referenced by ilBiblLibraryFormGUI\fillForm(), ilBiblFieldFilterFormGUI\fillForm(), ilFileVersionFormGUI\fillForm(), ilOrgUnitAuthorityFormGUI\fillForm(), ilOrgUnitPositionFormGUI\fillForm(), ilOrgUnitDefaultPermissionFormGUI\fillForm(), arConfigFormGUI\fillForm(), ilMemcacheServerFormGUI\fillForm(), ilIndividualAssessmentMemberGUI\fillForm(), ilIndividualAssessmentSettingsGUI\fillForm(), ilIndividualAssessmentSettingsGUI\fillInfoForm(), ilExAssignmentEditorGUI\getAssignmentValues(), ilNewsItemGUI\getValuesNewsItem(), ilMailOptionsFormGUI\populate(), and ilPersonalChatSettingsFormGUI\showChatOptions().

+ Here is the caller graph for this function:

◆ setValuesByPost()

ilPropertyFormGUI::setValuesByPost ( )

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

◆ $description

ilPropertyFormGUI::$description = ""
protected

◆ $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

◆ $mode

ilPropertyFormGUI::$mode = "std"
protected

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

Referenced by ilFileVersionFormGUI\__construct(), and 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

◆ $user

ilPropertyFormGUI::$user
protected

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