This class represents a file input property where multiple files can be dopped in a property form. More...

Inheritance diagram for ilDragDropFileInputGUI:

Collaboration diagram for ilDragDropFileInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setArchiveSuffixes ($a_suffixes)
	Set accepted archive suffixes. More...

	getArchiveSuffixes ()
	Get accepted archive suffixes. More...

	setCommandButtonNames ($a_submit_name, $a_cancel_name)

	render ($a_mode="")
	Render html. More...

	checkInput ()
	Check input, strip slashes etc. More...

Public Member Functions inherited from ilFileInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setValueByArray ($a_values)
	Set value by array. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setSize ($a_size)
	Set Size. More...

	getSize ()
	Get Size. More...

	setFilename ($a_val)
	Set filename value (if filename selection is enabled) More...

	getFilename ()
	Get Value. More...

	setSuffixes ($a_suffixes)
	Set Accepted Suffixes. More...

	getSuffixes ()
	Get Accepted Suffixes. More...

	setForbiddenSuffixes ($a_suffixes)
	Set forbidden Suffixes. More...

	getForbiddenSuffixes ()
	Get Accepted Suffixes. More...

	setPending ($a_val)
	Set pending filename value. More...

	getPending ()
	Get pending filename. More...

	enableFileNameSelection ($a_post_var)
	If enabled, users get the possibility to enter a filename for the uploaded file. More...

	isFileNameSelectionEnabled ()
	Check if filename selection is enabled. More...

	getFileNamePostVar ()
	Get file name post var. More...

	setALlowDeletion ($a_val)
	Set allow deletion. More...

	getALlowDeletion ()
	Get allow deletion. More...

	checkInput ()
	Check input, strip slashes etc. More...

	render ($a_mode="")
	Render html. More...

	insert ($a_tpl)
	Insert property html. More...

	getDeletionFlag ()
	Get deletion flag. More...

	getToolbarHTML ()
	Get HTML for toolbar. More...

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

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

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

Protected Member Functions
	getInputAcceptSuffixes ($suffixes)

	buildSuffixList ($suffixes)

	getMaxFileSize ()

Protected Member Functions inherited from ilFileInputGUI
	outputSuffixes ($a_tpl, $a_block="allowed_suffixes")

	getMaxFileSizeString ()

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes
	$lng

Protected Attributes inherited from ilFileInputGUI
	$lng

	$size = 40

	$pending

	$allow_deletion

	$forbidden_suffixes = array()

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$ctrl

	$lng

	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Static Private Member Functions
static	getNextUniqueId ()

Private Attributes
	$uniqueId = 0

	$archive_suffixes = array()

	$submit_button_name = null

	$cancel_button_name = null

Static Private Attributes
static	$uniqueInc = 1

Additional Inherited Members
Static Public Member Functions inherited from ilFileInputGUI
static	setPersonalWorkspaceQuotaCheck ($a_value)

Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Static Protected Attributes inherited from ilFileInputGUI
static	$check_wsp_quota

Detailed Description

This class represents a file input property where multiple files can be dopped in a property form.

Author: Stefan Born stefa.nosp@m.n.bo.nosp@m.rn@ph.nosp@m.zh.c.nosp@m.h

Version: $Id$

Definition at line 13 of file class.ilDragDropFileInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDragDropFileInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 38 of file class.ilDragDropFileInputGUI.php.

References $DIC.

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         parent::__construct($a_title, $a_postvar);
         $this->uniqueId = self::getNextUniqueId();
     }

Member Function Documentation

◆ buildSuffixList()

ilDragDropFileInputGUI::buildSuffixList ( $suffixes )

protected

Definition at line 193 of file class.ilDragDropFileInputGUI.php.

References $list.

     {
         $list = $delim = "";
         
         if (is_array($suffixes) && count($suffixes) > 0) {
             foreach ($suffixes as $suffix) {
                 $list .= $delim . "\"" . $suffix . "\"";
                 $delim = ", ";
             }
         }
         
         return $list;
     }

◆ checkInput()

ilDragDropFileInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

References $_POST, $lng, ilFormPropertyGUI\getPostVar(), ilStr\normalizeUtf8String(), and ilFormPropertyGUI\setAlert().

     {
         $lng = $this->lng;
         
         // if no information is received, something went wrong
         // this is e.g. the case, if the post_max_size has been exceeded
         if (!is_array($_FILES[$this->getPostVar()])) {
             $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
             return false;
         }
         
         // empty file, could be a folder
         if ($_FILES[$this->getPostVar()]["size"] < 1) {
             $this->setAlert($lng->txt("error_upload_was_zero_bytes"));
             return false;
         }
 
         // call base
         $inputValid = parent::checkInput();
         
         // set additionally sent input on post array
         if ($inputValid) {
             $_POST[$this->getPostVar()]["extract"] = isset($_POST["extract"]) ? (bool) $_POST["extract"] : false;
             $_POST[$this->getPostVar()]["title"] = isset($_POST["title"]) ? $_POST["title"] : "";
             $_POST[$this->getPostVar()]["description"] = isset($_POST["description"]) ? $_POST["description"] : "";
             $_POST[$this->getPostVar()]["keep_structure"] = isset($_POST["keep_structure"]) ? (bool) $_POST["keep_structure"] : true;
 
             include_once("./Services/Utilities/classes/class.ilStr.php");
             $_POST[$this->getPostVar()]["name"] = ilStr::normalizeUtf8String($_POST[$this->getPostVar()]["name"]);
             $_POST[$this->getPostVar()]["title"] = ilStr::normalizeUtf8String($_POST[$this->getPostVar()]["title"]);
         }
         
         return $inputValid;
     }

Here is the call graph for this function:

◆ getArchiveSuffixes()

ilDragDropFileInputGUI::getArchiveSuffixes ( )

Get accepted archive suffixes.

Returns: array Accepted archive suffixes.

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

References $archive_suffixes.

     {
         return $this->archive_suffixes;
     }

◆ getInputAcceptSuffixes()

ilDragDropFileInputGUI::getInputAcceptSuffixes ( $suffixes )

protected

Definition at line 179 of file class.ilDragDropFileInputGUI.php.

References $list.

Referenced by render().

     {
         $list = $delim = "";
         
         if (is_array($suffixes) && count($suffixes) > 0) {
             foreach ($suffixes as $suffix) {
                 $list .= $delim . "." . $suffix;
                 $delim = ",";
             }
         }
         
         return $list;
     }

Here is the caller graph for this function:

◆ getMaxFileSize()

ilDragDropFileInputGUI::getMaxFileSize ( )

protected

Definition at line 207 of file class.ilDragDropFileInputGUI.php.

References array.

     {
         // get the value for the maximal uploadable filesize from the php.ini (if available)
         $umf = ini_get("upload_max_filesize");
         // get the value for the maximal post data from the php.ini (if available)
         $pms = ini_get("post_max_size");
     
         //convert from short-string representation to "real" bytes
         $multiplier_a=array("K"=>1024, "M"=>1024*1024, "G"=>1024*1024*1024);
     
         $umf_parts=preg_split("/(\d+)([K|G|M])/", $umf, -1, PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY);
         $pms_parts=preg_split("/(\d+)([K|G|M])/", $pms, -1, PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY);
     
         if (count($umf_parts) == 2) {
             $umf = $umf_parts[0]*$multiplier_a[$umf_parts[1]];
         }
         if (count($pms_parts) == 2) {
             $pms = $pms_parts[0]*$multiplier_a[$pms_parts[1]];
         }
     
         // use the smaller one as limit
         $max_filesize = min($umf, $pms);
     
         if (!$max_filesize) {
             $max_filesize=max($umf, $pms);
         }
         
         return $max_filesize;
     }

◆ getNextUniqueId()

static ilDragDropFileInputGUI::getNextUniqueId ( )

staticprivate

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

     {
         return self::$uniqueInc++;
     }

◆ render()

ilDragDropFileInputGUI::render ( $a_mode = "" )

Render html.

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

References $lng, ilObject\_getIcon(), getInputAcceptSuffixes(), ilFileInputGUI\getMaxFileSizeString(), ilDiskQuotaHandler\getStatusLegend(), ilFileInputGUI\getSuffixes(), ilFileUploadGUI\initFileUpload(), iljQueryUtil\initjQuery(), ilDiskQuotaHandler\isUploadPossible(), and ilFileInputGUI\outputSuffixes().

     {
         $lng = $this->lng;
 
         $quota_exceeded = $quota_legend = false;
         if (self::$check_wsp_quota) {
             include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
             if (!ilDiskQuotaHandler::isUploadPossible()) {
                 $lng->loadLanguageModule("file");
                 return $lng->txt("personal_workspace_quota_exceeded_warning");
             } else {
                 $quota_legend = ilDiskQuotaHandler::getStatusLegend();
             }
         }
 
         // make sure jQuery is loaded
         iljQueryUtil::initjQuery();
         
         // add file upload scripts
         include_once("./Services/FileUpload/classes/class.ilFileUploadGUI.php");
         ilFileUploadGUI::initFileUpload();
         
         // load template
         $this->tpl = new ilTemplate("tpl.prop_dndfiles.html", true, true, "Services/Form");
         
         // general variables
         $this->tpl->setVariable("UPLOAD_ID", $this->uniqueId);
         
         // input
         $this->tpl->setVariable("FILE_SELECT_ICON", ilObject::_getIcon("", "", "fold"));
         $this->tpl->setVariable("TXT_SHOW_ALL_DETAILS", $lng->txt('show_all_details'));
         $this->tpl->setVariable("TXT_HIDE_ALL_DETAILS", $lng->txt('hide_all_details'));
         $this->tpl->setVariable("TXT_SELECTED_FILES", $lng->txt('selected_files'));
         $this->tpl->setVariable("TXT_DRAG_FILES_HERE", $lng->txt('drag_files_here'));
         $this->tpl->setVariable("TXT_NUM_OF_SELECTED_FILES", $lng->txt('num_of_selected_files'));
         $this->tpl->setVariable("TXT_SELECT_FILES_FROM_COMPUTER", $lng->txt('select_files_from_computer'));
         $this->tpl->setVariable("TXT_OR", $lng->txt('logic_or'));
         $this->tpl->setVariable("INPUT_ACCEPT_SUFFIXES", $this->getInputAcceptSuffixes($this->getSuffixes()));
 
         // info
         $this->tpl->setCurrentBlock("max_size");
         $this->tpl->setVariable("TXT_MAX_SIZE", $lng->txt("file_notice") . " " . $this->getMaxFileSizeString());
         $this->tpl->parseCurrentBlock();
         
         if ($quota_legend) {
             $this->tpl->setVariable("TXT_MAX_SIZE", $quota_legend);
             $this->tpl->parseCurrentBlock();
         }
         
         $this->outputSuffixes($this->tpl);
         
         // create file upload object
         $upload = new ilFileUploadGUI("ilFileUploadDropZone_" . $this->uniqueId, $this->uniqueId, false);
         $upload->enableFormSubmit("ilFileUploadInput_" . $this->uniqueId, $this->submit_button_name, $this->cancel_button_name);
         $upload->setDropAreaId("ilFileUploadDropArea_" . $this->uniqueId);
         $upload->setFileListId("ilFileUploadList_" . $this->uniqueId);
         $upload->setFileSelectButtonId("ilFileUploadFileSelect_" . $this->uniqueId);
         
         $this->tpl->setVariable("FILE_UPLOAD", $upload->getHTML());
         
         return $this->tpl->get();
     }

Here is the call graph for this function:

◆ setArchiveSuffixes()

ilDragDropFileInputGUI::setArchiveSuffixes ( $a_suffixes )

Set accepted archive suffixes.

Parameters

array $a_suffixes Accepted archive suffixes.

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

Referenced by ilObjFileGUI\initMultiUploadForm().

     {
         $this->archive_suffixes = $a_suffixes;
     }

Here is the caller graph for this function:

◆ setCommandButtonNames()

ilDragDropFileInputGUI::setCommandButtonNames	(	$a_submit_name,
		$a_cancel_name
	)

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

     {
         $this->submit_button_name = $a_submit_name;
         $this->cancel_button_name = $a_cancel_name;
     }

Field Documentation

◆ $archive_suffixes

ilDragDropFileInputGUI::$archive_suffixes = array()

private

Definition at line 21 of file class.ilDragDropFileInputGUI.php.

Referenced by getArchiveSuffixes().

◆ $cancel_button_name

ilDragDropFileInputGUI::$cancel_button_name = null

private

Definition at line 23 of file class.ilDragDropFileInputGUI.php.

◆ $lng

ilDragDropFileInputGUI::$lng

protected

Definition at line 18 of file class.ilDragDropFileInputGUI.php.

Referenced by checkInput(), and render().

◆ $submit_button_name

ilDragDropFileInputGUI::$submit_button_name = null

private

Definition at line 22 of file class.ilDragDropFileInputGUI.php.

◆ $uniqueId

ilDragDropFileInputGUI::$uniqueId = 0

private

Definition at line 20 of file class.ilDragDropFileInputGUI.php.

◆ $uniqueInc

ilDragDropFileInputGUI::$uniqueInc = 1

staticprivate

Definition at line 25 of file class.ilDragDropFileInputGUI.php.

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

Services/Form/classes/class.ilDragDropFileInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildSuffixList()

◆ checkInput()

◆ getArchiveSuffixes()

◆ getInputAcceptSuffixes()

◆ getMaxFileSize()

◆ getNextUniqueId()

◆ render()

◆ setArchiveSuffixes()

◆ setCommandButtonNames()

Field Documentation

◆ $archive_suffixes

◆ $cancel_button_name

◆ $lng

◆ $submit_button_name

◆ $uniqueId

◆ $uniqueInc