ILIAS  release_7 Revision v7.30-3-g800a261c036
ilDclPropertyFormGUI Class Reference

Class ilDclPropertyFormGUI. More...

+ Inheritance diagram for ilDclPropertyFormGUI:
+ Collaboration diagram for ilDclPropertyFormGUI:

Public Member Functions

 keepTempFileUpload ($a_hash, $a_field, $a_tmp_name, $a_name, $a_type, $a_index=null, $a_sub_index=null)
 Expose method for save confirmation. More...
 
 cleanupTempFiles ($hash)
 Cleanup temp-files. More...
 
- Public Member Functions inherited from ilPropertyFormGUI
 __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...
 
 setForceTopButtons ($a_val)
 Set force top buttons. More...
 
 getForceTopButtons ()
 Get force 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...
 

Static Public Member Functions

static getTempFilename ($a_hash, $a_field, $a_name, $a_type, $a_index=null, $a_sub_index=null)
 return temp-filename More...
 
static rebuildTempFileByHash ($hash)
 Return temp files. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ilPropertyFormGUI
 hideRequired ($a_type)
 
 rebuildUploadedFiles ()
 try to rebuild files More...
 
- Protected Attributes inherited from ilPropertyFormGUI
 $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
 
 $force_top_buttons = false
 
- Protected Attributes inherited from ilFormGUI
 $formaction
 
 $multipart = false
 
 $keepopen = false
 
 $opentag = true
 
 $id
 
 $name
 
 $prevent_double_submission = false
 

Detailed Description

Member Function Documentation

◆ cleanupTempFiles()

ilDclPropertyFormGUI::cleanupTempFiles (   $hash)

Cleanup temp-files.

Parameters
$hash

Definition at line 127 of file class.ilDclPropertyFormGUI.php.

128 {
129 $files = glob(ilUtil::getDataDir() . "/temp/" . session_id() . "~~" . $hash . "~~*");
130
131 foreach ($files as $file) {
132 if (file_exists($file)) {
133 unlink($file);
134 }
135 }
136 }
static getDataDir()
get data directory (outside webspace)

References ilUtil\getDataDir().

+ Here is the call graph for this function:

◆ getTempFilename()

static ilDclPropertyFormGUI::getTempFilename (   $a_hash,
  $a_field,
  $a_name,
  $a_type,
  $a_index = null,
  $a_sub_index = null 
)
static

return temp-filename

Parameters
$a_hash
$a_field
$a_name
$a_type
null$a_index
null$a_sub_index
Returns
string

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

43 {
44 $a_name = ilUtil::getAsciiFileName($a_name);
45
46 $tmp_file_name = implode(
47 "~~",
48 array(
49 session_id(),
50 $a_hash,
51 $a_field,
52 $a_index,
53 $a_sub_index,
54 str_replace("/", "~~", $a_type),
55 str_replace("~~", "_", $a_name),
56 )
57 );
58
59 // make sure temp directory exists
60 $temp_path = ilUtil::getDataDir() . "/temp/";
61
62 return $temp_path . $tmp_file_name;
63 }

References ilUtil\getDataDir().

Referenced by ilDclMobRecordFieldModel\parseValue().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ keepTempFileUpload()

ilDclPropertyFormGUI::keepTempFileUpload (   $a_hash,
  $a_field,
  $a_tmp_name,
  $a_name,
  $a_type,
  $a_index = null,
  $a_sub_index = null 
)

Expose method for save confirmation.

Parameters
$a_hash
$a_field
$a_tmp_name
$a_name
$a_type
null$a_index
null$a_sub_index

Definition at line 24 of file class.ilDclPropertyFormGUI.php.

25 {
26 $this->keepFileUpload($a_hash, $a_field, $a_tmp_name, $a_name, $a_type, $a_index, $a_sub_index);
27 }

◆ rebuildTempFileByHash()

static ilDclPropertyFormGUI::rebuildTempFileByHash (   $hash)
static

Return temp files.

Parameters
$hash
Exceptions
ilDclException

Definition at line 73 of file class.ilDclPropertyFormGUI.php.

74 {
75 $temp_path = ilUtil::getDataDir() . "/temp";
76 if (is_dir($temp_path)) {
77 $temp_files = glob($temp_path . "/" . session_id() . "~~" . $hash . "~~*");
78 if (is_array($temp_files)) {
79 foreach ($temp_files as $full_file) {
80 $file = explode("~~", basename($full_file));
81 $field = $file[2];
82 $idx = $file[3];
83 $idx2 = $file[4];
84 $type = $file[5] . "/" . $file[6];
85 $name = $file[7];
86
87 if ($idx2 != "") {
88 if (!$_FILES[$field]["tmp_name"][$idx][$idx2]) {
89 $_FILES[$field]["tmp_name"][$idx][$idx2] = $full_file;
90 $_FILES[$field]["name"][$idx][$idx2] = $name;
91 $_FILES[$field]["type"][$idx][$idx2] = $type;
92 $_FILES[$field]["error"][$idx][$idx2] = 0;
93 $_FILES[$field]["size"][$idx][$idx2] = filesize($full_file);
94 }
95 } else {
96 if ($idx != "") {
97 if (!$_FILES[$field]["tmp_name"][$idx]) {
98 $_FILES[$field]["tmp_name"][$idx] = $full_file;
99 $_FILES[$field]["name"][$idx] = $name;
100 $_FILES[$field]["type"][$idx] = $type;
101 $_FILES[$field]["error"][$idx] = 0;
102 $_FILES[$field]["size"][$idx] = filesize($full_file);
103 }
104 } else {
105 if (!$_FILES[$field]["tmp_name"]) {
106 $_FILES[$field]["tmp_name"] = $full_file;
107 $_FILES[$field]["name"] = $name;
108 $_FILES[$field]["type"] = $type;
109 $_FILES[$field]["error"] = 0;
110 $_FILES[$field]["size"] = filesize($full_file);
111 }
112 }
113 }
114 }
115 }
116 } else {
117 throw new ilDclException('temp dir path "' . $temp_path . '" is not a directory');
118 }
119 }
Class ilDclException.
$type

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

Referenced by ilDclRecordEditGUI\save(), and ilDclRecordListGUI\sendFile().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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