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

Inheritance diagram for ilFlashFileInputGUI:

Collaboration diagram for ilFlashFileInputGUI:

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

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

	getValue ()
	Get Value. More...

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

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

	setApplet ($a_applet)
	Set applet. More...

	getApplet ()
	Get applet. More...

	setAppletPathWeb ($a_path)
	Set applet.path web. More...

	getAppletPathWeb ()
	Get applet.path web. More...

	getWidth ()
	Get width. More...

	setWidth ($a_width)
	Set width. More...

	getHeight ()
	Get height. More...

	setHeight ($a_height)
	Set height. More...

	getParameters ()
	Get parameters. More...

	setParameters ($a_parameters)
	Set parameters. More...

	addParameter ($name, $value)
	Add parameter. More...

	removeParameter ($name)
	Remove parameter. More...

	clearParameters ()
	Remove all parameters. More...

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

	getDeletionFlag ()
	Get deletion flag. 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

	$applet

	$applet_path_web

	$width

	$height

	$parameters

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 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 an image file property in a property form.

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

Version: $Id$

Definition at line 11 of file class.ilFlashFileInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFileInputGUI.

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        parent::__construct($a_title, $a_postvar);
        $this->setType("flash_file");
        $this->setSuffixes(array("swf"));
        $this->width = 550;
        $this->height = 400;
        $this->parameters = array();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilFileInputGUI\setSuffixes(), and ilFormPropertyGUI\setType().

Here is the call graph for this function:

Member Function Documentation

◆ addParameter()

ilFlashFileInputGUI::addParameter	(	$name,
		$value
	)

Add parameter.

Parameters

string	$name	Parameter name
string	$value	Parameter value

Definition at line 286 of file class.ilFlashFileInputGUI.php.

    {
        $this->parameters[$name] = $value;
    }

References $name.

◆ checkInput()

ilFlashFileInputGUI::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 84 of file class.ilFlashFileInputGUI.php.

    {
        $lng = $this->lng;
 
        // 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"];
        $mimetype = $_FILES[$this->getPostVar()]["type"];
        $size_bytes = $_FILES[$this->getPostVar()]["size"];
        $temp_name = $_FILES[$this->getPostVar()]["tmp_name"];
        $error = $_FILES[$this->getPostVar()]["error"];
 
        // error handling
        if ($error > 0) {
            switch ($error) {
                case UPLOAD_ERR_INI_SIZE:
                    $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
                    return false;
                    break;
                     
                case UPLOAD_ERR_FORM_SIZE:
                    $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
                    return false;
                    break;
    
                case UPLOAD_ERR_PARTIAL:
                    $this->setAlert($lng->txt("form_msg_file_partially_uploaded"));
                    return false;
                    break;
    
                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;
                    break;
                     
                case UPLOAD_ERR_CANT_WRITE:
                    $this->setAlert($lng->txt("form_msg_file_cannot_write_to_disk"));
                    return false;
                    break;
     
                case UPLOAD_ERR_EXTENSION:
                    $this->setAlert($lng->txt("form_msg_file_upload_stopped_ext"));
                    return false;
                    break;
            }
        }
        
        // check suffixes
        if ($_FILES[$this->getPostVar()]["tmp_name"] != "" &&
            is_array($this->getSuffixes())) {
            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 = ilUtil::virusHandling($temp_name, $filename);
            if ($vir[0] == false) {
                $this->setAlert($lng->txt("form_msg_file_virus_found") . "<br />" . $vir[1]);
                return false;
            }
        }
 
        if (is_array($_POST[$this->getPostVar()])) {
            if (($this->getRequired() && strlen($_POST[$this->getPostVar()]['width']) == 0) ||
                ($this->getRequired() && strlen($_POST[$this->getPostVar()]['height']) == 0)) {
                $this->setAlert($lng->txt("msg_input_is_required"));
                return false;
            }
            if (is_array($_POST[$this->getPostVar()]['flash_param_name'])) {
                foreach ($_POST[$this->getPostVar()]['flash_param_name'] as $idx => $val) {
                    if (strlen($val) == 0 || strlen($_POST[$this->getPostVar()]['flash_param_value'][$idx]) == 0) {
                        $this->setAlert($lng->txt("msg_input_is_required"));
                        return false;
                    }
                }
            }
        }
        
        return true;
    }

References $_POST, ilFileInputGUI\$filename, $lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFileInputGUI\getSuffixes(), getValue(), ilFormPropertyGUI\setAlert(), and ilUtil\virusHandling().

Here is the call graph for this function:

◆ clearParameters()

ilFlashFileInputGUI::clearParameters ( )

Remove all parameters.

Definition at line 304 of file class.ilFlashFileInputGUI.php.

    {
        $this->parameters = array();
    }

◆ getApplet()

ilFlashFileInputGUI::getApplet ( )

Get applet.

Returns: string Applet

Definition at line 195 of file class.ilFlashFileInputGUI.php.

    {
        return $this->applet;
    }

References $applet.

Referenced by getValue(), and insert().

Here is the caller graph for this function:

◆ getAppletPathWeb()

ilFlashFileInputGUI::getAppletPathWeb ( )

Get applet.path web.

Returns: string Applet path web

Definition at line 215 of file class.ilFlashFileInputGUI.php.

    {
        return $this->applet_path_web;
    }

References $applet_path_web.

Referenced by insert().

Here is the caller graph for this function:

◆ getDeletionFlag()

ilFlashFileInputGUI::getDeletionFlag ( )

Get deletion flag.

Reimplemented from ilFileInputGUI.

Definition at line 389 of file class.ilFlashFileInputGUI.php.

    {
        if ($_POST[$this->getPostVar() . "_delete"]) {
            return true;
        }
        return false;
    }

References $_POST, and ilFormPropertyGUI\getPostVar().

Here is the call graph for this function:

◆ getHeight()

ilFlashFileInputGUI::getHeight ( )

Get height.

Returns: integer height

Definition at line 245 of file class.ilFlashFileInputGUI.php.

    {
        return $this->height;
    }

References $height.

Referenced by insert().

Here is the caller graph for this function:

◆ getParameters()

ilFlashFileInputGUI::getParameters ( )

Get parameters.

Returns: array Parameters

Definition at line 265 of file class.ilFlashFileInputGUI.php.

    {
        return $this->parameters;
    }

References $parameters.

Referenced by insert().

Here is the caller graph for this function:

◆ getValue()

ilFlashFileInputGUI::getValue ( )

Get Value.

Returns: string Value

Reimplemented from ilFileInputGUI.

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

    {
        return $this->getApplet();
    }

References getApplet().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getWidth()

ilFlashFileInputGUI::getWidth ( )

Get width.

Returns: integer width

Definition at line 225 of file class.ilFlashFileInputGUI.php.

    {
        return $this->width;
    }

References $width.

Referenced by insert().

Here is the caller graph for this function:

◆ insert()

ilFlashFileInputGUI::insert ( $a_tpl )

Insert property html.

Reimplemented from ilFileInputGUI.

Definition at line 312 of file class.ilFlashFileInputGUI.php.

    {
        $lng = $this->lng;
        
        $template = new ilTemplate("tpl.prop_flashfile.html", true, true, "Services/Form");
        if ($this->getApplet() != "") {
            $this->outputSuffixes($template);
            if (count($this->getParameters())) {
                $index = 0;
                $params = array();
                foreach ($this->getParameters() as $name => $value) {
                    array_push($params, urlencode($name) . "=" . urlencode($value));
                    $template->setCurrentBlock("applet_param_input");
                    $template->setVariable("TEXT_NAME", $lng->txt("name"));
                    $template->setVariable("TEXT_VALUE", $lng->txt("value"));
                    $template->setVariable("PARAM_INDEX", $index);
                    $template->setVariable("POST_VAR_P", $this->getPostVar());
                    $template->setVariable("VALUE_NAME", "value=\"" . ilUtil::prepareFormOutput($name) . "\"");
                    $template->setVariable("VALUE_VALUE", "value=\"" . ilUtil::prepareFormOutput($value) . "\"");
                    $template->setVariable("TEXT_DELETE_PARAM", $lng->txt("delete_parameter"));
                    $template->parseCurrentBlock();
                    $index++;
                }
                $template->setCurrentBlock("applet_parameter");
                $template->setVariable("PARAM_VALUE", join("&", $params));
                $template->parseCurrentBlock();
                $template->setCurrentBlock("flash_vars");
                $template->setVariable("PARAM_VALUE", join("&", $params));
                $template->parseCurrentBlock();
            }
            $template->setCurrentBlock("applet");
            $template->setVariable("TEXT_ADD_PARAM", $lng->txt("add_parameter"));
            $template->setVariable("APPLET_WIDTH", $this->getWidth());
            $template->setVariable("APPLET_HEIGHT", $this->getHeight());
            $template->setVariable("POST_VAR_D", $this->getPostVar());
            $template->setVariable("FILENAME", $this->getApplet());
            $template->setVariable("TEXT_WIDTH", $lng->txt("width"));
            $template->setVariable("TEXT_HEIGHT", $lng->txt("height"));
            $template->setVariable("APPLET_FILE", $this->getApplet());
            $template->setVariable("APPLET_PATH", $this->getAppletPathWeb() . $this->getApplet());
            if ($this->getWidth()) {
                $template->setVariable("VALUE_WIDTH", "value=\"" . $this->getWidth() . "\"");
            }
            if ($this->getHeight()) {
                $template->setVariable("VALUE_HEIGHT", "value=\"" . $this->getHeight() . "\"");
            }
            $template->setVariable("ID", $this->getFieldId());
            $template->setVariable(
                "TXT_DELETE_EXISTING",
                $lng->txt("delete_existing_file")
            );
            $template->parseCurrentBlock();
        }
        
        $js_tpl = new ilTemplate('tpl.flashAddParam.js', true, true, 'Services/Form');
        $js_tpl->setVariable("TEXT_NAME", $lng->txt("name"));
        $js_tpl->setVariable("TEXT_VALUE", $lng->txt("value"));
        $js_tpl->setVariable("POST_VAR", $this->getPostVar());
        $js_tpl->setVariable("TEXT_DELETE_PARAM", $lng->txt("delete_parameter"));
        $js_tpl->setVariable("TEXT_CONFIRM_DELETE_PARAMETER", $lng->txt("confirm_delete_parameter"));
        
        $template->setVariable("POST_VAR", $this->getPostVar());
        $template->setVariable("ID", $this->getFieldId());
        $template->setVariable("TXT_MAX_SIZE", $lng->txt("file_notice") . " " . $this->getMaxFileSizeString());
        $template->setVariable("JAVASCRIPT_FLASH", $js_tpl->get());
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $template->get());
        $a_tpl->parseCurrentBlock();
        
        include_once "./Services/YUI/classes/class.ilYuiUtil.php";
        ilYuiUtil::initConnectionWithAnimation();
    }

References $index, $lng, $name, getApplet(), getAppletPathWeb(), ilFormPropertyGUI\getFieldId(), getHeight(), getParameters(), ilFormPropertyGUI\getPostVar(), getWidth(), ilYuiUtil\initConnectionWithAnimation(), ilFileInputGUI\outputSuffixes(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

◆ removeParameter()

ilFlashFileInputGUI::removeParameter ( $name )

Remove parameter.

Parameters

string $name Parameter name

Definition at line 296 of file class.ilFlashFileInputGUI.php.

    {
        unset($this->parameters[$name]);
    }

References $name.

◆ setApplet()

ilFlashFileInputGUI::setApplet ( $a_applet )

Set applet.

Parameters

string $a_applet Applet

Definition at line 185 of file class.ilFlashFileInputGUI.php.

    {
        $this->applet = $a_applet;
    }

Referenced by setValue().

Here is the caller graph for this function:

◆ setAppletPathWeb()

ilFlashFileInputGUI::setAppletPathWeb ( $a_path )

Set applet.path web.

Parameters

string $a_path Applet path web

Definition at line 205 of file class.ilFlashFileInputGUI.php.

    {
        $this->applet_path_web = $a_path;
    }

◆ setHeight()

ilFlashFileInputGUI::setHeight ( $a_height )

Set height.

Parameters

integer $a_height height

Definition at line 255 of file class.ilFlashFileInputGUI.php.

    {
        $this->height = $a_height;
    }

Referenced by setValue().

Here is the caller graph for this function:

◆ setParameters()

ilFlashFileInputGUI::setParameters ( $a_parameters )

Set parameters.

Parameters

array $a_parameters Parameters

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

    {
        $this->parameters = $a_parameters;
    }

◆ setValue()

ilFlashFileInputGUI::setValue ( $a_value )

Set Value.

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

Parameters

string $a_value Value

Reimplemented from ilFileInputGUI.

Definition at line 58 of file class.ilFlashFileInputGUI.php.

    {
        if (is_array($a_value)) {
            if (array_key_exists('width', $a_value)) {
                $this->setWidth($a_value['width']);
            }
            if (array_key_exists('height', $a_value)) {
                $this->setHeight($a_value['height']);
            }
            if (array_key_exists('filename', $a_value)) {
                $this->setApplet($a_value['filename']);
            }
            if (is_array($a_value['flash_param_name'])) {
                $this->parameters = array();
                foreach ($a_value['flash_param_name'] as $idx => $val) {
                    $this->parameters[$val] = $a_value['flash_param_value'][$idx];
                }
            }
        }
    }

References setApplet(), setHeight(), and setWidth().

Referenced by setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilFlashFileInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Reimplemented from ilFileInputGUI.

Definition at line 48 of file class.ilFlashFileInputGUI.php.

    {
        $this->setValue($a_values[$this->getPostVar()]);
    }

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

Here is the call graph for this function:

◆ setWidth()

ilFlashFileInputGUI::setWidth ( $a_width )

Set width.

Parameters

integer $a_width width

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

    {
        $this->width = $a_width;
    }

Referenced by setValue().

Here is the caller graph for this function:

Field Documentation

◆ $applet

ilFlashFileInputGUI::$applet

protected

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

Referenced by getApplet().

◆ $applet_path_web

ilFlashFileInputGUI::$applet_path_web

protected

Definition at line 19 of file class.ilFlashFileInputGUI.php.

Referenced by getAppletPathWeb().

◆ $height

ilFlashFileInputGUI::$height

protected

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

Referenced by getHeight().

◆ $lng

ilFlashFileInputGUI::$lng

protected

Definition at line 16 of file class.ilFlashFileInputGUI.php.

Referenced by checkInput(), and insert().

◆ $parameters

ilFlashFileInputGUI::$parameters

protected

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

Referenced by getParameters().

◆ $width

ilFlashFileInputGUI::$width

protected

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

Referenced by getWidth().

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

Services/Form/classes/class.ilFlashFileInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addParameter()

◆ checkInput()

◆ clearParameters()

◆ getApplet()

◆ getAppletPathWeb()

◆ getDeletionFlag()

◆ getHeight()

◆ getParameters()

◆ getValue()

◆ getWidth()

◆ insert()

◆ removeParameter()

◆ setApplet()

◆ setAppletPathWeb()

◆ setHeight()

◆ setParameters()

◆ setValue()

◆ setValueByArray()

◆ setWidth()

Field Documentation

◆ $applet

◆ $applet_path_web

◆ $height

◆ $lng

◆ $parameters

◆ $width