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

Inheritance diagram for ilFileWizardInputGUI:

Collaboration diagram for ilFileWizardInputGUI:

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

	setImagePathWeb (string $a_path)

	getImagePathWeb ()

	setFilenames (array $a_filenames)

	getFilenames ()

	setAllowMove (bool $a_allow_move)

	getAllowMove ()

	checkInput ()

	insert (ilTemplate $a_tpl)

Public Member Functions inherited from ilFileInputGUI
	__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 Attributes
ilGlobalTemplateInterface	$tpl

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

array	$filenames = array()

bool	$allowMove = false

string	$imagepath_web = ""

Protected Attributes inherited from ilFileInputGUI
int	$size = 40

string	$pending = ""

bool	$allow_deletion = false

bool	$filename_selection = false

array	$forbidden_suffixes = []

array	$suffixes = []

string	$value = ""

FileUpload	$upload_service

UploadLimitResolver	$upload_limit

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

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

Protected Member Functions inherited from ilFileInputGUI
	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
	symbol ()

	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)

Detailed Description

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

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule("form");
         $this->tpl = $DIC["tpl"];
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
         parent::__construct($a_title, $a_postvar);
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilFileWizardInputGUI::checkInput ( )

Definition at line 81 of file class.ilFileWizardInputGUI.php.

References ilFileInputGUI\$filename, ilFormPropertyGUI\$lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFileInputGUI\getSuffixes(), ilFormPropertyGUI\setAlert(), ilLanguage\txt(), and ilVirusScanner\virusHandling().

                                 : bool
     {
         $lng = $this->lng;
 
         // see ilFileInputGUI
         // 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;
         }
 
         $pictures = $_FILES[$this->getPostVar()];
         $uploadcheck = true;
         if (is_array($pictures)) {
             foreach ($pictures['name'] as $index => $name) {
                 // remove trailing '/'
                 $name = rtrim($name, '/');
 
                 $filename = $name;
                 $filename_arr = pathinfo($name);
                 $suffix = $filename_arr["extension"] ?? "";
                 $temp_name = $pictures["tmp_name"][$index];
                 $error = $pictures["error"][$index];
 
                 $_FILES[$this->getPostVar()]["name"][$index] = Util::sanitizeFileName($_FILES[$this->getPostVar()]["name"][$index]);
 
 
                 // 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"));
                             $uploadcheck = false;
                             break;
 
                         case UPLOAD_ERR_PARTIAL:
                             $this->setAlert($lng->txt("form_msg_file_partially_uploaded"));
                             $uploadcheck = false;
                             break;
 
                         case UPLOAD_ERR_NO_FILE:
                             if ($this->getRequired()) {
                                 $filename = $this->filenames[$index];
                                 if (!strlen($filename)) {
                                     $this->setAlert($lng->txt("form_msg_file_no_upload"));
                                     $uploadcheck = false;
                                 }
                             }
                             break;
 
                         case UPLOAD_ERR_NO_TMP_DIR:
                             $this->setAlert($lng->txt("form_msg_file_missing_tmp_dir"));
                             $uploadcheck = false;
                             break;
 
                         case UPLOAD_ERR_CANT_WRITE:
                             $this->setAlert($lng->txt("form_msg_file_cannot_write_to_disk"));
                             $uploadcheck = false;
                             break;
 
                         case UPLOAD_ERR_EXTENSION:
                             $this->setAlert($lng->txt("form_msg_file_upload_stopped_ext"));
                             $uploadcheck = false;
                             break;
                     }
                 }
 
                 // check suffixes
                 if ($pictures["tmp_name"][$index] != "" && 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"));
                         $uploadcheck = false;
                     }
                 }
 
                 // virus handling
                 if ($pictures["tmp_name"][$index] != "") {
                     $vir = ilVirusScanner::virusHandling($temp_name, $filename);
                     if ($vir[0] == false) {
                         $this->setAlert($lng->txt("form_msg_file_virus_found") . "<br />" . $vir[1]);
                         $uploadcheck = false;
                     }
                 }
             }
         }
 
         if (!$uploadcheck) {
             return false;
         }
 
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getAllowMove()

ilFileWizardInputGUI::getAllowMove ( )

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

References $allowMove.

Referenced by insert().

                                   : bool
     {
         return $this->allowMove;
     }

Here is the caller graph for this function:

◆ getFilenames()

ilFileWizardInputGUI::getFilenames ( )

Definition at line 66 of file class.ilFileWizardInputGUI.php.

References $filenames.

                                   : array
     {
         return $this->filenames;
     }

◆ getImagePathWeb()

ilFileWizardInputGUI::getImagePathWeb ( )

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

References $imagepath_web.

Referenced by insert().

                                      : string
     {
         return $this->imagepath_web;
     }

Here is the caller graph for this function:

◆ insert()

ilFileWizardInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 176 of file class.ilFileWizardInputGUI.php.

References ilFormPropertyGUI\$lng, $tpl, ilFileInputGUI\$value, ILIAS\UICore\GlobalTemplate\get(), getAllowMove(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getImagePathWeb(), ilFileInputGUI\getMaxFileSizeString(), ilFileInputGUI\getMaxFileUploads(), ilFormPropertyGUI\getPostVar(), ilFileInputGUI\outputSuffixes(), ilTemplate\parseCurrentBlock(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setVariable(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

                                              : void
     {
         $lng = $this->lng;
 
         $tpl = new ilTemplate("tpl.prop_filewizardinput.html", true, true, "components/ILIAS/Form");
 
         $i = 0;
         foreach ($this->filenames as $value) {
             if (strlen($value)) {
                 $tpl->setCurrentBlock("image");
                 $tpl->setVariable(
                     "SRC_IMAGE",
                     $this->getImagePathWeb() . ilLegacyFormElementsUtil::prepareFormOutput(
                         $value
                     )
                 );
                 $tpl->setVariable("PICTURE_FILE", ilLegacyFormElementsUtil::prepareFormOutput($value));
                 $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
                 $tpl->setVariable("ALT_IMAGE", ilLegacyFormElementsUtil::prepareFormOutput($value));
                 $tpl->parseCurrentBlock();
             }
             if ($this->getAllowMove()) {
                 $tpl->setCurrentBlock("move");
                 $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
                 $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
                 $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
                 $tpl->setVariable(
                     "UP_BUTTON",
                     $this->ui_renderer->render(
                         $this->ui_factory->symbol()->glyph()->up()
                     )
                 );
                 $tpl->setVariable(
                     "DOWN_BUTTON",
                     $this->ui_renderer->render(
                         $this->ui_factory->symbol()->glyph()->down()
                     )
                 );
                 $tpl->parseCurrentBlock();
             }
 
             $this->outputSuffixes($tpl, "allowed_image_suffixes");
 
             $tpl->setCurrentBlock("row");
             $tpl->setVariable("POST_VAR", $this->getPostVar() . "[$i]");
             $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
             $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
             $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
             $tpl->setVariable("ALT_ADD", $lng->txt("add"));
             $tpl->setVariable("ALT_REMOVE", $lng->txt("remove"));
             if ($this->getDisabled()) {
                 $tpl->setVariable(
                     "DISABLED",
                     " disabled=\"disabled\""
                 );
             }
 
             $tpl->setVariable(
                 "ADD_BUTTON",
                 $this->ui_renderer->render(
                     $this->ui_factory->symbol()->glyph()->add()
                 )
             );
             $tpl->setVariable(
                 "REMOVE_BUTTON",
                 $this->ui_renderer->render(
                     $this->ui_factory->symbol()->glyph()->remove()
                 )
             );
             $tpl->setVariable("TXT_MAX_SIZE", $lng->txt("file_notice") . " " . $this->getMaxFileSizeString());
             $tpl->setVariable("MAX_UPLOAD_VALUE", $this->getMaxFileUploads());
             $tpl->setVariable("TXT_MAX_UPLOADS", $lng->txt("form_msg_max_upload") . " " . $this->getMaxFileUploads());
             $tpl->parseCurrentBlock();
             $i++;
         }
         $tpl->setVariable("ELEMENT_ID", $this->getFieldId());
 
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
         $a_tpl->parseCurrentBlock();
 
         $main_tpl = $this->tpl;
         $main_tpl->addJavascript("assets/js/ServiceFormWizardInput.js");
         $main_tpl->addJavascript("assets/js/filewizard.js");
     }

Here is the call graph for this function:

◆ setAllowMove()

ilFileWizardInputGUI::setAllowMove ( bool $a_allow_move )

Definition at line 71 of file class.ilFileWizardInputGUI.php.

                                                     : void
     {
         $this->allowMove = $a_allow_move;
     }

◆ setFilenames()

ilFileWizardInputGUI::setFilenames ( array $a_filenames )

Definition at line 61 of file class.ilFileWizardInputGUI.php.

Referenced by ilForumThreadFormGUI\addFileUploadInput(), ilExAssignmentEditorGUI\initAssignmentForm(), ilObjSessionGUI\initForm(), ilObjForumGUI\initReplyEditForm(), and ilExSubmissionFileGUI\initUploadForm().

                                                     : void
     {
         $this->filenames = $a_filenames;
     }

Here is the caller graph for this function:

◆ setImagePathWeb()

ilFileWizardInputGUI::setImagePathWeb ( string $a_path )

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

                                                    : void
     {
         $this->imagepath_web = $a_path;
     }

Field Documentation

◆ $allowMove

bool ilFileWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

◆ $filenames

array ilFileWizardInputGUI::$filenames = array()

protected

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

Referenced by getFilenames().

◆ $imagepath_web

string ilFileWizardInputGUI::$imagepath_web = ""

protected

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

Referenced by getImagePathWeb().

◆ $tpl

ilGlobalTemplateInterface ilFileWizardInputGUI::$tpl

protected

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

Referenced by insert().

◆ $ui_factory

ILIAS UI Factory ilFileWizardInputGUI::$ui_factory

protected

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

◆ $ui_renderer

ILIAS UI Renderer ilFileWizardInputGUI::$ui_renderer

protected

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

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

components/ILIAS/Form/classes/class.ilFileWizardInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getAllowMove()

◆ getFilenames()

◆ getImagePathWeb()

◆ insert()

◆ setAllowMove()

◆ setFilenames()

◆ setImagePathWeb()

Field Documentation

◆ $allowMove

◆ $filenames

◆ $imagepath_web

◆ $tpl

◆ $ui_factory

◆ $ui_renderer