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

Inheritance diagram for ilFileWizardInputGUI:

Collaboration diagram for ilFileWizardInputGUI:

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

	setImagePathWeb ($a_path)
	Set the web image path. More...

	getImagePathWeb ()
	Get the web image path. More...

	setFilenames ($a_filenames)
	Set filenames. More...

	getFilenames ()
	Get filenames. More...

	setAllowMove ($a_allow_move)
	Set allow move. More...

	getAllowMove ()
	Get allow move. More...

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

	insert ($a_tpl)
	Insert property html. 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...

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

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

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

Protected Attributes
	$lng

	$tpl

	$filenames = array()

	$allowMove = false

	$imagepath_web = ""

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

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...

Protected Member Functions inherited from ilFileInputGUI
	outputSuffixes ($a_tpl, $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 ($a_type)
	Set Type. More...

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

Static Protected Attributes inherited from ilFileInputGUI
static	$check_wsp_quota

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

Version

Id: class.ilFileWizardInputGUI.php 18834 2009-02-03 10:10:29Z hschottm

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFileInputGUI.

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

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

References $DIC.

Member Function Documentation

◆ checkInput()

ilFileWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilFileInputGUI.

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

    {
        $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 (!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"];
                $mimetype = $pictures["type"][$index];
                $size_bytes = $pictures["size"][$index];
                $temp_name = $pictures["tmp_name"][$index];
                $error = $pictures["error"][$index];
 
                include_once("./Services/Utilities/classes/class.ilStr.php");
                $_FILES[$this->getPostVar()]["name"][$index] = ilStr::normalizeUtf8String($_FILES[$this->getPostVar()]["name"][$index]);
 
 
                // error handling
                if ($error > 0) {
                    switch ($error) {
                        case UPLOAD_ERR_INI_SIZE:
                            $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
                            $uploadcheck = false;
                            break;
 
                        case UPLOAD_ERR_FORM_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())) {
                    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 = ilUtil::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();
    }

References ilFileInputGUI\$filename, $index, $lng, $name, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFileInputGUI\getSuffixes(), ilStr\normalizeUtf8String(), ilFormPropertyGUI\setAlert(), and ilUtil\virusHandling().

Here is the call graph for this function:

◆ getAllowMove()

ilFileWizardInputGUI::getAllowMove ( )

Get allow move.

Returns: boolean Allow move

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

    {
        return $this->allowMove;
    }

References $allowMove.

Referenced by insert().

Here is the caller graph for this function:

◆ getFilenames()

ilFileWizardInputGUI::getFilenames ( )

Get filenames.

Returns: array filenames

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

    {
        return $this->filenames;
    }

References $filenames.

◆ getImagePathWeb()

ilFileWizardInputGUI::getImagePathWeb ( )

Get the web image path.

Returns: string Path

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

    {
        return $this->imagepath_web;
    }

References $imagepath_web.

Referenced by insert().

Here is the caller graph for this function:

◆ insert()

ilFileWizardInputGUI::insert ( $a_tpl )

Insert property html.

Returns: int Size

Reimplemented from ilFileInputGUI.

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

    {
        $lng = $this->lng;
        
        $tpl = new ilTemplate("tpl.prop_filewizardinput.html", true, true, "Services/Form");
 
        $i = 0;
        foreach ($this->filenames as $value) {
            if (strlen($value)) {
                $tpl->setCurrentBlock("image");
                $tpl->setVariable("SRC_IMAGE", $this->getImagePathWeb() . ilUtil::prepareFormOutput($value));
                $tpl->setVariable("PICTURE_FILE", ilUtil::prepareFormOutput($value));
                $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
                $tpl->setVariable("ALT_IMAGE", ilUtil::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]");
                include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
                $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::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\""
                );
            }
            
            include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
            $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
            $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::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("./Services/Form/js/ServiceFormWizardInput.js");
        $main_tpl->addJavascript("./Services/Form/templates/default/filewizard.js");
    }

References $i, $lng, $tpl, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), getAllowMove(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getImagePathWeb(), ilFileInputGUI\getMaxFileUploads(), ilFormPropertyGUI\getPostVar(), ilFileInputGUI\outputSuffixes(), ilUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

Here is the call graph for this function:

◆ setAllowMove()

ilFileWizardInputGUI::setAllowMove ( $a_allow_move )

Set allow move.

Parameters

boolean $a_allow_move Allow move

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

    {
        $this->allowMove = $a_allow_move;
    }

◆ setFilenames()

ilFileWizardInputGUI::setFilenames ( $a_filenames )

Set filenames.

Parameters

array $a_value Value

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

    {
        $this->filenames = $a_filenames;
    }

◆ setImagePathWeb()

ilFileWizardInputGUI::setImagePathWeb ( $a_path )

Set the web image path.

Parameters

string $a_path Path

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

    {
        $this->imagepath_web = $a_path;
    }

Field Documentation

◆ $allowMove

ilFileWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

◆ $filenames

ilFileWizardInputGUI::$filenames = array()

protected

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

Referenced by getFilenames().

◆ $imagepath_web

ilFileWizardInputGUI::$imagepath_web = ""

protected

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

Referenced by getImagePathWeb().

◆ $lng

ilFileWizardInputGUI::$lng

protected

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

Referenced by checkInput(), and insert().

◆ $tpl

ilFileWizardInputGUI::$tpl

protected

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

Referenced by insert().

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

Services/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

◆ $lng

◆ $tpl