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

Inheritance diagram for ilPropertyFormGUI:

Collaboration diagram for ilPropertyFormGUI:

Public Member Functions
	ilPropertyFormGUI ()
	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)
	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)
	Add Command button. More...

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

	getContent ()
	Get Content. More...

	insertItem ($item, $a_sub_item=false)

	getHTML ()

	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
	ilFormGUI ()
	Constructor. More...

	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
	keepFileUpload ($a_hash, $a_field, $a_tmp_name, $a_name, $a_type, $a_index=null, $a_sub_index=null)
	Import upload into temp directory. More...

	rebuildUploadedFiles ()
	try to rebuild files More...

Protected Attributes
	$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

	$reloaded_files

	$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$ ilPropertyFormGUI: ilFormPropertyDispatchGUI

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

Member Function Documentation

◆ addCommandButton()

ilPropertyFormGUI::addCommandButton	(	$a_cmd,
		$a_text
	)

Add Command button.

Parameters

string	Command
string	Text

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

Referenced by FormMailCodesGUI\__construct(), arConfigFormGUI\addCommandButtons(), ilChatroomFormFactory\applyValues(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilObjForumAdministrationGUI\getSettingsForm(), arEditGUI\initCommandButtons(), ilObjBibliographicAdminLibrariesFormGUI\initForm(), ilOrgUnitTypeFormGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), assOrderingQuestionGUI\populateCommandButtons(), ilOrgUnitTypeAdvancedMetaDataFormGUI\saveObject(), and ilObjOrgUnitSettingsFormGUI\saveObject().

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

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

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

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

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

References $_POST, $data, $file, $lng, $ok, getDisableStandardMessage(), keepFileUpload(), and ilUtil\sendFailure().

Referenced by arConfigFormGUI\fillObject(), ilOrgUnitTypeAdvancedMetaDataFormGUI\fillObject(), ilOrgUnitTypeFormGUI\fillObject(), ilObjOrgUnitSettingsFormGUI\fillObject(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilScoringAdjustmentGUI\outputAdjustQuestionForm(), ilObjBibliographicAdminLibrariesFormGUI\saveObject(), and arEditGUI\setArFieldsAfterSubmit().

         {
                 global $lng;
                 
                 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);
                                                                 }
                                                         }
                                                 }
                                                 else if($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"]);
                                 }
                         }
                 }
                 
                 
                 if (!$ok && !$this->getDisableStandardMessage())
                 {
                         ilUtil::sendFailure($lng->txt("form_input_not_valid"));
                 }
                 return $ok;
         }

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

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

◆ executeCommand()

& ilPropertyFormGUI::executeCommand ( )

Execute command.

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

References $_REQUEST, $cmd, $ilCtrl, and getItemByPostVar().

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

Here is the call graph for this function:

◆ getContent()

ilPropertyFormGUI::getContent ( )

Get Content.

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

References $_POST, $ilSetting, $ilUser, $lng, $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().

         {
                 global $lng, $tpl, $ilUser, $ilSetting;
         
                 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"]);
                                         $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"]);
                         $this->tpl->parseCurrentBlock();
                 }
                 
                 // 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();
         }

Here is the call graph for this function:

◆ getDescription()

ilPropertyFormGUI::getDescription ( )

Get description.

Returns: string description

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

References $description.

Referenced by getContent().

         {
                 return $this->description;
         }

Here is the caller graph for this function:

◆ getDisableStandardMessage()

ilPropertyFormGUI::getDisableStandardMessage ( )

Get disable standard message.

Returns: boolean disable standard message

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

References $disable_standard_message.

Referenced by checkInput().

         {
                 return $this->disable_standard_message;
         }

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

References $res.

Referenced by hasFileUpload(), and moveFileUpload().

         {
                 $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
                                 );
                         }
                         else if($this->reloaded_files[$a_field]["tmp_name"][$a_index][$a_sub_index])
                         {
                                 $res = array(
                                         "tmp_name" => $this->reloaded_files["tmp_name"][$a_index][$a_sub_index],
                                         "name" => $this->reloaded_files["name"][$a_index][$a_sub_index],
                                         "type" => $this->reloaded_files["type"][$a_index][$a_sub_index],
                                         "error" => $this->reloaded_files["error"][$a_index][$a_sub_index],
                                         "size" => $this->reloaded_files["size"][$a_index][$a_sub_index],
                                         "is_upload" => false
                                 );
                         }
                 }
                 else if($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($this->reloaded_files[$a_field]["tmp_name"][$a_index])
                         {
                                 $res = array(
                                         "tmp_name" => $this->reloaded_files[$a_field]["tmp_name"][$a_index],
                                         "name" => $this->reloaded_files[$a_field]["name"][$a_index],
                                         "type" => $this->reloaded_files[$a_field]["type"][$a_index],
                                         "error" => $this->reloaded_files[$a_field]["error"][$a_index],
                                         "size" => $this->reloaded_files[$a_field]["size"][$a_index],
                                         "is_upload" => false
                                 );
                         }
                 }
                 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
                                 );
                         }
                         else if($this->reloaded_files[$a_field]["tmp_name"])
                         {
                                 $res = array(
                                         "tmp_name" => $this->reloaded_files[$a_field]["tmp_name"],
                                         "name" => $this->reloaded_files[$a_field]["name"],
                                         "type" => $this->reloaded_files[$a_field]["type"],
                                         "error" => $this->reloaded_files[$a_field]["error"],
                                         "size" => $this->reloaded_files[$a_field]["size"],
                                         "is_upload" => false
                                 );
                         }
                 }
                 return $res;
         }

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

References $hide_labels.

Referenced by insertItem().

         {
                 return $this->hide_labels;      
         }

Here is the caller graph for this function:

◆ getHTML()

ilPropertyFormGUI::getHTML ( )

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

Referenced by SurveyQuestionGUI\addPhrase(), and arGUI\save().

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

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 public

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

References $_POST.

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

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

Referenced by ilTestSettingsChangeConfirmationGUI\populateParametersFromPropertyForm(), and ilObjTestSettingsScoringResultsGUI\showConfirmation().

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

Here is the caller graph for this function:

◆ getItemByPostVar()

ilPropertyFormGUI::getItemByPostVar ( $a_post_var )

Get Item by POST variable.

Parameters

string $a_postvar Post Var

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

References $ret.

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

Here is the caller graph for this function:

◆ getItems()

ilPropertyFormGUI::getItems ( )

Get Items.

Returns: array array of item objects

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

References $items.

Referenced by ilUserFormSettings\exportToForm(), arConfigFormGUI\fillForm(), ilUserFormSettings\importFromForm(), and arConfigFormGUI\saveObject().

         {
                 return $this->items;
         }

Here is the caller graph for this function:

◆ getMode()

ilPropertyFormGUI::getMode ( )

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

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

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

References $mode.

Referenced by getContent(), and insertItem().

         {
                 return $this->mode;
         }

Here is the caller graph for this function:

◆ getShowTopButtons()

ilPropertyFormGUI::getShowTopButtons ( )

Set show top buttons.

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

References $show_top_buttons.

Referenced by getContent().

         {
                 return $this->show_top_buttons;
         }

Here is the caller graph for this function:

◆ getTableWidth()

ilPropertyFormGUI::getTableWidth ( )

final

get table width

public

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

References $tbl_width.

Referenced by getContent().

         {
                 return $this->tbl_width;
         }

Here is the caller graph for this function:

◆ getTitle()

ilPropertyFormGUI::getTitle ( )

Get Title.

Returns: string Title

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

Referenced by getContent().

         {
                 return $this->title;
         }

Here is the caller graph for this function:

◆ getTitleIcon()

ilPropertyFormGUI::getTitleIcon ( )

Get TitleIcon.

Returns: string TitleIcon

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

References $titleicon.

Referenced by getContent().

         {
                 return $this->titleicon;
         }

Here is the caller graph for this function:

◆ getTopAnchor()

ilPropertyFormGUI::getTopAnchor ( )

Get top anchor.

Returns: string top anchor

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

References $top_anchor.

Referenced by getContent().

         {
                 return $this->top_anchor;
         }

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

References $data, and getFileUpload().

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

Here is the call graph for this function:

◆ ilPropertyFormGUI()

ilPropertyFormGUI::ilPropertyFormGUI ( )

Constructor.

Parameters

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

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

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

         {
                 global $lng;
                 
                 $lng->loadLanguageModule("form");
                 parent::ilFormGUI();
 
                 // avoid double submission
                 $this->setPreventDoubleSubmission(true);
 
                 // do it as early as possible
                 $this->rebuildUploadedFiles();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertItem()

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

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

References $lng, $tpl, addItem(), getHideLabels(), ilUtil\getImagePath(), getMode(), ilFormGUI\setMultipart(), and ilHiddenInputGUI\setValue().

Referenced by getContent().

         {
                 global $tpl, $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 ($item->getType() != "non_editable_value")
                                 {
                                         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 ($item->getType() != "non_editable_value")
                                 {
                                         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
                         include_once("./Services/JSON/classes/class.ilJsonUtil.php");
                         $this->tpl->setVariable("ID", $item->getFieldId());
                         $this->tpl->setVariable("CFG", ilJsonUtil::encode($cfg));*/
                         $this->tpl->parseCurrentBlock();
                 }
                 
                 
                 $this->tpl->touchBlock("item");
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ keepFileUpload()

ilPropertyFormGUI::keepFileUpload	(	$a_hash,
		$a_field,
		$a_tmp_name,
		$a_name,
		$a_type,
		$a_index = `null`,
		$a_sub_index = `null`
	)

protected

Import upload into temp directory.

Parameters

string	$a_hash	unique form hash
string	$a_field	form field
string	$a_tmp_name	temp file name
string	$a_name	original file name
string	$a_type	file mime type
mixed	$a_index	form field index (if array)
mixed	$a_sub_index	form field subindex (if array)

Returns: bool

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

References $ilUser, ilUtil\createDirectory(), and ilUtil\getDataDir().

Referenced by checkInput().

         {
                 global $ilUser;
                 
                 $user_id = $ilUser->getId();
                 if(!$user_id || $user_id == ANONYMOUS_USER_ID)
                 {
                         return;
                 }
                 
                 $a_name = ilUtil::getAsciiFileName($a_name);
                 
                 $tmp_file_name = implode("~~", array($user_id,
                         $a_hash,
                         $a_field,
                         $a_index,
                         $a_sub_index,
                         str_replace("/", "~~", $a_type),
                         str_replace("~~", "_", $a_name)));
                 
                 // make sure temp directory exists
                 $temp_path = ilUtil::getDataDir() . "/temp";
                 if (!is_dir($temp_path))
                 {
                         ilUtil::createDirectory($temp_path);
                 }
                 
                 move_uploaded_file($a_tmp_name, $temp_path."/".$tmp_file_name); 
         }

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

References $data, and getFileUpload().

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

Here is the call graph for this function:

◆ rebuildUploadedFiles()

ilPropertyFormGUI::rebuildUploadedFiles ( )

protected

try to rebuild files

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

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

Referenced by ilPropertyFormGUI().

         {
                 global $ilUser;
         
                 if($_POST["ilfilehash"])
                 {                                       
                         $user_id = $ilUser->getId();
                         $temp_path = ilUtil::getDataDir() . "/temp";
                         if(is_dir($temp_path) && $user_id && $user_id != ANONYMOUS_USER_ID)
                         {
                                 $reload = array();
                                 
                                 $temp_files = glob($temp_path."/".$ilUser->getId()."~~".$_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])
                                                         {
                                                                 $reload[$field]["tmp_name"][$idx][$idx2] = $full_file;
                                                                 $reload[$field]["name"][$idx][$idx2] = $name;
                                                                 $reload[$field]["type"][$idx][$idx2] = $type;
                                                                 $reload[$field]["error"][$idx][$idx2] = 0;
                                                                 $reload[$field]["size"][$idx][$idx2] = filesize($full_file);                                                            
                                                         }
                                                 }
                                                 else if($idx != "")
                                                 {
                                                         if(!$_FILES[$field]["tmp_name"][$idx])
                                                         {
                                                                 $reload[$field]["tmp_name"][$idx] = $full_file;
                                                                 $reload[$field]["name"][$idx] = $name;
                                                                 $reload[$field]["type"][$idx] = $type;
                                                                 $reload[$field]["error"][$idx] = 0;
                                                                 $reload[$field]["size"][$idx] = filesize($full_file);                                                           
                                                         }       
                                                 }
                                                 else
                                                 {
                                                         if(!$_FILES[$field]["tmp_name"])
                                                         {
                                                                 $reload[$field]["tmp_name"] = $full_file;
                                                                 $reload[$field]["name"] = $name;
                                                                 $reload[$field]["type"] = $type;
                                                                 $reload[$field]["error"] = 0;
                                                                 $reload[$field]["size"] = filesize($full_file);                                                         
                                                         }
                                                 }                                               
                                         }
                                 }
                                 
                                 $this->reloaded_files = $reload;
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeItemByPostVar()

ilPropertyFormGUI::removeItemByPostVar ( $a_post_var )

Remove Item.

Parameters

string $a_postvar Post Var

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

Referenced by ilTestSettingsGUI\removeHiddenItems().

         {
                 foreach ($this->items as $key => $item)
                 {
                         if (method_exists($item, "getPostVar") && $item->getPostVar() == $a_post_var)
                         {
                                 unset($this->items[$key]);
                         }
                 }
         }

Here is the caller graph for this function:

◆ setDescription()

ilPropertyFormGUI::setDescription ( $a_val )

Set description.

Parameters

string description

Definition at line 194 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 348 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 378 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 300 of file class.ilPropertyFormGUI.php.

         {
                 $this->items = $a_items;
         }

◆ setMode()

ilPropertyFormGUI::setMode ( $a_mode )

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

Parameters

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

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

         {
                 $this->mode = $a_mode;
         }

◆ setShowTopButtons()

ilPropertyFormGUI::setShowTopButtons ( $a_val )

Get show top buttons.

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

         {
                 $this->show_top_buttons = $a_val;
         }

◆ setTableWidth()

ilPropertyFormGUI::setTableWidth ( $a_width )

final

Set table width.

public

Parameters

string table width

Definition at line 113 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 154 of file class.ilPropertyFormGUI.php.

Referenced by FormMailCodesGUI\__construct(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), getContent(), ilObjForumAdministrationGUI\getSettingsForm(), ilObjExerciseGUI\initEditCustomForm(), arConfigFormGUI\initForm(), ilObjBibliographicAdminLibrariesFormGUI\initForm(), ilOrgUnitTypeFormGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), arEditGUI\initFormTitle(), ilOrgUnitTypeAdvancedMetaDataFormGUI\saveObject(), and ilObjOrgUnitSettingsFormGUI\saveObject().

         {
                 $this->title = $a_title;
         }

Here is the caller graph for this function:

◆ setTitleIcon()

ilPropertyFormGUI::setTitleIcon ( $a_titleicon )

Set TitleIcon.

Parameters

string $a_titleicon TitleIcon

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

         {
                 $this->titleicon = $a_titleicon;
         }

◆ setTopAnchor()

ilPropertyFormGUI::setTopAnchor ( $a_val )

Set top anchor.

Parameters

string top anchor

Definition at line 214 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 388 of file class.ilPropertyFormGUI.php.

Referenced by ilObjForumAdministrationGUI\editSettings(), arConfigFormGUI\fillForm(), ilObjBibliographicAdminLibrariesFormGUI\fillForm(), ilMarkSchemaGUI\populateEctsForm(), and ilObjWikiSettingsGUI\populateWithCurrentSettings().

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

Here is the caller graph for this function:

◆ setValuesByPost()

ilPropertyFormGUI::setValuesByPost ( )

Set form values from POST values.

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

References $_POST.

Referenced by ilOrgUnitTypeAdvancedMetaDataFormGUI\fillObject(), ilOrgUnitTypeFormGUI\fillObject(), ilObjOrgUnitSettingsFormGUI\fillObject(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), and ilScoringAdjustmentGUI\outputAdjustQuestionForm().

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