Collaboration diagram for ilFileUploadGUI:

Public Member Functions
	__construct ($a_drop_zone_id, $a_ref_id=null, $current_obj=false)
	Creates a new file upload GUI. More...

	getHTML ()
	Gets the HTML code to enable the file upload. More...

	enableFormSubmit ($input_field_id, $a_submit_name, $a_cancel_name)

	setMaxFileSize ($a_max)
	Sets the maximum file size in bytes. More...

	getMaxFileSize ()
	Gets the maximum file size in bytes. More...

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

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

	setSuffixes ($a_suffixes)
	Set accepted suffixes. More...

	getSuffixes ()
	Get accepted suffixes. More...

	setInputFieldName ($a_name)
	Sets the name of the input field the files are submitted with. More...

	getInputFieldName ()
	Gets the name of the input field the files are submitted with. More...

	setDropAreaId ($a_id)

	getDropAreaId ()

	setFileListId ($a_id)

	getFileListId ()

	setFileSelectButtonId ($a_id)

	getFileSelectButtonId ()

Static Public Member Functions
static	initFileUpload ()
	Initializes the file upload and loads the needed javascripts and styles. More...

Data Fields
const	FILE_OBJ_GUI_CLASS = "ilObjFileGUI"

Protected Member Functions
	getSharedHtml ()
	Gets the code that is shared by all upload instances. More...

	buildSuffixList ($suffixes)

Private Member Functions
	getUploadUrl ()

	makeJqueryId ($a_id)

Private Attributes
	$drop_zone_id = null

	$ref_id = null

	$current_obj = false

	$max_file_size = null

	$suffixes = array()

	$archive_suffixes = array()

	$input_field_name = "upload_files"

	$input_field_id = null

	$use_form = false

	$drop_area_id = null

	$submit_button_name = null

	$cancel_button_name = null

	$file_list_id = null

	$file_select_button_id = null

Static Private Attributes
static	$shared_code_loaded = false

Detailed Description

Definition at line 15 of file class.ilFileUploadGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileUploadGUI::__construct	(	$a_drop_zone_id,
		$a_ref_id = `null`,
		$current_obj = `false`
	)

Creates a new file upload GUI.

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

References $current_obj, $DIC, and $ilCtrl.

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         
         $this->drop_zone_id = $a_drop_zone_id;
         $this->ref_id = $a_ref_id;
         $this->current_obj = $current_obj;
     }

Member Function Documentation

◆ buildSuffixList()

ilFileUploadGUI::buildSuffixList ( $suffixes )

protected

Definition at line 248 of file class.ilFileUploadGUI.php.

References $list, and $suffixes.

Referenced by getHTML().

     {
         $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:

◆ enableFormSubmit()

ilFileUploadGUI::enableFormSubmit	(	$input_field_id,
		$a_submit_name,
		$a_cancel_name
	)

Definition at line 262 of file class.ilFileUploadGUI.php.

References $input_field_id.

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

◆ getArchiveSuffixes()

ilFileUploadGUI::getArchiveSuffixes ( )

Get accepted archive suffixes.

Returns: array Accepted archive suffixes.

Definition at line 303 of file class.ilFileUploadGUI.php.

References $archive_suffixes.

Referenced by getHTML().

     {
         return $this->archive_suffixes;
     }

Here is the caller graph for this function:

◆ getDropAreaId()

ilFileUploadGUI::getDropAreaId ( )

Definition at line 353 of file class.ilFileUploadGUI.php.

References $drop_area_id.

     {
         return $this->drop_area_id;
     }

◆ getFileListId()

ilFileUploadGUI::getFileListId ( )

Definition at line 363 of file class.ilFileUploadGUI.php.

References $file_list_id.

     {
         return $this->file_list_id;
     }

◆ getFileSelectButtonId()

ilFileUploadGUI::getFileSelectButtonId ( )

Definition at line 373 of file class.ilFileUploadGUI.php.

References $file_select_button_id.

     {
         return $this->file_select_button_id;
     }

◆ getHTML()

ilFileUploadGUI::getHTML ( )

Gets the HTML code to enable the file upload.

Returns: string The created HTML.

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

References $cancel_button_name, $DIC, $id, $ilCtrl, $input_field_name, $lng, PHPMailer\PHPMailer\$options, $ref_id, $submit_button_name, $title, $tpl, $url, ilObject\_lookupObjId(), ilObject\_lookupTitle(), buildSuffixList(), ilJsonUtil\encode(), getArchiveSuffixes(), getMaxFileSize(), getSharedHtml(), getSuffixes(), getUploadUrl(), and makeJqueryId().

     {
         global $DIC;
         $lng = $DIC['lng'];
         $ilCtrl = $DIC['ilCtrl'];
         $tpl = $DIC['tpl'];
         
         // get values
         $id = $this->ref_id;
         
         // build options
         $options = new stdClass();
         $options->dropZone = $this->makeJqueryId($this->drop_zone_id);
         
         // set url
         $url = $this->getUploadUrl();
         if ($url === false) {
             return "";
         }
             
         if ($url != null) {
             $options->url = $this->getUploadUrl();
         }
         
         // get title and replace quotes with HTML entities
         if ($this->ref_id != null && !$this->use_form) {
             $title = ilObject::_lookupTitle(ilObject::_lookupObjId($this->ref_id));
             $title = str_replace("\"", "&quot;", $title);
             $title = str_replace("'", "&#039;", $title);
             $options->listTitle = $title;
         }
         
         // input field (use id if specified)
         if ($this->input_field_id != null) {
             $options->fileInput = $this->makeJqueryId($this->input_field_id);
         } elseif ($this->input_field_name != null) {
             $options->fileInput = $this->input_field_name;
         }
         
         // buttons
         if ($this->submit_button_name != null) {
             $options->submitButton = $this->submit_button_name;
         }
         if ($this->cancel_button_name != null) {
             $options->cancelButton = $this->cancel_button_name;
         }
         
         // drop area
         if ($this->drop_area_id != null) {
             $options->dropArea = $this->makeJqueryId($this->drop_area_id);
         }
         
         // file list
         if ($this->file_list_id != null) {
             $options->fileList = $this->makeJqueryId($this->file_list_id);
         }
         
         // file list
         if ($this->file_select_button_id != null) {
             $options->fileSelectButton = $this->makeJqueryId($this->file_select_button_id);
         }
         
         // max size
         $max_size = $this->getMaxFileSize();
         if ($max_size != null) {
             $options->maxFileSize = $max_size;
         }
         
         // allowed extensions
         $allowed_suffixes = $this->buildSuffixList($this->getSuffixes());
         if ($allowed_suffixes != "") {
             $options->allowedExtensions = "[" . $allowed_suffixes . "]";
         }
         
         // supported archive extensions
         $supported_archives = $this->buildSuffixList($this->getArchiveSuffixes());
         if ($supported_archives != "") {
             $options->supportedArchives = "[" . $supported_archives . "]";
         }
         
         // inject load script
         include_once("./Services/JSON/classes/class.ilJsonUtil.php");
         
         $onLoadCode = "";
         if ($this->use_form) {
             $onLoadCode = "var fileUpload$id = new ilFileUpload($id, " . ilJsonUtil::encode($options) . ");";
         } else {
             $onLoadCode = "il.FileUpload.add(\"$id\", " . ilJsonUtil::encode($options) . ", " . ($this->current_obj ? "true" : "false") . ");";
         }
         
         $tpl->addOnLoadCode($onLoadCode);
         
         // return shared code
         return $this->getSharedHtml();
     }

Here is the call graph for this function:

◆ getInputFieldName()

ilFileUploadGUI::getInputFieldName ( )

Gets the name of the input field the files are submitted with.

Returns: string The name of the input field.

Definition at line 343 of file class.ilFileUploadGUI.php.

References $input_field_name.

     {
         return $this->input_field_name;
     }

◆ getMaxFileSize()

ilFileUploadGUI::getMaxFileSize ( )

Gets the maximum file size in bytes.

Definition at line 283 of file class.ilFileUploadGUI.php.

References $max_file_size.

Referenced by getHTML().

     {
         return $this->max_file_size;
     }

Here is the caller graph for this function:

◆ getSharedHtml()

ilFileUploadGUI::getSharedHtml ( )

protected

Gets the code that is shared by all upload instances.

Returns: string The shared code by all upload instances.

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

References $DIC, $lng, ilFileUploadSettings\getConcurrentUploads(), ilUtil\getImagePath(), and ilFileUploadUtil\getMaxFileSize().

Referenced by getHTML().

     {
         global $DIC;
         $lng = $DIC['lng'];
         
         // already loaded?
         if (self::$shared_code_loaded) {
             return "";
         }
 
         // make sure required scripts are loaded
         self::initFileUpload();
         
         // load script template
         $tpl_shared = new ilTemplate("tpl.fileupload_shared.html", true, true, "Services/FileUpload");
         
         // initialize localized texts
         $lng->loadLanguageModule("form");
         $tpl_shared->setCurrentBlock("fileupload_texts");
         $tpl_shared->setVariable("ERROR_MSG_FILE_TOO_LARGE", $lng->txt("form_msg_file_size_exceeds"));
         $tpl_shared->setVariable("ERROR_MSG_WRONG_FILE_TYPE", $lng->txt("form_msg_file_wrong_file_type"));
         $tpl_shared->setVariable("ERROR_MSG_EMPTY_FILE_OR_FOLDER", $lng->txt("error_empty_file_or_folder"));
         $tpl_shared->setVariable("ERROR_MSG_UPLOAD_ZERO_BYTES", $lng->txt("error_upload_was_zero_bytes"));
         $tpl_shared->setVariable("QUESTION_CANCEL_ALL", $lng->txt("cancel_file_upload"));
         $tpl_shared->setVariable("ERROR_MSG_EXTRACT_FAILED", $lng->txt("error_extraction_failed"));
         $tpl_shared->setVariable("PROGRESS_UPLOADING", $lng->txt("uploading"));
         $tpl_shared->setVariable("PROGRESS_EXTRACTING", $lng->txt("extracting"));
         $tpl_shared->setVariable("DROP_FILES_HERE", $lng->txt("drop_files_on_repo_obj_info"));
         $tpl_shared->parseCurrentBlock();
             
         // initialize default values
         $tpl_shared->setCurrentBlock("fileupload_defaults");
         $tpl_shared->setVariable("CONCURRENT_UPLOADS", ilFileUploadSettings::getConcurrentUploads());
         $tpl_shared->setVariable("MAX_FILE_SIZE", ilFileUploadUtil::getMaxFileSize());
         $tpl_shared->setVariable("ALLOWED_SUFFIXES", "");
         $tpl_shared->setVariable("SUPPORTED_ARCHIVES", "\"zip\"");
         $tpl_shared->parseCurrentBlock();
             
         // load panel template
         $tpl_panel = new ilTemplate("tpl.fileupload_panel_template.html", true, true, "Services/FileUpload");
         $tpl_panel->setVariable("TXT_HEADER", $lng->txt("upload_files_title"));
         $tpl_panel->setVariable("TXT_SHOW_ALL_DETAILS", $lng->txt('show_all_details'));
         $tpl_panel->setVariable("TXT_HIDE_ALL_DETAILS", $lng->txt('hide_all_details'));
         $tpl_panel->setVariable("TXT_SUBMIT", $lng->txt('upload_files'));
         $tpl_panel->setVariable("TXT_CANCEL", $lng->txt('cancel'));
             
         $tpl_shared->setCurrentBlock("fileupload_panel_tmpl");
         $tpl_shared->setVariable("PANEL_TEMPLATE_HTML", $tpl_panel->get());
         $tpl_shared->parseCurrentBlock();
             
         // load row template
         $tpl_row = new ilTemplate("tpl.fileupload_row_template.html", true, true, "Services/FileUpload");
         $tpl_row->setVariable("IMG_ALERT", ilUtil::getImagePath("icon_alert.svg"));
         $tpl_row->setVariable("ALT_ALERT", $lng->txt("alert"));
         $tpl_row->setVariable("TXT_CANCEL", $lng->txt("cancel"));
         $tpl_row->setVariable("TXT_REMOVE", $lng->txt("remove"));
         $tpl_row->setVariable("TXT_TITLE", $lng->txt("title"));
         $tpl_row->setVariable("TXT_DESCRIPTION", $lng->txt("description"));
         $tpl_row->setVariable("TXT_EXTRACT", $lng->txt("unzip"));
         $tpl_row->setVariable("TXT_KEEP_STRUCTURE", $lng->txt("take_over_structure"));
         $tpl_row->setVariable("TXT_KEEP_STRUCTURE_INFO", $lng->txt("take_over_structure_info"));
         $tpl_row->setVariable("TXT_PENDING", $lng->txt("upload_pending"));
             
         $tpl_shared->setCurrentBlock("fileupload_row_tmpl");
         $tpl_shared->setVariable("ROW_TEMPLATE_HTML", $tpl_row->get());
         $tpl_shared->parseCurrentBlock();
             
         // shared code now loaded
         self::$shared_code_loaded = true;
         
         // create HTML
         return $tpl_shared->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSuffixes()

ilFileUploadGUI::getSuffixes ( )

Get accepted suffixes.

Returns: array Accepted suffixes.

Definition at line 323 of file class.ilFileUploadGUI.php.

References $suffixes.

Referenced by getHTML().

     {
         return $this->suffixes;
     }

Here is the caller graph for this function:

◆ getUploadUrl()

ilFileUploadGUI::getUploadUrl ( )

private

Definition at line 378 of file class.ilFileUploadGUI.php.

References $DIC, $ilCtrl, and ilFileUploadUtil\isUploadSupported().

Referenced by getHTML().

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         
         // return null when the form is used
         if ($this->use_form) {
             return null;
         }
         
         // check if supported
         if (!ilFileUploadUtil::isUploadSupported()) {
             return false;
         }
             
         // build upload URL
         include_once("Modules/File/classes/class.ilObjFileGUI.php");
         $ilCtrl->setParameterByClass(self::FILE_OBJ_GUI_CLASS, "ref_id", $this->ref_id);
         $ilCtrl->setParameterByClass(self::FILE_OBJ_GUI_CLASS, "new_type", "file");
     
         return $ilCtrl->getFormActionByClass(self::FILE_OBJ_GUI_CLASS, "uploadFiles", "", true, false);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFileUpload()

static ilFileUploadGUI::initFileUpload ( )

static

Initializes the file upload and loads the needed javascripts and styles.

Definition at line 51 of file class.ilFileUploadGUI.php.

References $DIC, $tpl, and ilUtil\getStyleSheetLocation().

Referenced by ilObjectGUI\enableDragDropFileUpload(), ilCloudPluginItemCreationListGUI\getGroupedListItems(), ilObjectListGUI\insertFileUpload(), and ilDragDropFileInputGUI\render().

     {
         global $DIC;
         $tpl = $DIC['tpl'];
         
         // needed scripts
         $tpl->addJavaScript("./Services/FileUpload/js/tmpl.js");
         $tpl->addJavaScript("./Services/FileUpload/js/jquery.ui.widget.js");
         $tpl->addJavaScript("./Services/FileUpload/js/jquery.iframe-transport.js");
         $tpl->addJavaScript("./Services/FileUpload/js/jquery.fileupload.js");
         $tpl->addJavaScript("./Services/FileUpload/js/jquery.ba-dotimeout.min.js");
         $tpl->addJavaScript("./Services/FileUpload/js/ilFileUpload.js");
         
         // needed styles
         $tpl->addCss(ilUtil::getStyleSheetLocation("filesystem", "fileupload.css", "Services/FileUpload"));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeJqueryId()

ilFileUploadGUI::makeJqueryId ( $a_id )

private

Parameters

mixed $a_id

Returns: string

Definition at line 405 of file class.ilFileUploadGUI.php.

Referenced by getHTML().

     {
         if (is_string($a_id) && strlen($a_id) > 0 && $a_id[0] !== '#') {
             return '#' . $a_id;
         }
 
         return $a_id;
     }

Here is the caller graph for this function:

◆ setArchiveSuffixes()

ilFileUploadGUI::setArchiveSuffixes ( $a_suffixes )

Set accepted archive suffixes.

Parameters

array $a_suffixes Accepted archive suffixes.

Definition at line 293 of file class.ilFileUploadGUI.php.

     {
         $this->archive_suffixes = $a_suffixes;
     }

◆ setDropAreaId()

ilFileUploadGUI::setDropAreaId ( $a_id )

Definition at line 348 of file class.ilFileUploadGUI.php.

     {
         $this->drop_area_id = $a_id;
     }

◆ setFileListId()

ilFileUploadGUI::setFileListId ( $a_id )

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

     {
         $this->file_list_id = $a_id;
     }

◆ setFileSelectButtonId()

ilFileUploadGUI::setFileSelectButtonId ( $a_id )

Definition at line 368 of file class.ilFileUploadGUI.php.

     {
         $this->file_select_button_id = $a_id;
     }

◆ setInputFieldName()

ilFileUploadGUI::setInputFieldName ( $a_name )

Sets the name of the input field the files are submitted with.

Parameters

string $a_name The name of the input field.

Definition at line 333 of file class.ilFileUploadGUI.php.

     {
         $this->input_field_name = $a_name;
     }

◆ setMaxFileSize()

ilFileUploadGUI::setMaxFileSize ( $a_max )

Sets the maximum file size in bytes.

Parameters

int $a_max_size The maximum file size in bytes.

Definition at line 275 of file class.ilFileUploadGUI.php.

     {
         $this->max_file_size = $a_max;
     }

◆ setSuffixes()

ilFileUploadGUI::setSuffixes ( $a_suffixes )

Set accepted suffixes.

Parameters

array $a_suffixes Accepted suffixes.

Definition at line 313 of file class.ilFileUploadGUI.php.

     {
         $this->suffixes = $a_suffixes;
     }

Field Documentation

◆ $archive_suffixes

ilFileUploadGUI::$archive_suffixes = array()

private

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

Referenced by getArchiveSuffixes().

◆ $cancel_button_name

ilFileUploadGUI::$cancel_button_name = null

private

Definition at line 31 of file class.ilFileUploadGUI.php.

Referenced by getHTML().

◆ $current_obj

ilFileUploadGUI::$current_obj = false

private

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

Referenced by __construct().

◆ $drop_area_id

ilFileUploadGUI::$drop_area_id = null

private

Definition at line 29 of file class.ilFileUploadGUI.php.

Referenced by getDropAreaId().

◆ $drop_zone_id

ilFileUploadGUI::$drop_zone_id = null

private

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

◆ $file_list_id

ilFileUploadGUI::$file_list_id = null

private

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

Referenced by getFileListId().

◆ $file_select_button_id

ilFileUploadGUI::$file_select_button_id = null

private

Definition at line 33 of file class.ilFileUploadGUI.php.

Referenced by getFileSelectButtonId().

◆ $input_field_id

ilFileUploadGUI::$input_field_id = null

private

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

Referenced by enableFormSubmit().

◆ $input_field_name

ilFileUploadGUI::$input_field_name = "upload_files"

private

Definition at line 26 of file class.ilFileUploadGUI.php.

Referenced by getHTML(), and getInputFieldName().

◆ $max_file_size

ilFileUploadGUI::$max_file_size = null

private

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

Referenced by getMaxFileSize().

◆ $ref_id

ilFileUploadGUI::$ref_id = null

private

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

Referenced by getHTML().

◆ $shared_code_loaded

ilFileUploadGUI::$shared_code_loaded = false

staticprivate

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

◆ $submit_button_name

ilFileUploadGUI::$submit_button_name = null

private

Definition at line 30 of file class.ilFileUploadGUI.php.

Referenced by getHTML().

◆ $suffixes

ilFileUploadGUI::$suffixes = array()

private

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

Referenced by buildSuffixList(), and getSuffixes().

◆ $use_form

ilFileUploadGUI::$use_form = false

private

Definition at line 28 of file class.ilFileUploadGUI.php.

◆ FILE_OBJ_GUI_CLASS

const ilFileUploadGUI::FILE_OBJ_GUI_CLASS = "ilObjFileGUI"

Definition at line 17 of file class.ilFileUploadGUI.php.

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

Services/FileUpload/classes/class.ilFileUploadGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildSuffixList()

◆ enableFormSubmit()

◆ getArchiveSuffixes()

◆ getDropAreaId()

◆ getFileListId()

◆ getFileSelectButtonId()

◆ getHTML()

◆ getInputFieldName()

◆ getMaxFileSize()

◆ getSharedHtml()

◆ getSuffixes()

◆ getUploadUrl()

◆ initFileUpload()

◆ makeJqueryId()

◆ setArchiveSuffixes()

◆ setDropAreaId()

◆ setFileListId()

◆ setFileSelectButtonId()

◆ setInputFieldName()

◆ setMaxFileSize()

◆ setSuffixes()

Field Documentation

◆ $archive_suffixes

◆ $cancel_button_name

◆ $current_obj

◆ $drop_area_id

◆ $drop_zone_id

◆ $file_list_id

◆ $file_select_button_id

◆ $input_field_id

◆ $input_field_name

◆ $max_file_size

◆ $ref_id

◆ $shared_code_loaded

◆ $submit_button_name

◆ $suffixes

◆ $use_form

◆ FILE_OBJ_GUI_CLASS