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 (array $a_values)
	Set value by array. More...

	setValue ($a_value)

	getInput ()

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

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

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

	setAllowDeletion (bool $a_val)

	getALlowDeletion ()

	setAllowCapture (bool $a_val)

	getAllowCapture ()

	setUseCache (bool $a_cache)
	Set cache. More...

	getUseCache ()

	setImage (string $a_image)

	getImage ()

	setAlt (string $a_alt)

	getAlt ()

	insert (ilTemplate $a_tpl)

	getDeletionFlag ()

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 ()
	Check input, strip slashes etc. More...

	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)
	Get item by post var. More...

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

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

Protected Attributes
	$areas = []

	$image_path = ""

	$image_path_web = ""

	$line_color = ""

	$pointsUncheckedFieldEnabled = false

ilTestLegacyFormsHelper	$forms_helper

GlyphFactory	$glyph_factory

ButtonFactory	$button_factory

Renderer	$renderer

Protected Attributes inherited from ilImageFileInputGUI
ilGlobalTemplateInterface	$tpl

bool	$cache = false

string	$alt = ""

string	$image = ""

bool	$allow_capture = false

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

Private Member Functions
	getPostBody ()

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

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

    {
        parent::__construct($a_title, $a_postvar);
 
        global $DIC;
 
        $this->forms_helper = new ilTestLegacyFormsHelper();
        $this->glyph_factory = $DIC->ui()->factory()->symbol()->glyph();
        $this->button_factory = $DIC->ui()->factory()->button();
        $this->renderer = $DIC->ui()->renderer();
    }

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

Here is the call graph for this function:

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.

Reimplemented in ilImagemapCorrectionsInputGUI.

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

                                : bool
    {
        $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_FORM_SIZE:
                case UPLOAD_ERR_INI_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 = ilVirusScanner::virusHandling($temp_name, $filename);
            if ($vir[0] == false) {
                $this->setAlert($lng->txt("form_msg_file_virus_found") . "<br />" . $vir[1]);
                return false;
            }
        }
 
        $post_body = $this->getPostBody();
 
        $max = 0;
        if (isset($post_body['coords']) && is_array($post_body['coords']['name'])) {
            foreach ($post_body['coords']['name'] as $idx => $name) {
                if ($this->getRequired() && (
                    !isset($post_body['coords']['points'][$idx]) ||
                    $post_body['coords']['points'][$idx] == ''
                )) {
                    $this->setAlert($lng->txt('form_msg_area_missing_points'));
                    return false;
                }
 
                if ((!is_numeric($post_body['coords']['points'][$idx]))) {
                    $this->setAlert($lng->txt('form_msg_numeric_value_required'));
                    return false;
                }
 
                if ($post_body['coords']['points'][$idx] > 0) {
                    $max = $post_body['coords']['points'][$idx];
                }
            }
        }
 
        if ($max == 0 && (!$filename) && !$_FILES['imagemapfile']['tmp_name']) {
            $this->setAlert($lng->txt("enter_enough_positive_points"));
            return false;
        }
        return true;
    }

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

Here is the call graph for this function:

◆ getAreas()

ilImagemapFileInputGUI::getAreas ( )

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

                              : array
    {
        return $this->areas;
    }

References $areas.

Referenced by ilImagemapCorrectionsInputGUI\insert(), and insert().

Here is the caller graph for this function:

◆ getImagePath()

ilImagemapFileInputGUI::getImagePath ( )

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

                                  : string
    {
        return $this->image_path;
    }

References $image_path.

Referenced by ilImagemapCorrectionsInputGUI\insert(), and insert().

Here is the caller graph for this function:

◆ getImagePathWeb()

ilImagemapFileInputGUI::getImagePathWeb ( )

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

                                     : string
    {
        return $this->image_path_web;
    }

References $image_path_web.

Referenced by ilImagemapCorrectionsInputGUI\insert(), and insert().

Here is the caller graph for this function:

◆ getInput()

ilImagemapFileInputGUI::getInput ( )

Reimplemented from ilFileInputGUI.

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

                              : array
    {
        return parent::getInput();
    }

◆ getLineColor()

ilImagemapFileInputGUI::getLineColor ( )

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

                                  : string
    {
        return $this->line_color;
    }

References $line_color.

◆ getPointsUncheckedFieldEnabled()

ilImagemapFileInputGUI::getPointsUncheckedFieldEnabled ( )

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

                                                    : bool
    {
        return $this->pointsUncheckedFieldEnabled;
    }

References $pointsUncheckedFieldEnabled.

Referenced by ilImagemapCorrectionsInputGUI\insert(), insert(), ilImagemapCorrectionsInputGUI\setAreasByArray(), and setAreasByArray().

Here is the caller graph for this function:

◆ getPostBody()

ilImagemapFileInputGUI::getPostBody ( )

private

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

                                  : array
    {
        $val = $this->arrayArray($this->getPostVar());
        $val = ilArrayUtil::stripSlashesRecursive($val);
        return $val;
    }

References ilFormPropertyGUI\arrayArray(), ilFormPropertyGUI\getPostVar(), and ilArrayUtil\stripSlashesRecursive().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

ilImagemapFileInputGUI::insert ( ilTemplate $a_tpl )

Insert property html.

Reimplemented from ilImageFileInputGUI.

Reimplemented in ilImagemapCorrectionsInputGUI.

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

                                             : void
    {
        $lng = $this->lng;
 
        $template = new ilTemplate("tpl.prop_imagemap_file.html", true, true, "components/ILIAS/TestQuestionPool");
 
        $this->outputSuffixes($template, "allowed_image_suffixes");
 
        if ($this->getImage() != "") {
            $template->setCurrentBlock("image");
            if (count($this->getAreas())) {
                $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', htmlspecialchars($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("REMOVE_BUTTON", $this->renderer->render(
                    $this->button_factory->shy('', '')->withSymbol($this->glyph_factory->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_BROWSE", $lng->txt("select_file"));
        $template->setVariable('MAX_SIZE_WARNING', $this->lng->txt('form_msg_file_size_exceeds'));
        $template->setVariable('MAX_SIZE', $this->upload_limit->getPhpUploadLimitInBytes());
        $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();
 
        $this->tpl->addJavascript("assets/js/answerwizardinput.js");
        $this->tpl->addJavascript("assets/js/imagemap.js");
    }

References ilFormPropertyGUI\$lng, ilImageFileInputGUI\getAlt(), getAreas(), ilFormPropertyGUI\getFieldId(), ilImageFileInputGUI\getImage(), getImagePath(), getImagePathWeb(), getPointsUncheckedFieldEnabled(), ilFormPropertyGUI\getPostVar(), ilFileInputGUI\getValue(), ILIAS\Repository\lng(), ilFileInputGUI\outputSuffixes(), ilTemplate\parseCurrentBlock(), renderer(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

Here is the call graph for this function:

◆ setAreas()

ilImagemapFileInputGUI::setAreas ( $a_areas )

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

                                      : void
    {
        $this->areas = $a_areas;
    }

◆ setAreasByArray()

ilImagemapFileInputGUI::setAreasByArray ( $a_areas )

Reimplemented in ilImagemapCorrectionsInputGUI.

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

                                             : void
    {
        if (is_array($a_areas['name'])) {
            $this->areas = [];
            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
                ));
 
                $imagemap = new ASS_AnswerImagemap($name, $a_areas['points'][$idx], $idx, 0, -1);
                $imagemap->setCoords($a_areas['coords'][$idx]);
                $imagemap->setArea($a_areas['shape'][$idx]);
                $imagemap->setPointsUnchecked($pointsUnchecked);
                array_push($this->areas, $imagemap);
            }
        }
    }

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

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

◆ setImagePathWeb()

ilImagemapFileInputGUI::setImagePathWeb ( $a_path_web )

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

                                                : void
    {
        $this->image_path_web = $a_path_web;
    }

◆ setLineColor()

ilImagemapFileInputGUI::setLineColor ( $a_color )

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

                                          : void
    {
        $this->line_color = $a_color;
    }

◆ setPointsUncheckedFieldEnabled()

ilImagemapFileInputGUI::setPointsUncheckedFieldEnabled ( $pointsUncheckedFieldEnabled )

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

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

References $pointsUncheckedFieldEnabled.

◆ setValue()

ilImagemapFileInputGUI::setValue ( $a_value )

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

                                      : void
    {
        parent::setValue($a_value);
    }

Referenced by setValueByArray().

Here is the caller graph for this function:

◆ setValueByArray()

ilImagemapFileInputGUI::setValueByArray ( array $a_values )

Set value by array.

Parameters

array $a_values value array

Reimplemented from ilFileInputGUI.

Reimplemented in ilImagemapCorrectionsInputGUI.

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

                                                    : void
    {
        if (isset($a_value[$this->getPostVar() . '_name'])) {
            $this->setValue($a_values[$this->getPostVar() . '_name']);
        }
        if (isset($a_value[$this->getPostVar()]['coords'])) {
            $this->setAreasByArray($a_values[$this->getPostVar()]['coords']);
        }
    }