ilDclPropertyFormGUI Class Reference

Class ilDclPropertyFormGUI @ilCtrl_Calls ilDclPropertyFormGUI: ilFormPropertyDispatchGUI. More...

Inheritance diagram for ilDclPropertyFormGUI:

Collaboration diagram for ilDclPropertyFormGUI:

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

Static Public Member Functions
static	getTempFilename (string $a_hash, string $a_field, string $a_name, string $a_type, ?string $a_index=null, ?string $a_sub_index=null)
static	rebuildTempFileByHash (string $hash)

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()
	getFileHash ()
	hideRequired (string $a_type)
	appendOnloadCode (string $html)
	rebuildUploadedFiles ()
	checkForRequiredField ()
Protected Attributes inherited from ilPropertyFormGUI
bool	$required_text = false
ilLanguage	$lng
ilCtrl	$ctrl
ilTemplate	$tpl
ilObjUser	$user = null
ilSetting	$settings = null
string	$mode = "std"
bool	$check_input_called = false
bool	$disable_standard_message = false
string	$top_anchor = "il_form_top"
string	$title = ''
string	$titleicon = ""
string	$description = ""
string	$tbl_width = ""
bool	$show_top_buttons = true
bool	$hide_labels = false
bool	$force_top_buttons = false
HTTP Services	$http
Refinery Factory	$refinery = null
ilGlobalTemplateInterface	$global_tpl = null
	$onload_code = []
Protected Attributes inherited from ilFormGUI
string	$formaction = ""
bool	$multipart = false
bool	$keepopen = false
bool	$opentag = true
string	$id = ''
string	$name = ''
string	$target = ''
bool	$prevent_double_submission = false

Detailed Description

Class ilDclPropertyFormGUI @ilCtrl_Calls ilDclPropertyFormGUI: ilFormPropertyDispatchGUI.

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

Member Function Documentation

cleanupTempFiles()

ilDclPropertyFormGUI::cleanupTempFiles

(

string

$hash

)

Cleanup temp-files.

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

                                                  : void
    {
        $files = glob(ilFileUtils::getDataDir() . "/temp/" . session_id() . "~~" . $hash . "~~*");
 
        foreach ($files as $file) {
            if (file_exists($file)) {
                unlink($file);
            }
        }
    }

References $files, and ilFileUtils\getDataDir().

Here is the call graph for this function:

getTempFilename()

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

static

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

     : string {
        $a_name = ilFileUtils::getASCIIFilename($a_name);
 
        $tmp_file_name = implode(
            "~~",
            [
                session_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 = ilFileUtils::getDataDir() . "/temp/";
 
        return $temp_path . $tmp_file_name;
    }

Referenced by ilDclFileRecordFieldModel\handleFileUpload().

Here is the caller graph for this function:

keepTempFileUpload()

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

Expose method for save confirmation.

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

     : void {
        $this->keepFileUpload($a_hash, $a_field, $a_tmp_name, $a_name, $a_type, $a_index, $a_sub_index);
    }

rebuildTempFileByHash()

static ilDclPropertyFormGUI::rebuildTempFileByHash ( string  $hash )

static

Exceptions

ilDclException

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

                                                              : void
    {
        $temp_path = ilFileUtils::getDataDir() . "/temp";
        if (is_dir($temp_path)) {
            $temp_files = glob($temp_path . "/" . session_id() . "~~" . $hash . "~~*");
            if (is_array($temp_files)) {
                foreach ($temp_files as $full_file) {
                    $file = explode("~~", basename($full_file));
                    $field = $file[2];
                    $idx = $file[3];
                    $idx2 = $file[4];
                    $type = $file[5] . "/" . $file[6];
                    $name = $file[7];
 
                    if ($idx2 != "") {
                        if (!($_FILES[$field]["tmp_name"][$idx][$idx2] ?? false)) {
                            $_FILES[$field]["tmp_name"][$idx][$idx2] = $full_file;
                            $_FILES[$field]["name"][$idx][$idx2] = $name;
                            $_FILES[$field]["type"][$idx][$idx2] = $type;
                            $_FILES[$field]["error"][$idx][$idx2] = 0;
                            $_FILES[$field]["size"][$idx][$idx2] = filesize($full_file);
                        }
                    } else {
                        if ($idx != "") {
                            if (!($_FILES[$field]["tmp_name"][$idx] ?? false)) {
                                $_FILES[$field]["tmp_name"][$idx] = $full_file;
                                $_FILES[$field]["name"][$idx] = $name;
                                $_FILES[$field]["type"][$idx] = $type;
                                $_FILES[$field]["error"][$idx] = 0;
                                $_FILES[$field]["size"][$idx] = filesize($full_file);
                            }
                        } else {
                            if (!($_FILES[$field]["tmp_name"] ?? false)) {
                                $_FILES[$field]["tmp_name"] = $full_file;
                                $_FILES[$field]["name"] = $name;
                                $_FILES[$field]["type"] = $type;
                                $_FILES[$field]["error"] = 0;
                                $_FILES[$field]["size"] = filesize($full_file);
                            }
                        }
                    }
                }
            }
        } else {
            throw new ilDclException('temp dir path "' . $temp_path . '" is not a directory');
        }
    }

References ilFileUtils\getDataDir().

Referenced by ilDclRecordEditGUI\save().

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:

• components/ILIAS/DataCollection/classes/Helpers/class.ilDclPropertyFormGUI.php