ilImagemapFileInputGUI Class Reference

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

Inheritance diagram for ilImagemapFileInputGUI:

Collaboration diagram for ilImagemapFileInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setPointsUncheckedFieldEnabled ($pointsUncheckedFieldEnabled)
	getPointsUncheckedFieldEnabled ()
	setAreas ($a_areas)
	getLineColor ()
	setLineColor ($a_color)
	getImagePath ()
	setImagePath ($a_path)
	getImagePathWeb ()
	setImagePathWeb ($a_path_web)
	setAreasByArray ($a_areas)
	getAreas ()
	setValueByArray ($a_values)
	Set value by array. More...
	setValue ($a_value)
	Set Value. More...
	checkInput ()
	Check input, strip slashes etc. More...
	insert (&$a_tpl)
	Insert property html. More...
Public Member Functions inherited from ilImageFileInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setALlowDeletion ($a_val)
	Set allow deletion. More...
	getALlowDeletion ()
	Get allow deletion. More...
	setUseCache ($a_cache)
	Set cache. More...
	getUseCache ()
	Get cache. More...
	setImage ($a_image)
	Set Image. More...
	getImage ()
	Get Image. More...
	setAlt ($a_alt)
	Set Alternative Text. More...
	getAlt ()
	Get Alternative Text. 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...
	setPersonalWorkspaceQuotaCheck ($a_value)
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...
	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...
	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Protected Attributes
	$areas = array()
	$image_path = ""
	$image_path_web = ""
	$line_color = ""
	$pointsUncheckedFieldEnabled = false
Protected Attributes inherited from ilImageFileInputGUI
	$cache
Protected Attributes inherited from ilFileInputGUI
	$size = 40
	$pending
	$allow_deletion
	$forbidden_suffixes = array()
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi = false
	$multi_sortable = false
	$multi_addremove = true
	$multi_values

Additional Inherited Members
Protected Member Functions inherited from ilFileInputGUI
	outputSuffixes ($a_tpl, $a_block="allowed_suffixes")
	getMaxFileSizeString ()
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 map 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 15 of file class.ilImagemapFileInputGUI.php.

Constructor & Destructor Documentation

__construct()

ilImagemapFileInputGUI::__construct	(		$a_title = "",
			$a_postvar = ""
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilImageFileInputGUI.

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

        {
                global $lng;
 
                parent::__construct($a_title, $a_postvar);
        }

References $lng.

Member Function Documentation

checkInput()

ilImagemapFileInputGUI::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 137 of file class.ilImagemapFileInputGUI.php.

        {
                global $lng;
 
                if (is_array($_POST[$this->getPostVar()])) $_POST[$this->getPostVar()] = ilUtil::stripSlashesRecursive($_POST[$this->getPostVar()]);
                // remove trailing '/'
                while (substr($_FILES[$this->getPostVar()]["name"],-1) == '/')
                {
                        $_FILES[$this->getPostVar()]["name"] = substr($_FILES[$this->getPostVar()]["name"],0,-1);
                }
 
                $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;
                        }
                }
                
                $max = 0;
                if (is_array($_POST[$this->getPostVar()]['coords']['name']))
                {
                        foreach ($_POST[$this->getPostVar()]['coords']['name'] as $idx => $name)
                        {
                                if ((!strlen($_POST[$this->getPostVar()]['coords']['points'][$idx])) && ($this->getRequired))
                                {
                                        $this->setAlert($lng->txt('form_msg_area_missing_points'));
                                        return false;
                                }
                                if ((!is_numeric($_POST[$this->getPostVar()]['coords']['points'][$idx])))
                                {
                                        $this->setAlert($lng->txt('form_msg_numeric_value_required'));
                                        return false;
                                }
                                if ($_POST[$this->getPostVar()]['coords']['points'][$idx] > 0) $max = $_POST[$this->getPostVar()]['coords']['points'][$idx];
                        }
                }
 
                if ($max == 0 && (!$filename))
                {
                        $this->setAlert($lng->txt("enter_enough_positive_points"));
                        return false;
                }
                return true;
        }

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

Here is the call graph for this function:

getAreas()

ilImagemapFileInputGUI::getAreas

(

)

Definition at line 111 of file class.ilImagemapFileInputGUI.php.

        {
                return $this->areas;
        }

References $areas.

Referenced by insert().

Here is the caller graph for this function:

getImagePath()

ilImagemapFileInputGUI::getImagePath

(

)

Definition at line 62 of file class.ilImagemapFileInputGUI.php.

        {
                return $this->image_path;
        }

References $image_path.

Referenced by insert().

Here is the caller graph for this function:

getImagePathWeb()

ilImagemapFileInputGUI::getImagePathWeb

(

)

Definition at line 72 of file class.ilImagemapFileInputGUI.php.

        {
                return $this->image_path_web;
        }

References $image_path_web.

Referenced by insert().

Here is the caller graph for this function:

getLineColor()

ilImagemapFileInputGUI::getLineColor

(

)

Definition at line 52 of file class.ilImagemapFileInputGUI.php.

        {
                return $this->line_color;
        }

References $line_color.

getPointsUncheckedFieldEnabled()

ilImagemapFileInputGUI::getPointsUncheckedFieldEnabled

(

)

Definition at line 42 of file class.ilImagemapFileInputGUI.php.

        {
                return $this->pointsUncheckedFieldEnabled;
        }

References $pointsUncheckedFieldEnabled.

Referenced by insert(), and setAreasByArray().

Here is the caller graph for this function:

insert()

ilImagemapFileInputGUI::insert

(

&

$a_tpl

)

Insert property html.

Reimplemented from ilImageFileInputGUI.

Definition at line 256 of file class.ilImagemapFileInputGUI.php.

        {
                global $lng;
                
                $template = new ilTemplate("tpl.prop_imagemap_file.html", true, true, "Modules/TestQuestionPool");
                
                $this->outputSuffixes($template, "allowed_image_suffixes");
                
                if ($this->getImage() != "")
                {
                        if (strlen($this->getValue()))
                        {
                                $template->setCurrentBlock("has_value");
                                $template->setVariable("TEXT_IMAGE_NAME", $this->getValue());
                                $template->setVariable("POST_VAR_D", $this->getPostVar());
                                $template->parseCurrentBlock();
                        }
                        $template->setCurrentBlock("image");
                        if (count($this->getAreas()))
                        {
                                include_once "./Modules/TestQuestionPool/classes/class.ilImagemapPreview.php";
                                $preview = new ilImagemapPreview($this->getImagePath().$this->getValue());
                                foreach ($this->getAreas() as $index => $area)
                                {
                                        $preview->addArea($index, $area->getArea(), $area->getCoords(), $area->getAnswertext(), "", "", true, $this->getLineColor());
                                }
                                $preview->createPreview();
                                $imagepath = $this->getImagePathWeb() . $preview->getPreviewFilename($this->getImagePath(), $this->getValue()) . "?img=" . time();
                                $template->setVariable("SRC_IMAGE", $imagepath);
                        }
                        else
                        {
                                $template->setVariable("SRC_IMAGE", $this->getImage());
                        }
                        $template->setVariable("ALT_IMAGE", $this->getAlt());
                        $template->setVariable("POST_VAR_D", $this->getPostVar());
                        $template->setVariable("TXT_DELETE_EXISTING",
                                $lng->txt("delete_existing_file"));
                        $template->setVariable("TEXT_ADD_RECT", $lng->txt('add_rect'));
                        $template->setVariable("TEXT_ADD_CIRCLE", $lng->txt('add_circle'));
                        $template->setVariable("TEXT_ADD_POLY", $lng->txt('add_poly'));
                        $template->parseCurrentBlock();
                }
 
                if(is_array($this->getAreas()) && $this->getAreas())
                {
                        $counter = 0;
                        foreach ($this->getAreas() as $area)
                        {
                                if (strlen($area->getPoints()))
                                {
                                        $template->setCurrentBlock('area_points_value');
                                        $template->setVariable('VALUE_POINTS', $area->getPoints());
                                        $template->parseCurrentBlock();
                                }
                                if( $this->getPointsUncheckedFieldEnabled() )
                                {
                                        if (strlen($area->getPointsUnchecked()))
                                        {
                                                $template->setCurrentBlock('area_points_unchecked_value');
                                                $template->setVariable('VALUE_POINTS_UNCHECKED', $area->getPointsUnchecked());
                                                $template->parseCurrentBlock();
                                        }
                                        
                                        $template->setCurrentBlock('area_points_unchecked_field');
                                        $template->parseCurrentBlock();
                                }
                                if (strlen($area->getAnswertext()))
                                {
                                        $template->setCurrentBlock('area_name_value');
                                        $template->setVariable('VALUE_NAME', $area->getAnswertext());
                                        $template->parseCurrentBlock();
                                }
                                $template->setCurrentBlock('row');
                                $template->setVariable('POST_VAR_R', $this->getPostVar());
                                $template->setVariable('TEXT_SHAPE', strtoupper($area->getArea()));
                                $template->setVariable('VALUE_SHAPE', $area->getArea());
                                $coords = preg_replace("/(\d+,\d+,)/", "\$1 ", $area->getCoords());
                                $template->setVariable('VALUE_COORDINATES', $area->getCoords());
                                $template->setVariable('TEXT_COORDINATES', $coords);
                                $template->setVariable('COUNTER', $counter);
                                $template->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
                                $template->parseCurrentBlock();
                                $counter++;
                        }
                        $template->setCurrentBlock("areas");
                        $template->setVariable("TEXT_NAME", $lng->txt("ass_imap_hint"));
                        if( $this->getPointsUncheckedFieldEnabled() )
                        {
                                $template->setVariable("TEXT_POINTS", $lng->txt("points_checked"));
                                                        
                                $template->setCurrentBlock('area_points_unchecked_head');
                                $template->setVariable("TEXT_POINTS_UNCHECKED", $lng->txt("points_unchecked"));
                                $template->parseCurrentBlock();
                        }
                        else
                        {
                                $template->setVariable("TEXT_POINTS", $lng->txt("points"));
                        }
                        $template->setVariable("TEXT_SHAPE", $lng->txt("shape"));
                        $template->setVariable("TEXT_COORDINATES", $lng->txt("coordinates"));
                        $template->setVariable("TEXT_COMMANDS", $lng->txt("actions"));
                        $template->parseCurrentBlock();
                }
                
                $template->setVariable("POST_VAR", $this->getPostVar());
                $template->setVariable("ID", $this->getFieldId());
                $template->setVariable("TXT_MAX_SIZE", $lng->txt("file_notice")." ".
                        $this->getMaxFileSizeString());
                        
                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $template->get());
                $a_tpl->parseCurrentBlock();
 
                global $tpl;
                $tpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
                $tpl->addJavascript("./Modules/TestQuestionPool/templates/default/imagemap.js");
        }

References $coords, $lng, $preview, $tpl, ilGlyphGUI\get(), ilImageFileInputGUI\getAlt(), getAreas(), ilFormPropertyGUI\getFieldId(), ilImageFileInputGUI\getImage(), getImagePath(), getImagePathWeb(), getPointsUncheckedFieldEnabled(), ilFormPropertyGUI\getPostVar(), ilFileInputGUI\getValue(), ilFileInputGUI\outputSuffixes(), and ilGlyphGUI\REMOVE.

Here is the call graph for this function:

setAreas()

ilImagemapFileInputGUI::setAreas

(

$a_areas

)

Definition at line 47 of file class.ilImagemapFileInputGUI.php.

        {
                $this->areas = $a_areas;
        }

setAreasByArray()

ilImagemapFileInputGUI::setAreasByArray

(

$a_areas

)

Definition at line 82 of file class.ilImagemapFileInputGUI.php.

        {
                if (is_array($a_areas['name']))
                {
                        $this->areas = array();
                        include_once "./Modules/TestQuestionPool/classes/class.assAnswerImagemap.php";
                        foreach ($a_areas['name'] as $idx => $name)
                        {
                                if( $this->getPointsUncheckedFieldEnabled() && isset($a_areas['points_unchecked']) )
                                {
                                        $pointsUnchecked = $a_areas['points_unchecked'][$idx];
                                }
                                else
                                {
                                        $pointsUnchecked = 0.0;
                                }
                                
                                array_push($this->areas, new ASS_AnswerImagemap(
                                        $name,
                                        $a_areas['points'][$idx],
                                        $idx,
                                        $a_areas['coords'][$idx], $a_areas['shape'][$idx],
                                        -1,
                                        $pointsUnchecked
                                ));
                        }
                }
        }

References getPointsUncheckedFieldEnabled().

Referenced by setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

setImagePath()

ilImagemapFileInputGUI::setImagePath

(

$a_path

)

Definition at line 67 of file class.ilImagemapFileInputGUI.php.

        {
                $this->image_path = $a_path;
        }

setImagePathWeb()

ilImagemapFileInputGUI::setImagePathWeb

(

$a_path_web

)

Definition at line 77 of file class.ilImagemapFileInputGUI.php.

        {
                $this->image_path_web = $a_path_web;
        }

setLineColor()

ilImagemapFileInputGUI::setLineColor

(

$a_color

)

Definition at line 57 of file class.ilImagemapFileInputGUI.php.

        {
                $this->line_color = $a_color;
        }

setPointsUncheckedFieldEnabled()

ilImagemapFileInputGUI::setPointsUncheckedFieldEnabled

(

$pointsUncheckedFieldEnabled

)

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

        {
                $this->pointsUncheckedFieldEnabled = (bool)$pointsUncheckedFieldEnabled;
        }

References $pointsUncheckedFieldEnabled.

setValue()

ilImagemapFileInputGUI::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 127 of file class.ilImagemapFileInputGUI.php.

        {
                parent::setValue($a_value);
        }

Referenced by setValueByArray().

Here is the caller graph for this function:

setValueByArray()

ilImagemapFileInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

Reimplemented from ilFileInputGUI.

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

        {
                $this->setValue($a_values[$this->getPostVar() . '_name']);
                $this->setAreasByArray($a_values[$this->getPostVar()]['coords']);
        }

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

Here is the call graph for this function:

Field Documentation

$areas

ilImagemapFileInputGUI::$areas = array()

protected

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

Referenced by getAreas().

$image_path

ilImagemapFileInputGUI::$image_path = ""

protected

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

Referenced by getImagePath().

$image_path_web

ilImagemapFileInputGUI::$image_path_web = ""

protected

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

Referenced by getImagePathWeb().

$line_color

ilImagemapFileInputGUI::$line_color = ""

protected

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

Referenced by getLineColor().

$pointsUncheckedFieldEnabled

ilImagemapFileInputGUI::$pointsUncheckedFieldEnabled = false

protected

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

Referenced by getPointsUncheckedFieldEnabled(), and setPointsUncheckedFieldEnabled().

---

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

• Modules/TestQuestionPool/classes/class.ilImagemapFileInputGUI.php