This class represents a file property in a property form. More...

Inheritance diagram for ilFileInputGUI:

Collaboration diagram for ilFileInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setValueByArray (array $a_values)

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

	getValue ()

	setSize (int $a_size)

	getSize ()

	setFilename (string $a_val)

	getFilename ()

	setSuffixes (array $a_suffixes)

	getSuffixes ()

	setForbiddenSuffixes (array $a_suffixes)

	getForbiddenSuffixes ()

	setPending (string $a_val)

	getPending ()

	enableFileNameSelection (string $a_post_var)

	isFileNameSelectionEnabled ()

	getFileNamePostVar ()

	setAllowDeletion (bool $a_val)

	getALlowDeletion ()

	checkInput ()

	getInput ()

	render (string $a_mode="")

	insert (ilTemplate $a_tpl)

	getDeletionFlag ()

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

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

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

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

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

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Member Functions
	outputSuffixes (ilTemplate $a_tpl, string $a_block="allowed_suffixes")

	getMaxFileSizeString ()

	getMaxFileUploads ()
	Get number of maximum file uploads as declared in php.ini. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Protected Attributes
int	$size = 40

string	$pending = ""

bool	$allow_deletion = false

bool	$filename_selection = false

array	$forbidden_suffixes = []

array	$suffixes = []

string	$value = ""

ILIAS FileUpload FileUpload	$upload_service

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Private Attributes
string	$filename = ""

string	$filename_post = ""

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

Detailed Description

This class represents a file property in a property form.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilFileInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

Definition at line 41 of file class.ilFileInputGUI.php.

References $DIC, ilFormPropertyGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), ilFormPropertyGUI\setHiddenTitle(), ilFormPropertyGUI\setType(), and ilLanguage\txt().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $lng = $DIC->language();
         $this->upload_service = $DIC->upload();
 
         parent::__construct($a_title, $a_postvar);
         $this->setType("file");
         $this->setHiddenTitle("(" . $lng->txt("form_file_input") . ")");
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilFileInputGUI::checkInput ( )

Definition at line 158 of file class.ilFileInputGUI.php.

References Vendor\Package\$e, ilFormPropertyGUI\$lng, ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getSuffixes(), getValue(), ILIAS\Repository\refinery(), ilFormPropertyGUI\setAlert(), setFilename(), ilFormPropertyGUI\str(), ilUtil\stripSlashes(), ilLanguage\txt(), and ilVirusScanner\virusHandling().

                                 : bool
     {
         if (!$this->upload_service->hasBeenProcessed()) {
             try {
                 $this->upload_service->process();
             } catch (IllegalStateException $e) {
                 $this->setAlert($e->getMessage());
                 return false;
             }
         }
 
         $lng = $this->lng;
 
         // #18756
         if ($this->getDisabled()) {
             return true;
         }
 
         // if no information is received, something went wrong
         // this is e.g. the case, if the post_max_size has been exceeded
         if (!isset($_FILES[$this->getPostVar()]) || !is_array($_FILES[$this->getPostVar()])) {
             $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
             return false;
         }
 
         $_FILES[$this->getPostVar()]["name"] = ilUtil::stripSlashes($_FILES[$this->getPostVar()]["name"]);
 
         $utf_normal = $this->refinery->string()->utfnormal()->formC();
         $_FILES[$this->getPostVar()]["name"] = $utf_normal->transform(($_FILES[$this->getPostVar()]["name"]));
 
         // remove trailing '/'
         $_FILES[$this->getPostVar()]["name"] = rtrim($_FILES[$this->getPostVar()]["name"], '/');
 
         $filename = $_FILES[$this->getPostVar()]["name"];
         $filename_arr = pathinfo($_FILES[$this->getPostVar()]["name"]);
         $suffix = $filename_arr["extension"] ?? '';
         $temp_name = $_FILES[$this->getPostVar()]["tmp_name"];
         $error = $_FILES[$this->getPostVar()]["error"];
 
         // error handling
         if ($error > 0) {
             switch ($error) {
                 case UPLOAD_ERR_FORM_SIZE:
                 case UPLOAD_ERR_INI_SIZE:
                     $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
                     return false;
 
                 case UPLOAD_ERR_PARTIAL:
                     $this->setAlert($lng->txt("form_msg_file_partially_uploaded"));
                     return false;
 
                 case UPLOAD_ERR_NO_FILE:
                     if ($this->getRequired()) {
                         if (!strlen($this->getValue())) {
                             $this->setAlert($lng->txt("form_msg_file_no_upload"));
                             return false;
                         }
                     }
                     break;
 
                 case UPLOAD_ERR_NO_TMP_DIR:
                     $this->setAlert($lng->txt("form_msg_file_missing_tmp_dir"));
                     return false;
 
                 case UPLOAD_ERR_CANT_WRITE:
                     $this->setAlert($lng->txt("form_msg_file_cannot_write_to_disk"));
                     return false;
 
                 case UPLOAD_ERR_EXTENSION:
                     $this->setAlert($lng->txt("form_msg_file_upload_stopped_ext"));
                     return false;
             }
         }
 
         // check suffixes
         if ($_FILES[$this->getPostVar()]["tmp_name"] != "") {
             if (is_array($this->forbidden_suffixes) && in_array(strtolower($suffix), $this->forbidden_suffixes)) {
                 $this->setAlert($lng->txt("form_msg_file_type_is_not_allowed") . " (" . $suffix . ")");
                 return false;
             }
             if (is_array($this->getSuffixes()) && count($this->getSuffixes()) > 0) {
                 if (!in_array(strtolower($suffix), $this->getSuffixes())) {
                     $this->setAlert($lng->txt("form_msg_file_wrong_file_type"));
                     return false;
                 }
             }
         }
 
         // virus handling
         if ($_FILES[$this->getPostVar()]["tmp_name"] != "") {
             $vir = ilVirusScanner::virusHandling($temp_name, $filename);
             if ($vir[0] == false) {
                 $this->setAlert($lng->txt("form_msg_file_virus_found") . "<br />" . $vir[1]);
                 return false;
             }
         }
 
         $file_name = $this->str('file_name');
         if ($file_name === "") {
             $file_name = $_FILES[$this->getPostVar()]["name"];
         }
         $this->setFilename($file_name);
 
         return true;
     }

Here is the call graph for this function:

◆ enableFileNameSelection()

ilFileInputGUI::enableFileNameSelection ( string $a_post_var )

Definition at line 132 of file class.ilFileInputGUI.php.

Referenced by ilObjCourseGUI\initInfoEditor().

                                                                : void
     {
         $this->filename_selection = true;
         $this->filename_post = $a_post_var;
     }

Here is the caller graph for this function:

◆ getALlowDeletion()

ilFileInputGUI::getALlowDeletion ( )

Definition at line 153 of file class.ilFileInputGUI.php.

References $allow_deletion.

Referenced by render().

                                       : bool
     {
         return $this->allow_deletion;
     }

Here is the caller graph for this function:

◆ getDeletionFlag()

ilFileInputGUI::getDeletionFlag ( )

Definition at line 425 of file class.ilFileInputGUI.php.

References ilFormPropertyGUI\getPostVar().

                                      : bool
     {
         if ($this->int($this->getPostVar() . "_delete")) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ getFilename()

ilFileInputGUI::getFilename ( )

Definition at line 95 of file class.ilFileInputGUI.php.

References $filename.

Referenced by render().

                                  : string
     {
         return $this->filename;
     }

Here is the caller graph for this function:

◆ getFileNamePostVar()

ilFileInputGUI::getFileNamePostVar ( )

Definition at line 143 of file class.ilFileInputGUI.php.

References $filename_post.

Referenced by render(), and setValueByArray().

                                         : string
     {
         return $this->filename_post;
     }

Here is the caller graph for this function:

◆ getForbiddenSuffixes()

ilFileInputGUI::getForbiddenSuffixes ( )

Definition at line 115 of file class.ilFileInputGUI.php.

References $forbidden_suffixes.

                                           : array
     {
         return $this->forbidden_suffixes;
     }

◆ getInput()

ilFileInputGUI::getInput ( )

Definition at line 264 of file class.ilFileInputGUI.php.

References ilFormPropertyGUI\getPostVar().

                               : array
     {
         return $_FILES[$this->getPostVar()] ?? [];
     }

Here is the call graph for this function:

◆ getMaxFileSizeString()

ilFileInputGUI::getMaxFileSizeString ( )

protected

Definition at line 384 of file class.ilFileInputGUI.php.

Referenced by ilImagemapCorrectionsInputGUI\insert(), ilImageFileInputGUI\insert(), ilFileWizardInputGUI\insert(), ilImagemapFileInputGUI\insert(), and render().

                                              : string
     {
         // 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);
         }
 
         //format for display in mega-bytes
         $max_filesize = sprintf("%.1f MB", $max_filesize / 1024 / 1024);
 
         return $max_filesize;
     }

Here is the caller graph for this function:

◆ getMaxFileUploads()

ilFileInputGUI::getMaxFileUploads ( )

protected

Get number of maximum file uploads as declared in php.ini.

Definition at line 420 of file class.ilFileInputGUI.php.

Referenced by ilFileWizardInputGUI\insert().

                                           : int
     {
         return (int) ini_get("max_file_uploads");
     }

Here is the caller graph for this function:

◆ getPending()

ilFileInputGUI::getPending ( )

Definition at line 126 of file class.ilFileInputGUI.php.

References $pending.

Referenced by ilImageFileInputGUI\insert(), and render().

                                 : string
     {
         return $this->pending;
     }

Here is the caller graph for this function:

◆ getSize()

ilFileInputGUI::getSize ( )

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

References $size.

Referenced by render().

                              : int
     {
         return $this->size;
     }

Here is the caller graph for this function:

◆ getSuffixes()

ilFileInputGUI::getSuffixes ( )

Definition at line 105 of file class.ilFileInputGUI.php.

References $suffixes.

Referenced by ilFileWizardInputGUI\checkInput(), checkInput(), ilImagemapFileInputGUI\checkInput(), and outputSuffixes().

                                  : array
     {
         return $this->suffixes;
     }

Here is the caller graph for this function:

◆ getToolbarHTML()

ilFileInputGUI::getToolbarHTML ( )

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

Definition at line 433 of file class.ilFileInputGUI.php.

References render().

                                     : string
     {
         $html = $this->render("toolbar");
         return $html;
     }

Here is the call graph for this function:

◆ getValue()

ilFileInputGUI::getValue ( )

Definition at line 74 of file class.ilFileInputGUI.php.

References $value.

Referenced by checkInput(), ilImagemapFileInputGUI\checkInput(), ilImagemapCorrectionsInputGUI\insert(), ilImageFileInputGUI\insert(), ilImagemapFileInputGUI\insert(), and render().

                               : string
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilFileInputGUI::insert ( ilTemplate $a_tpl )

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

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                              : void
     {
         $html = $this->render();
 
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $html);
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ isFileNameSelectionEnabled()

ilFileInputGUI::isFileNameSelectionEnabled ( )

Definition at line 138 of file class.ilFileInputGUI.php.

References $filename_selection.

Referenced by render().

                                                 : bool
     {
         return $this->filename_selection;
     }

Here is the caller graph for this function:

◆ outputSuffixes()

ilFileInputGUI::outputSuffixes	(	ilTemplate	$a_tpl,
		string	$a_block = `"allowed_suffixes"`
	)

protected

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

References ilFormPropertyGUI\$lng, getSuffixes(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

Referenced by ilImageFileInputGUI\insert(), ilFileWizardInputGUI\insert(), ilImagemapFileInputGUI\insert(), and render().

      : void {
         $lng = $this->lng;
 
         if (is_array($this->getSuffixes()) && count($this->getSuffixes()) > 0) {
             $suff_str = $delim = "";
             foreach ($this->getSuffixes() as $suffix) {
                 $suff_str .= $delim . "." . $suffix;
                 $delim = ", ";
             }
             $a_tpl->setCurrentBlock($a_block);
             $a_tpl->setVariable(
                 "TXT_ALLOWED_SUFFIXES",
                 $lng->txt("file_allowed_suffixes") . " " . $suff_str
             );
             $a_tpl->parseCurrentBlock();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilFileInputGUI::render ( string $a_mode = "" )

Definition at line 269 of file class.ilFileInputGUI.php.

References ilFormPropertyGUI\$lng, getALlowDeletion(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getFilename(), getFileNamePostVar(), getMaxFileSizeString(), getPending(), ilFormPropertyGUI\getPostVar(), getSize(), getValue(), isFileNameSelectionEnabled(), outputSuffixes(), and ilLanguage\txt().

Referenced by getToolbarHTML(), and insert().

                                                : string
     {
         $lng = $this->lng;
 
         $quota_exceeded = $quota_legend = false;
 
         $f_tpl = new ilTemplate("tpl.prop_file.html", true, true, "Services/Form");
 
 
         // show filename selection if enabled
         if ($this->isFileNameSelectionEnabled()) {
             $f_tpl->setCurrentBlock('filename');
             $f_tpl->setVariable('POST_FILENAME', $this->getFileNamePostVar());
             $f_tpl->setVariable('VAL_FILENAME', $this->getFilename());
             $f_tpl->setVariable('FILENAME_ID', $this->getFieldId());
             $f_tpl->setVariable('TXT_FILENAME_HINT', $lng->txt('if_no_title_then_filename'));
             $f_tpl->parseCurrentBlock();
         } else {
             if (trim($this->getValue()) != "") {
                 if (!$this->getDisabled() && $this->getALlowDeletion()) {
                     $f_tpl->setCurrentBlock("delete_bl");
                     $f_tpl->setVariable("POST_VAR_D", $this->getPostVar());
                     $f_tpl->setVariable(
                         "TXT_DELETE_EXISTING",
                         $lng->txt("delete_existing_file")
                     );
                     $f_tpl->parseCurrentBlock();
                 }
 
                 $f_tpl->setCurrentBlock('prop_file_propval');
                 $f_tpl->setVariable('FILE_VAL', $this->getValue());
                 $f_tpl->parseCurrentBlock();
             }
         }
 
         if ($a_mode != "toolbar") {
             if (!$quota_exceeded) {
                 $this->outputSuffixes($f_tpl);
 
                 $f_tpl->setCurrentBlock("max_size");
                 $f_tpl->setVariable("TXT_MAX_SIZE", $lng->txt("file_notice") . " " .
                     $this->getMaxFileSizeString());
                 $f_tpl->parseCurrentBlock();
 
                 if ($quota_legend) {
                     $f_tpl->setVariable("TXT_MAX_SIZE", true);
                     $f_tpl->parseCurrentBlock();
                 }
             } else {
                 $f_tpl->setCurrentBlock("max_size");
                 $f_tpl->setVariable("TXT_MAX_SIZE", $quota_exceeded);
                 $f_tpl->parseCurrentBlock();
             }
         } elseif ($quota_exceeded) {
             return $quota_exceeded;
         }
 
         $pending = $this->getPending();
         if ($pending) {
             $f_tpl->setCurrentBlock("pending");
             $f_tpl->setVariable("TXT_PENDING", $lng->txt("file_upload_pending") .
                 ": " . htmlentities($pending));
             $f_tpl->parseCurrentBlock();
         }
 
         if ($this->getDisabled() || $quota_exceeded) {
             $f_tpl->setVariable(
                 "DISABLED",
                 " disabled=\"disabled\""
             );
         }
 
         $f_tpl->setVariable("POST_VAR", $this->getPostVar());
         $f_tpl->setVariable("ID", $this->getFieldId());
         $f_tpl->setVariable("SIZE", $this->getSize());
 
 
         /* experimental: bootstrap'ed file upload */
         $f_tpl->setVariable("TXT_BROWSE", $lng->txt("select_file"));
 
 
         return $f_tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllowDeletion()

ilFileInputGUI::setAllowDeletion ( bool $a_val )

Definition at line 148 of file class.ilFileInputGUI.php.

Referenced by ilObjCmiXapiGUI\initCreateForm(), ilBookingObjectGUI\initForm(), ilCalendarCategoryGUI\initImportForm(), and ilObjUserFolderGUI\initNewAccountMailForm().

                                                  : void
     {
         $this->allow_deletion = $a_val;
     }

Here is the caller graph for this function:

◆ setFilename()

ilFileInputGUI::setFilename ( string $a_val )

Definition at line 90 of file class.ilFileInputGUI.php.

Referenced by checkInput(), and setValueByArray().

                                               : void
     {
         $this->filename = $a_val;
     }

Here is the caller graph for this function:

◆ setForbiddenSuffixes()

ilFileInputGUI::setForbiddenSuffixes ( array $a_suffixes )

Definition at line 110 of file class.ilFileInputGUI.php.

                                                            : void
     {
         $this->forbidden_suffixes = $a_suffixes;
     }

◆ setPending()

ilFileInputGUI::setPending ( string $a_val )

Definition at line 121 of file class.ilFileInputGUI.php.

                                              : void
     {
         $this->pending = $a_val;
     }

◆ setSize()

ilFileInputGUI::setSize ( int $a_size )

Definition at line 79 of file class.ilFileInputGUI.php.

Referenced by ilFileSystemGUI\listFiles().

                                         : void
     {
         $this->size = $a_size;
     }

Here is the caller graph for this function:

◆ setSuffixes()

ilFileInputGUI::setSuffixes ( array $a_suffixes )

Definition at line 100 of file class.ilFileInputGUI.php.

Referenced by ilImageFileInputGUI\__construct(), ilDidacticTemplateSettingsGUI\createImportForm(), ilObjHelpSettingsGUI\editSettings(), ilNewsItemGUI\getEditForm(), ilContentStyleImageGUI\getImageForm(), ilObjSurveyQuestionPoolGUI\getImportForm(), ilPCMediaObjectEditorGUI\getUploadForm(), ilObjMediaCastGUI\initAddCastItemForm(), ilPCInteractiveImageGUI\initAddOverlaysForm(), ilBadgeManagementGUI\initBadgeForm(), ilObjBibliographicGUI\initCreationForms(), ilObjBibliographicGUI\initEditForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilObjectPluginGUI\initImportForm(), ilObjSurveyGUI\initImportForm(), ilObjectGUI\initImportForm(), ilAdvancedMDSettingsGUI\initImportForm(), ilObjQuestionPoolGUI\initImportForm(), ilObjTestGUI\initImportForm(), ilSkillRootGUI\initInputForm(), ilSkillProfileGUI\initInputForm(), ilExerciseManagementGUI\initMultiFeedbackForm(), ilPageLayoutAdministrationGUI\initPageLayoutImportForm(), ilChatroomAdminSmileyGUI\initSmiliesEditForm(), ilChatroomAdminSmileyGUI\initSmiliesForm(), ilMediaPoolImportGUI\initTranslationImportForm(), ilLMImportGUI\initTranslationImportForm(), ilObjUserFolderGUI\initUserImportForm(), ilExSubmissionFileGUI\initZipUploadForm(), ilObjMediaObjectGUI\setPropertiesSubTabs(), ilMobMultiSrtUploadGUI\uploadMultipleSubtitleFileForm(), and ilObjMediaObjectGUI\uploadMultipleSubtitleFileFormObject().

                                                   : void
     {
         $this->suffixes = $a_suffixes;
     }

Here is the caller graph for this function:

◆ setValue()

ilFileInputGUI::setValue ( string $a_value )

Set Value.

(used for displaying file title of existing file below input field)

Definition at line 69 of file class.ilFileInputGUI.php.

Referenced by setValueByArray().

                                              : void
     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilFileInputGUI::setValueByArray ( array $a_values )

Definition at line 56 of file class.ilFileInputGUI.php.

References getFileNamePostVar(), ilFormPropertyGUI\getPostVar(), setFilename(), and setValue().

                                                     : void
     {
         $value = $a_values[$this->getPostVar()] ?? null;
         if (!is_array($value)) {
             $this->setValue((string) $value);
         }
         $filenam = $a_values[$this->getFileNamePostVar()] ?? '';
         $this->setFilename($filenam);
     }

Here is the call graph for this function:

Field Documentation

◆ $allow_deletion

bool ilFileInputGUI::$allow_deletion = false

protected

Definition at line 34 of file class.ilFileInputGUI.php.

Referenced by ilImageFileInputGUI\getALlowDeletion(), and getALlowDeletion().

◆ $filename

string ilFileInputGUI::$filename = ""

private

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

Referenced by ilFileWizardInputGUI\checkInput(), ilImagemapFileInputGUI\checkInput(), and getFilename().

◆ $filename_post

string ilFileInputGUI::$filename_post = ""

private

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

Referenced by getFileNamePostVar().

◆ $filename_selection

bool ilFileInputGUI::$filename_selection = false

protected

Definition at line 35 of file class.ilFileInputGUI.php.

Referenced by isFileNameSelectionEnabled().

◆ $forbidden_suffixes

array ilFileInputGUI::$forbidden_suffixes = []

protected

Definition at line 36 of file class.ilFileInputGUI.php.

Referenced by getForbiddenSuffixes().

◆ $pending

string ilFileInputGUI::$pending = ""

protected

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

Referenced by getPending(), and ilImageFileInputGUI\insert().

◆ $size

int ilFileInputGUI::$size = 40

protected

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

Referenced by getSize().

◆ $suffixes

array ilFileInputGUI::$suffixes = []

protected

Definition at line 37 of file class.ilFileInputGUI.php.

Referenced by getSuffixes().

◆ $upload_service

ILIAS FileUpload FileUpload ilFileInputGUI::$upload_service

protected

Definition at line 39 of file class.ilFileInputGUI.php.

◆ $value

string ilFileInputGUI::$value = ""

protected

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

Referenced by getValue(), and ilFileWizardInputGUI\insert().

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

Services/Form/classes/class.ilFileInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ enableFileNameSelection()

◆ getALlowDeletion()

◆ getDeletionFlag()

◆ getFilename()

◆ getFileNamePostVar()

◆ getForbiddenSuffixes()

◆ getInput()

◆ getMaxFileSizeString()

◆ getMaxFileUploads()

◆ getPending()

◆ getSize()

◆ getSuffixes()

◆ getToolbarHTML()

◆ getValue()

◆ insert()

◆ isFileNameSelectionEnabled()

◆ outputSuffixes()

◆ render()

◆ setAllowDeletion()

◆ setFilename()

◆ setForbiddenSuffixes()

◆ setPending()

◆ setSize()

◆ setSuffixes()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $allow_deletion

◆ $filename

◆ $filename_post

◆ $filename_selection

◆ $forbidden_suffixes

◆ $pending

◆ $size

◆ $suffixes

◆ $upload_service

◆ $value