User interface class for map editor. More...

Inheritance diagram for ilImageMapEditorGUI:

Collaboration diagram for ilImageMapEditorGUI:

Public Member Functions
	__construct (ilObjMediaObject $a_media_object)

	executeCommand ()

	editMapAreas ()

	getToolbar ()

	getEditorTitle ()

	getImageMapTableHTML ()

	handleMapParameters ()

	showImageMap ()

	updateAreas ()

	addNewArea ()

	linkWholePicture ()

	addRectangle ()

	addCircle ()

	addPolygon ()

	clearSessionVars ()

	addArea (bool $a_handle=true)

	editMapArea (bool $a_get_next_coordinate=false, bool $a_output_new_area=false, bool $a_save_form=false, string $a_edit_property="", int $a_area_nr=0)
	Edit a single map area. More...

	initAreaEditingForm (string $a_edit_property)

	makeMapWorkCopy (string $a_edit_property="", int $a_area_nr=0, bool $a_output_new_area=false, string $a_area_type="", string $a_coords="")
	Make work file for editing. More...

	getImageMapOutput (string $a_map_edit_mode="")
	Render the image map. More...

	getAdditionalPageXML ()
	Get additional page xml (to be overwritten) More...

	outputPostProcessing (string $a_output)

	getAliasXML ()

	getMapAreaLinkString (string $a_target, string $a_type, string $a_frame)
	Get text name of internal link. More...

	editImagemapForward ()
	Get image map coordinates. More...

	saveArea ()
	Save new or updated map area. More...

	setInternalLink ()

	setLink (bool $a_handle=true)

	getLinkTypeOfArea (int $a_nr)

	getTypeOfArea (int $a_nr)
	Get Type of Area (only internal link) More...

	getTargetOfArea (int $a_nr)
	Get Target of Area (only internal link) More...

	getTargetFrameOfArea (int $a_nr)
	Get TargetFrame of Area (only internal link) More...

	getHrefOfArea (int $a_nr)
	Get Href of Area (only external link) More...

	deleteAreas ()
	Delete map areas. More...

	editLink ()
	Edit existing link. More...

	editShapeWholePicture ()
	Edit an existing shape (make it a whole picture link) More...

	editShapeRectangle ()
	Edit an existing shape (make it a rectangle) More...

	editShapeCircle ()
	Edit an existing shape (make it a circle) More...

	editShapePolygon ()
	Edit an existing shape (make it a polygon) More...

	setShape (bool $a_handle=true)
	edit shape of existing map area More...

	setHighlight ()
	Set highlight settings. More...

Static Public Member Functions
static	_recoverParameters ()
	Recover parameters from session variables (static) More...

Protected Attributes
ilObjMediaObject	$media_object

ImageMapGUIRequest	$request

ImageMapManager	$map

ilTemplate	$tpl

ilGlobalTemplateInterface	$main_tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilToolbarGUI	$toolbar

Detailed Description

User interface class for map editor.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilImageMapEditorGUI: ilInternalLinkGUI

Definition at line 27 of file class.ilImageMapEditorGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilImageMapEditorGUI::__construct ( ilObjMediaObject $a_media_object )

Definition at line 38 of file class.ilImageMapEditorGUI.php.

      {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->lng = $DIC->language();
        $this->toolbar = $DIC->toolbar();
        $this->media_object = $a_media_object;
 
        $this->map = $DIC->mediaObjects()
            ->internal()
            ->domain()
            ->imageMap();
 
        $this->request = $DIC->mediaObjects()
            ->internal()
            ->gui()
            ->imageMap()
            ->request();
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ _recoverParameters()

static ilImageMapEditorGUI::_recoverParameters ( )

static

Recover parameters from session variables (static)

Definition at line 683 of file class.ilImageMapEditorGUI.php.

                                               : void
    {
        global $DIC;
 
        $map = $DIC->mediaObjects()->internal()->domain()->imageMap();
        /*
        $_GET["ref_id"] = $map->getRefId();
        $_GET["obj_id"] = $map->getObjId();
        $_GET["hier_id"] = $map->getHierId();
        $_GET["pc_id"] = $map->getPCId();*/
    }

References $DIC.

Referenced by editImagemapForward().

Here is the caller graph for this function:

◆ addArea()

ilImageMapEditorGUI::addArea ( bool $a_handle = true )

Definition at line 259 of file class.ilImageMapEditorGUI.php.

     : string {
 
        // handle map parameters
        if ($a_handle) {
            $this->handleMapParameters();
        }
 
        $area_type = $this->map->getAreaType();
        $coords = $this->map->getCoords();
        $cnt_coords = ilMapArea::countCoords($coords);
 
        // decide what to do next
        switch ($area_type) {
            // Rectangle
            case "Rect":
                if ($cnt_coords < 2) {
                    $html = $this->editMapArea(true, false, false);
                    return $html;
                } elseif ($cnt_coords == 2) {
                    return $this->editMapArea(false, true, true);
                }
                break;
 
            // Circle
            case "Circle":
                if ($cnt_coords <= 1) {
                    return $this->editMapArea(true, false, false);
                } else {
                    if ($cnt_coords == 2) {
                        $c = explode(",", $coords);
                        $coords = $c[0] . "," . $c[1] . ",";    // determine radius
                        $coords .= round(sqrt(pow(abs($c[3] - $c[1]), 2) + pow(abs($c[2] - $c[0]), 2)));
                    }
                    $this->map->setCoords($coords);
 
                    return $this->editMapArea(false, true, true);
                }
 
            // Polygon
            // no break
            case "Poly":
                if ($cnt_coords < 1) {
                    return $this->editMapArea(true, false, false);
                } elseif ($cnt_coords < 3) {
                    return $this->editMapArea(true, true, false);
                } else {
                    return $this->editMapArea(true, true, true);
                }
 
            // Whole picture
            // no break
            case "WholePicture":
                return $this->editMapArea(false, false, true);
        }
        return "";
    }

References handleMapParameters().

Referenced by addCircle(), addPolygon(), and addRectangle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCircle()

ilImageMapEditorGUI::addCircle ( )

Definition at line 240 of file class.ilImageMapEditorGUI.php.

                               : string
    {
        $this->clearSessionVars();
        $this->map->setAreaType("Circle");
        return $this->addArea(false);
    }

References addArea(), and clearSessionVars().

Referenced by addNewArea().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addNewArea()

ilImageMapEditorGUI::addNewArea ( )

Reimplemented in ilPCIIMTriggerEditorGUI.

Definition at line 214 of file class.ilImageMapEditorGUI.php.

                                : string
    {
        switch ($this->request->getAreaShape()) {
            case "WholePicture": return $this->linkWholePicture();
            case "Rect": return $this->addRectangle();
            case "Circle": return $this->addCircle();
            case "Poly": return $this->addPolygon();
        }
        return "";
    }

References addCircle(), addPolygon(), addRectangle(), and linkWholePicture().

Here is the call graph for this function:

◆ addPolygon()

ilImageMapEditorGUI::addPolygon ( )

Definition at line 247 of file class.ilImageMapEditorGUI.php.

                                : string
    {
        $this->clearSessionVars();
        $this->map->setAreaType("Poly");
        return $this->addArea(false);
    }

References addArea(), and clearSessionVars().

Referenced by addNewArea().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addRectangle()

ilImageMapEditorGUI::addRectangle ( )

Definition at line 233 of file class.ilImageMapEditorGUI.php.

                                  : string
    {
        $this->clearSessionVars();
        $this->map->setAreaType("Rect");
        return $this->addArea(false);
    }

References addArea(), and clearSessionVars().

Referenced by addNewArea().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearSessionVars()

ilImageMapEditorGUI::clearSessionVars ( )

Definition at line 254 of file class.ilImageMapEditorGUI.php.

                                      : void
    {
        $this->map->clear();
    }

Referenced by addCircle(), addPolygon(), addRectangle(), and linkWholePicture().

Here is the caller graph for this function:

◆ deleteAreas()

ilImageMapEditorGUI::deleteAreas ( )

Delete map areas.

Reimplemented in ilPCImageMapEditorGUI.

Definition at line 905 of file class.ilImageMapEditorGUI.php.

                                 : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $area = $this->request->getArea();
        if (count($area) == 0) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "editMapAreas");
        }
 
        $st_item = $this->media_object->getMediaItem("Standard");
        $max = ilMapArea::_getMaxNr($st_item->getId());
 
        if (count($area) > 0) {
            $i = 0;
 
            foreach ($area as $area_nr) {
                $st_item->deleteMapArea($area_nr - $i);
                $i++;
            }
 
            $this->media_object->update();
            $this->main_tpl->setOnScreenMessage('success', $lng->txt("cont_areas_deleted"), true);
        }
 
        $ilCtrl->redirect($this, "editMapAreas");
    }

References $i, $lng, and ilMapArea\_getMaxNr().

Here is the call graph for this function:

◆ editImagemapForward()

ilImageMapEditorGUI::editImagemapForward ( )

Get image map coordinates.

Definition at line 664 of file class.ilImageMapEditorGUI.php.

                                         : void
    {
        ilImageMapEditorGUI::_recoverParameters();
 
        $coords = $this->map->getCoords();
        if ($coords != "") {
            $coords .= ",";
        }
 
        $this->map->setCoords($coords . $this->request->getX() . "," .
            $this->request->getY());
 
        // call editing script
        ilUtil::redirect($this->map->getTargetScript());
    }

References _recoverParameters(), and ilUtil\redirect().

Here is the call graph for this function:

◆ editLink()

ilImageMapEditorGUI::editLink ( )

Edit existing link.

Definition at line 937 of file class.ilImageMapEditorGUI.php.

                              : string
    {
        $this->map->clear();
        return $this->setLink(false);
    }

◆ editMapArea()

ilImageMapEditorGUI::editMapArea	(	bool	$a_get_next_coordinate = `false`,
		bool	$a_output_new_area = `false`,
		bool	$a_save_form = `false`,
		string	$a_edit_property = `""`,
		int	$a_area_nr = `0`
	)

Edit a single map area.

Parameters

bool	$a_get_next_coordinate	enable next coordinate input
bool	$a_output_new_area	output the new area
bool	$a_save_form	output save form
string	$a_edit_property	"" \| "link" \| "shape"
int	$a_area_nr

Returns: string

Definition at line 327 of file class.ilImageMapEditorGUI.php.

     : string {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $area_type = $this->map->getAreaType();
        $coords = $this->map->getCoords();
        $cnt_coords = ilMapArea::countCoords($coords);
 
        $this->tpl = new ilTemplate("tpl.map_edit.html", true, true, "Services/MediaObjects");
 
        $this->tpl->setVariable("FORMACTION", $ilCtrl->getFormAction($this));
 
        if ($a_edit_property != "link") {
            switch ($area_type) {
                // rectangle
                case "Rect":
                    if ($cnt_coords == 0) {
                        $this->main_tpl->setOnScreenMessage('info', $lng->txt("cont_click_tl_corner"));
                    }
                    if ($cnt_coords == 1) {
                        $this->main_tpl->setOnScreenMessage('info', $lng->txt("cont_click_br_corner"));
                    }
                    break;
 
                // circle
                case "Circle":
                    if ($cnt_coords == 0) {
                        $this->main_tpl->setOnScreenMessage('info', $lng->txt("cont_click_center"));
                    }
                    if ($cnt_coords == 1) {
                        $this->main_tpl->setOnScreenMessage('info', $lng->txt("cont_click_circle"));
                    }
                    break;
 
                // polygon
                case "Poly":
                    if ($cnt_coords == 0) {
                        $this->main_tpl->setOnScreenMessage('info', $lng->txt("cont_click_starting_point"));
                    } elseif ($cnt_coords < 3) {
                        $this->main_tpl->setOnScreenMessage('info', $lng->txt("cont_click_next_point"));
                    } else {
                        $this->main_tpl->setOnScreenMessage('info', $lng->txt("cont_click_next_or_save"));
                    }
                    break;
            }
        }
 
 
        // map properties input fields (name and link)
        if ($a_save_form) {
            if ($a_edit_property != "shape") {
                // prepare link gui
                $ilCtrl->setParameter($this, "linkmode", "map");
                $this->tpl->setCurrentBlock("int_link_prep");
                $this->tpl->setVariable("INT_LINK_PREP", ilInternalLinkGUI::getInitHTML(
                    $ilCtrl->getLinkTargetByClass(
                        "ilinternallinkgui",
                        "",
                        false,
                        true,
                        false
                    )
                ));
                $this->tpl->parseCurrentBlock();
            }
            $form = $this->initAreaEditingForm($a_edit_property);
            $this->tpl->setVariable("FORM", $form->getHTML());
        }
 
        $this->makeMapWorkCopy(
            $a_edit_property,
            $a_area_nr,
            $a_output_new_area,
            $area_type,
            $coords
        );
 
        $edit_mode = ($a_get_next_coordinate)
            ? "get_coords"
            : (($a_output_new_area)
                ? "new_area"
                : "");
        $output = $this->getImageMapOutput($edit_mode);
        $this->tpl->setVariable("IMAGE_MAP", $output);
 
        return $this->tpl->get();
    }

Referenced by linkWholePicture().

Here is the caller graph for this function:

◆ editMapAreas()

ilImageMapEditorGUI::editMapAreas ( )

Definition at line 97 of file class.ilImageMapEditorGUI.php.

                                  : string
    {
        $ilCtrl = $this->ctrl;
 
        $this->map->setTargetScript(
            $ilCtrl->getLinkTarget(
                $this,
                "addArea",
                "",
                false,
                false
            )
        );
        $this->handleMapParameters();
 
        $this->tpl = new ilTemplate("tpl.map_edit.html", true, true, "Services/MediaObjects");
        $this->tpl->setVariable("FORMACTION", $ilCtrl->getFormAction($this));
 
        // create/update imagemap work copy
        $this->makeMapWorkCopy();
 
        $output = $this->getImageMapOutput();
        $this->tpl->setVariable("IMAGE_MAP", $output);
 
        $this->tpl->setVariable("TOOLBAR", $this->getToolbar()->getHTML());
 
        // table
        $this->tpl->setVariable("MAP_AREA_TABLE", $this->getImageMapTableHTML());
 
        return $this->tpl->get();
    }

References $ctrl, getImageMapOutput(), getImageMapTableHTML(), getToolbar(), handleMapParameters(), makeMapWorkCopy(), and ilCtrl\setTargetScript().

Here is the call graph for this function:

◆ editShapeCircle()

ilImageMapEditorGUI::editShapeCircle ( )

Edit an existing shape (make it a circle)

Definition at line 966 of file class.ilImageMapEditorGUI.php.

                                     : string
    {
        $this->clearSessionVars();
        $this->map->setAreaType("Circle");
        return $this->setShape(false);
    }

◆ editShapePolygon()

ilImageMapEditorGUI::editShapePolygon ( )

Edit an existing shape (make it a polygon)

Definition at line 976 of file class.ilImageMapEditorGUI.php.

                                      : string
    {
        $this->clearSessionVars();
        $this->map->setAreaType("Poly");
        return $this->setShape(false);
    }

◆ editShapeRectangle()

ilImageMapEditorGUI::editShapeRectangle ( )

Edit an existing shape (make it a rectangle)

Definition at line 956 of file class.ilImageMapEditorGUI.php.

                                        : string
    {
        $this->clearSessionVars();
        $this->map->setAreaType("Rect");
        return $this->setShape(false);
    }

◆ editShapeWholePicture()

ilImageMapEditorGUI::editShapeWholePicture ( )

Edit an existing shape (make it a whole picture link)

Definition at line 946 of file class.ilImageMapEditorGUI.php.

                                           : string
    {
        $this->clearSessionVars();
        $this->map->setAreaType("WholePicture");
        return $this->setShape(false);
    }

◆ executeCommand()

ilImageMapEditorGUI::executeCommand ( )

Returns: mixed

Exceptions

ilCtrlException

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

    {
        $ilCtrl = $this->ctrl;
 
        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd();
 
        switch ($next_class) {
            case "ilinternallinkgui":
                $link_gui = new ilInternalLinkGUI("Media_Media", 0);
                $link_gui->setSetLinkTargetScript(
                    $ilCtrl->getLinkTarget(
                        $this,
                        "setInternalLink"
                    )
                );
                $link_gui->filterLinkType("File");
                $ret = $ilCtrl->forwardCommand($link_gui);
                break;
 
            default:
                ilObjMediaObjectGUI::includePresentationJS();
                if ($this->request->getX() != "" &&
                    $this->request->getY() != "") {
                    $cmd = "editImagemapForward";
                }
                $ret = $this->$cmd();
                break;
        }
        return $ret;
    }

References $ctrl, ilCtrl\getNextClass(), and ilObjMediaObjectGUI\includePresentationJS().

Here is the call graph for this function:

◆ getAdditionalPageXML()

ilImageMapEditorGUI::getAdditionalPageXML ( )

Get additional page xml (to be overwritten)

Returns: string additional page xml

Reimplemented in ilPCIIMTriggerEditorGUI.

Definition at line 578 of file class.ilImageMapEditorGUI.php.

                                          : string
    {
        return "";
    }

◆ getAliasXML()

ilImageMapEditorGUI::getAliasXML ( )

Reimplemented in ilPCImageMapEditorGUI.

Definition at line 589 of file class.ilImageMapEditorGUI.php.

                                 : string
    {
        return $this->media_object->getXML(IL_MODE_ALIAS);
    }

References IL_MODE_ALIAS.

◆ getEditorTitle()

ilImageMapEditorGUI::getEditorTitle ( )

Reimplemented in ilPCIIMTriggerEditorGUI.

Definition at line 151 of file class.ilImageMapEditorGUI.php.

                                    : string
    {
        $lng = $this->lng;
        return $lng->txt("cont_imagemap");
    }

References $lng, and ilLanguage\txt().

Here is the call graph for this function:

◆ getHrefOfArea()

ilImageMapEditorGUI::getHrefOfArea ( int $a_nr )

Get Href of Area (only external link)

Reimplemented in ilPCImageMapEditorGUI.

Definition at line 894 of file class.ilImageMapEditorGUI.php.

     : string {
        $st_item = $this->media_object->getMediaItem("Standard");
        $area = $st_item->getMapArea($a_nr);
        return $area->getHref();
    }

◆ getImageMapOutput()

ilImageMapEditorGUI::getImageMapOutput ( string $a_map_edit_mode = "" )

Render the image map.

Definition at line 532 of file class.ilImageMapEditorGUI.php.

     : string {
        $ilCtrl = $this->ctrl;
 
        $st_item = $this->media_object->getMediaItem("Standard");
 
        // output image map
        $xml = "<dummy>";
        $xml .= $this->getAliasXML();
        $xml .= $this->media_object->getXML(IL_MODE_OUTPUT);
        $xml .= $this->getAdditionalPageXML();
        $xml .= "</dummy>";
        $xsl = file_get_contents("./Services/COPage/xsl/page.xsl");
        //echo htmlentities($xml); exit;
        $args = array( '/_xml' => $xml, '/_xsl' => $xsl );
        $xh = xslt_create();
        $wb_path = ilFileUtils::getWebspaceDir("output") . "/";
        $mode = "media";
        //echo htmlentities($ilCtrl->getLinkTarget($this, "showImageMap"));
 
        $random = new \ilRandom();
        $params = array('map_edit_mode' => $a_map_edit_mode,
            'map_item' => $st_item->getId(),
            'map_mob_id' => $this->media_object->getId(),
            'mode' => $mode,
            'media_mode' => 'enable',
            'image_map_link' => $ilCtrl->getLinkTarget($this, "showImageMap", "", false, false),
            'link_params' => "ref_id=" . $this->request->getRefId() . "&rand=" . $random->int(1, 999999),
            'ref_id' => $this->request->getRefId(),
            'pg_frame' => "",
            'enlarge_path' => ilUtil::getImagePath("enlarge.svg"),
            'webspace_path' => $wb_path);
        $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", null, $args, $params);
        xslt_error($xh);
        xslt_free($xh);
 
        $output = $this->outputPostProcessing($output);
 
        return $output;
    }

Referenced by editMapAreas().

Here is the caller graph for this function:

◆ getImageMapTableHTML()

ilImageMapEditorGUI::getImageMapTableHTML ( )

Reimplemented in ilPCIIMTriggerEditorGUI, and ilPCImageMapEditorGUI.

Definition at line 158 of file class.ilImageMapEditorGUI.php.

                                          : string
    {
        $image_map_table = new ilImageMapTableGUI($this, "editMapAreas", $this->media_object);
        return $image_map_table->getHTML();
    }

Referenced by editMapAreas().

Here is the caller graph for this function:

◆ getLinkTypeOfArea()

ilImageMapEditorGUI::getLinkTypeOfArea ( int $a_nr )

Reimplemented in ilPCImageMapEditorGUI.

Definition at line 850 of file class.ilImageMapEditorGUI.php.

     : string {
        $st_item = $this->media_object->getMediaItem("Standard");
        $area = $st_item->getMapArea($a_nr);
        return $area->getLinkType();
    }

◆ getMapAreaLinkString()

ilImageMapEditorGUI::getMapAreaLinkString	(	string	$a_target,
		string	$a_type,
		string	$a_frame
	)

Get text name of internal link.

Parameters

string	$a_target	target object link id
string	$a_type	type
string	$a_frame	target frame

Definition at line 600 of file class.ilImageMapEditorGUI.php.

     : string {
        $lng = $this->lng;
        $frame_str = "";
        $link_str = "";
        $t_arr = explode("_", $a_target);
        if ($a_frame != "") {
            $frame_str = " (" . $a_frame . " Frame)";
        }
        switch ($a_type) {
            case "StructureObject":
                $title = ilLMObject::_lookupTitle($t_arr[count($t_arr) - 1]);
                $link_str = $lng->txt("chapter") .
                    ": " . $title . " [" . $t_arr[count($t_arr) - 1] . "]" . $frame_str;
                break;
 
            case "PageObject":
                $title = ilLMObject::_lookupTitle($t_arr[count($t_arr) - 1]);
                $link_str = $lng->txt("page") .
                    ": " . $title . " [" . $t_arr[count($t_arr) - 1] . "]" . $frame_str;
                break;
 
            case "GlossaryItem":
                $term = new ilGlossaryTerm($t_arr[count($t_arr) - 1]);
                $link_str = $lng->txt("term") .
                    ": " . $term->getTerm() . " [" . $t_arr[count($t_arr) - 1] . "]" . $frame_str;
                break;
 
            case "MediaObject":
                $mob = new ilObjMediaObject($t_arr[count($t_arr) - 1]);
                $link_str = $lng->txt("mob") .
                    ": " . $mob->getTitle() . " [" . $t_arr[count($t_arr) - 1] . "]" . $frame_str;
                break;
 
            case "RepositoryItem":
                if (trim($a_target) !== "") {
                    $title = ilObject::_lookupTitle(
                        ilObject::_lookupObjId((int) $t_arr[count($t_arr) - 1])
                    );
                    $link_str = $lng->txt("obj_" . $t_arr[count($t_arr) - 2]) .
                        ": " . $title . " [" . $t_arr[count($t_arr) - 1] . "]" . $frame_str;
                } else {
                    $title = "";
                    $link_str = "";
                }
                break;
 
            case "WikiPage":
                $wpg = new ilWikiPage($t_arr[count($t_arr) - 1]);
                $link_str = $lng->txt("cont_wiki_page") .
                    ": " . $wpg->getTitle() . " [" . $t_arr[count($t_arr) - 1] . "]" . $frame_str;
                break;
 
        }
 
        return $link_str;
    }

◆ getTargetFrameOfArea()

ilImageMapEditorGUI::getTargetFrameOfArea ( int $a_nr )

Get TargetFrame of Area (only internal link)

Reimplemented in ilPCImageMapEditorGUI.

Definition at line 883 of file class.ilImageMapEditorGUI.php.

     : string {
        $st_item = $this->media_object->getMediaItem("Standard");
        $area = $st_item->getMapArea($a_nr);
        return $area->getTargetFrame();
    }

◆ getTargetOfArea()

ilImageMapEditorGUI::getTargetOfArea ( int $a_nr )

Get Target of Area (only internal link)

Reimplemented in ilPCImageMapEditorGUI.

Definition at line 872 of file class.ilImageMapEditorGUI.php.

     : string {
        $st_item = $this->media_object->getMediaItem("Standard");
        $area = $st_item->getMapArea($a_nr);
        return $area->getTarget();
    }

◆ getToolbar()

ilImageMapEditorGUI::getToolbar ( )

Reimplemented in ilPCIIMTriggerEditorGUI.

Definition at line 129 of file class.ilImageMapEditorGUI.php.

                                : ilToolbarGUI
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        // toolbar
        $tb = new ilToolbarGUI();
        $tb->setFormAction($ilCtrl->getFormAction($this));
        $options = array(
            "WholePicture" => $lng->txt("cont_WholePicture"),
            "Rect" => $lng->txt("cont_Rect"),
            "Circle" => $lng->txt("cont_Circle"),
            "Poly" => $lng->txt("cont_Poly"),
            );
        $si = new ilSelectInputGUI($lng->txt("cont_shape"), "shape");
        $si->setOptions($options);
        $tb->addInputItem($si, true);
        $tb->addFormButton($lng->txt("cont_add_area"), "addNewArea");
 
        return $tb;
    }

References $ctrl, $lng, and ilLanguage\txt().

Referenced by editMapAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTypeOfArea()

ilImageMapEditorGUI::getTypeOfArea ( int $a_nr )

Get Type of Area (only internal link)

Reimplemented in ilPCImageMapEditorGUI.

Definition at line 861 of file class.ilImageMapEditorGUI.php.

     : string {
        $st_item = $this->media_object->getMediaItem("Standard");
        $area = $st_item->getMapArea($a_nr);
        return $area->getType();
    }

◆ handleMapParameters()

ilImageMapEditorGUI::handleMapParameters ( )

Definition at line 164 of file class.ilImageMapEditorGUI.php.

                                         : void
    {
        if ($this->request->getRefId() > 0) {
            $this->map->setRefId($this->request->getRefId());
        }
 
        if ($this->request->getObjId() > 0) {
            $this->map->setObjId($this->request->getObjId());
        }
 
        if ($this->request->getHierId() != "") {
            $this->map->setHierId($this->request->getHierId());
        }
 
        if ($this->request->getPCId() != "") {
            $this->map->setPCId($this->request->getPCId());
        }
    }

Referenced by addArea(), and editMapAreas().

Here is the caller graph for this function:

◆ initAreaEditingForm()

ilImageMapEditorGUI::initAreaEditingForm ( string $a_edit_property )

Reimplemented in ilPCIIMTriggerEditorGUI.

Definition at line 421 of file class.ilImageMapEditorGUI.php.

     : ilPropertyFormGUI {
        $lng = $this->lng;
 
        $form = new ilPropertyFormGUI();
        $form->setOpenTag(false);
        $form->setCloseTag(false);
 
        // link
        if ($a_edit_property != "shape") {
            //
            $radg = new ilRadioGroupInputGUI($lng->txt("cont_link"), "area_link_type");
            if ($this->map->getLinkType() != "int") {
                if ($this->map->getExternalLink() == "") {
                    $radg->setValue("no");
                } else {
                    $radg->setValue("ext");
                }
            } else {
                $radg->setValue("int");
            }
 
            // external link
            $ext = new ilRadioOption($lng->txt("cont_link_ext"), "ext");
            $radg->addOption($ext);
 
            $ti = new ilTextInputGUI("", "area_link_ext");
            $ti->setMaxLength(800);
            $ti->setSize(50);
            if ($this->map->getExternalLink() != "") {
                $ti->setValue($this->map->getExternalLink());
            } else {
                $ti->setValue("https://");
            }
            $ext->addSubItem($ti);
 
            // internal link
            $int = new ilRadioOption($lng->txt("cont_link_int"), "int");
            $radg->addOption($int);
 
            $ne = new ilNonEditableValueGUI("", "", true);
            $link_str = "";
            $int_link = $this->map->getInternalLink();
            if ($int_link["target"] != "") {
                $link_str = $this->getMapAreaLinkString(
                    $int_link["target"],
                    $int_link["type"],
                    $int_link["target_frame"]
                );
            }
            $ne->setValue(
                $link_str .
                    '&nbsp;<a id="iosEditInternalLinkTrigger" href="#">' .
                    "[" . $lng->txt("cont_get_link") . "]" .
                    '</a>'
            );
            $int->addSubItem($ne);
 
            // no link
            $no = new ilRadioOption($lng->txt("cont_link_no"), "no");
            $radg->addOption($no);
 
            $form->addItem($radg);
        }
 
 
        // name
        if ($a_edit_property != "link" && $a_edit_property != "shape") {
            $ti = new ilTextInputGUI($lng->txt("cont_name"), "area_name");
            $ti->setMaxLength(200);
            $ti->setSize(20);
            $form->addItem($ti);
        }
 
        // save and cancel commands
        $form->setTitle($lng->txt("cont_new_area"));
        $form->addCommandButton("saveArea", $lng->txt("save"));
 
        //              $form->setFormAction($ilCtrl->getFormAction($this));
 
        return $form;
    }

◆ linkWholePicture()

ilImageMapEditorGUI::linkWholePicture ( )

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

                                      : string
    {
        $this->clearSessionVars();
        $this->map->setAreaType("WholePicture");
 
        return $this->editMapArea(false, false, true);
    }

References clearSessionVars(), and editMapArea().

Referenced by addNewArea().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeMapWorkCopy()

ilImageMapEditorGUI::makeMapWorkCopy	(	string	$a_edit_property = `""`,
		int	$a_area_nr = `0`,
		bool	$a_output_new_area = `false`,
		string	$a_area_type = `""`,
		string	$a_coords = `""`
	)

Make work file for editing.

Reimplemented in ilPCImageMapEditorGUI.

Definition at line 508 of file class.ilImageMapEditorGUI.php.

     : void {
        // create/update imagemap work copy
        $st_item = $this->media_object->getMediaItem("Standard");
 
        if ($a_edit_property == "shape") {
            $st_item->makeMapWorkCopy($a_area_nr, true);        // exclude area currently being edited
        } else {
            $st_item->makeMapWorkCopy($a_area_nr, false);
        }
 
        if ($a_output_new_area) {
            $st_item->addAreaToMapWorkCopy($a_area_type, $a_coords);
        }
    }

Referenced by editMapAreas().

Here is the caller graph for this function:

◆ outputPostProcessing()

ilImageMapEditorGUI::outputPostProcessing ( string $a_output )

Reimplemented in ilPCIIMTriggerEditorGUI.

Definition at line 583 of file class.ilImageMapEditorGUI.php.

     : string {
        return $a_output;
    }

◆ saveArea()

ilImageMapEditorGUI::saveArea ( )

Save new or updated map area.

Reimplemented in ilPCIIMTriggerEditorGUI, and ilPCImageMapEditorGUI.

Definition at line 698 of file class.ilImageMapEditorGUI.php.

                              : string
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        switch ($this->map->getMode()) {
            // save edited link
            case "edit_link":
                $st_item = $this->media_object->getMediaItem("Standard");
                $max = ilMapArea::_getMaxNr($st_item->getId());
                $area = new ilMapArea($st_item->getId(), $this->map->getAreaNr());
 
                if ($this->request->getAreaLinkType() == IL_INT_LINK) {
                    $area->setLinkType(IL_INT_LINK);
                    $int_link = $this->map->getInternalLink();
                    $area->setType($int_link["type"] ?? "");
                    $area->setTarget($int_link["target"] ?? "");
                    $area->setTargetFrame($int_link["target_frame"] ?? "");
                } else {
                    $area->setLinkType(IL_EXT_LINK);
                    if ($this->request->getAreaLinkType() != IL_NO_LINK) {
                        $area->setHref(
                            $this->request->getExternalLink()
                        );
                    } else {
                        $area->setHref("");
                    }
                }
                $area->update();
                break;
 
            // save edited shape
            case "edit_shape":
                $st_item = $this->media_object->getMediaItem("Standard");
                $max = ilMapArea::_getMaxNr($st_item->getId());
                $area = new ilMapArea(
                    $st_item->getId(),
                    $this->map->getAreaNr()
                );
 
                $area->setShape($this->map->getAreaType());
                $area->setCoords($this->map->getCoords());
                $area->update();
                break;
 
            // save new area
            default:
                $area_type = $this->map->getAreaType();
                $coords = $this->map->getCoords();
 
                $st_item = $this->media_object->getMediaItem("Standard");
                $max = ilMapArea::_getMaxNr($st_item->getId());
 
                // make new area object
                $area = new ilMapArea();
                $area->setItemId($st_item->getId());
                $area->setShape($area_type);
                $area->setCoords($coords);
                $area->setNr($max + 1);
                $area->setTitle($this->request->getAreaName());
                switch ($this->request->getAreaLinkType()) {
                    case "ext":
                        $area->setLinkType(IL_EXT_LINK);
                        $area->setHref($this->request->getExternalLink());
                        break;
 
                    case "int":
                        $area->setLinkType(IL_INT_LINK);
                        $int_link = $this->map->getInternalLink();
                        $area->setType($int_link["type"] ?? "");
                        $area->setTarget($int_link["target"] ?? "");
                        $area->setTargetFrame($int_link["type_frame"] ?? "");
                        break;
                }
 
                // put area into item and update media object
                $st_item->addMapArea($area);
                $this->media_object->update();
                break;
        }
 
        //$this->initMapParameters();
        $this->main_tpl->setOnScreenMessage('success', $lng->txt("cont_saved_map_area"), true);
        $ilCtrl->redirect($this, "editMapAreas");
        return "";
    }

References $lng, ilMapArea\_getMaxNr(), IL_EXT_LINK, IL_INT_LINK, and IL_NO_LINK.

Here is the call graph for this function:

◆ setHighlight()

ilImageMapEditorGUI::setHighlight ( )

Set highlight settings.

Definition at line 1076 of file class.ilImageMapEditorGUI.php.

                                  : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $st_item = $this->media_object->getMediaItem("Standard");
        // seems to be obsolete, methods don't exist
        //$st_item->setHighlightMode($this->request->getHighlightMode());
        //$st_item->setHighlightClass($this->request->getHighlightClass());
        $st_item->update();
 
        $this->main_tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "editMapAreas");
    }

References $lng.

◆ setInternalLink()

ilImageMapEditorGUI::setInternalLink ( )

Definition at line 785 of file class.ilImageMapEditorGUI.php.

                                     : string
    {
        $this->map->setLinkType("int");
        $this->map->setInternalLink(
            $this->request->getLinkType(),
            $this->request->getLinkTarget(),
            $this->request->getLinkTargetFrame(),
            $this->request->getLinkAnchor()
        );
 
        switch ($this->map->getMode()) {
            case "edit_link":
                return $this->setLink();
 
            default:
                return $this->addArea();
        }
    }

◆ setLink()

ilImageMapEditorGUI::setLink ( bool $a_handle = true )

Definition at line 804 of file class.ilImageMapEditorGUI.php.

     : string {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $area = null;
        if ($a_handle) {
            $this->handleMapParameters();
        }
        if ($this->map->getAreaNr() > 0) {
            $area_nr = $this->map->getAreaNr();
        } else {
            $area = $this->request->getArea();
            $area_nr = (int) ($area[0] ?? 0);
        }
        if ($area_nr === 0) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "editMapAreas");
        }
 
        if (count($area ?? []) > 1) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt("cont_select_max_one_item"), true);
            $ilCtrl->redirect($this, "editMapAreas");
        }
 
 
        if ($this->map->getMode() != "edit_link") {
            $this->map->setAreaNr($area_nr);
            $this->map->setLinkType($this->getLinkTypeOfArea($area_nr));
            $this->map->setMode("edit_link");
            $this->map->setTargetScript($ilCtrl->getLinkTarget($this, "setLink"));
            if ($this->map->getLinkType() == IL_INT_LINK) {
                $this->map->setInternalLink(
                    $this->getTypeOfArea($area_nr),
                    $this->getTargetOfArea($area_nr),
                    $this->getTargetFrameOfArea($area_nr),
                    ""
                );
            } else {
                $this->map->setExternalLink($this->getHrefOfArea($area_nr));
            }
        }
 
        return $this->editMapArea(false, false, true, "link", $area_nr);
    }

◆ setShape()

ilImageMapEditorGUI::setShape ( bool $a_handle = true )

edit shape of existing map area

Definition at line 986 of file class.ilImageMapEditorGUI.php.

     : string {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $area = [];
        if ($a_handle) {
            $this->handleMapParameters();
        }
        /* this seems to be obsolete
        if ($_POST["areatype2"] != "") {
            $this->map->setAreaType($_POST["areatype2"]);
        }*/
        if ($this->map->getAreaNr() > 0) {
            $area_nr = $this->map->getAreaNr();
        } else {
            $area = $this->request->getArea();
            $area_nr = (int) ($area[0] ?? 0);
        }
        if ($area_nr === 0) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "editMapAreas");
        }
 
        if (count($area ?? []) > 1) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt("cont_select_max_one_item"), true);
            $ilCtrl->redirect($this, "editMapAreas");
        }
 
        if ($this->map->getMode() != "edit_shape") {
            $this->map->setAreaNr($area_nr);
            $this->map->setMode("edit_shape");
            $this->map->setTargetScript(
                $ilCtrl->getLinkTarget($this, "setShape", "", false, false)
            );
        }
 
 
        $area_type = $this->map->getAreaType();
        $coords = $this->map->getCoords();
        $cnt_coords = ilMapArea::countCoords($coords);
 
        // decide what to do next
        switch ($area_type) {
            // Rectangle
            case "Rect":
                if ($cnt_coords < 2) {
                    return $this->editMapArea(true, false, false, "shape", $area_nr);
                } elseif ($cnt_coords == 2) {
                    return $this->saveArea();
                }
                break;
 
            // Circle
            case "Circle":
                if ($cnt_coords <= 1) {
                    return $this->editMapArea(true, false, false, "shape", $area_nr);
                } else {
                    if ($cnt_coords == 2) {
                        $c = explode(",", $coords);
                        $coords = $c[0] . "," . $c[1] . ",";    // determine radius
                        $coords .= round(sqrt(pow(abs($c[3] - $c[1]), 2) + pow(abs($c[2] - $c[0]), 2)));
                    }
                    $this->map->setCoords($coords);
                    return $this->saveArea();
                }
 
            // Polygon
            // no break
            case "Poly":
                if ($cnt_coords < 1) {
                    return $this->editMapArea(true, false, false, "shape", $area_nr);
                } elseif ($cnt_coords < 3) {
                    return $this->editMapArea(true, true, false, "shape", $area_nr);
                } else {
                    return $this->editMapArea(true, true, true, "shape", $area_nr);
                }
 
            // Whole Picture
            // no break
            case "WholePicture":
                return $this->saveArea();
        }
        return "";
    }

◆ showImageMap()

ilImageMapEditorGUI::showImageMap ( )

Definition at line 183 of file class.ilImageMapEditorGUI.php.

                                  : void
    {
        $item = new ilMediaItem($this->request->getItemId());
        $item->outputMapWorkCopy();
    }

◆ updateAreas()

ilImageMapEditorGUI::updateAreas ( )

Reimplemented in ilPCImageMapEditorGUI.

Definition at line 189 of file class.ilImageMapEditorGUI.php.

                                 : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $st_item = $this->media_object->getMediaItem("Standard");
        $max = ilMapArea::_getMaxNr($st_item->getId());
        for ($i = 1; $i <= $max; $i++) {
            $area = new ilMapArea($st_item->getId(), $i);
            $area->setTitle(
                $this->request->getAreaTitle($i)
            );
            $area->setHighlightMode(
                $this->request->getAreaHighlightMode($i)
            );
            $area->setHighlightClass(
                $this->request->getAreaHighlightClass($i)
            );
            $area->update();
        }
 
        $this->main_tpl->setOnScreenMessage('success', $lng->txt("cont_saved_map_data"), true);
        $ilCtrl->redirect($this, "editMapAreas");
    }

References $ctrl, $i, $lng, ilMapArea\_getMaxNr(), and ilLanguage\txt().

Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilImageMapEditorGUI::$ctrl

protected

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

Referenced by ilPCIIMTriggerEditorGUI\addNewArea(), ilPCImageMapEditorGUI\deleteAreas(), editMapAreas(), executeCommand(), ilPCIIMTriggerEditorGUI\getImageMapTableHTML(), ilPCIIMTriggerEditorGUI\getToolbar(), getToolbar(), ilPCImageMapEditorGUI\saveArea(), ilPCImageMapEditorGUI\updateAreas(), and updateAreas().

◆ $lng

ilLanguage ilImageMapEditorGUI::$lng

protected

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

Referenced by ilPCIIMTriggerEditorGUI\addNewArea(), ilPCImageMapEditorGUI\deleteAreas(), ilPCIIMTriggerEditorGUI\getEditorTitle(), getEditorTitle(), ilPCIIMTriggerEditorGUI\getImageMapTableHTML(), ilPCIIMTriggerEditorGUI\getToolbar(), getToolbar(), ilPCImageMapEditorGUI\saveArea(), ilPCImageMapEditorGUI\updateAreas(), and updateAreas().

◆ $main_tpl

ilGlobalTemplateInterface ilImageMapEditorGUI::$main_tpl

protected

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

◆ $map

ImageMapManager ilImageMapEditorGUI::$map

protected

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

◆ $media_object

ilObjMediaObject ilImageMapEditorGUI::$media_object

protected

Definition at line 29 of file class.ilImageMapEditorGUI.php.

◆ $request

ImageMapGUIRequest ilImageMapEditorGUI::$request

protected

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

Referenced by ilPCImageMapEditorGUI\__construct(), and ilPCIIMTriggerEditorGUI\__construct().

◆ $toolbar

ilToolbarGUI ilImageMapEditorGUI::$toolbar

protected

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

Referenced by ilPCIIMTriggerEditorGUI\getImageMapTableHTML().

◆ $tpl

ilTemplate ilImageMapEditorGUI::$tpl

protected

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

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

Services/MediaObjects/ImageMap/class.ilImageMapEditorGUI.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _recoverParameters()

◆ addArea()

◆ addCircle()

◆ addNewArea()

◆ addPolygon()

◆ addRectangle()

◆ clearSessionVars()

◆ deleteAreas()

◆ editImagemapForward()

◆ editLink()

◆ editMapArea()

◆ editMapAreas()

◆ editShapeCircle()

◆ editShapePolygon()

◆ editShapeRectangle()

◆ editShapeWholePicture()

◆ executeCommand()

◆ getAdditionalPageXML()

◆ getAliasXML()

◆ getEditorTitle()

◆ getHrefOfArea()

◆ getImageMapOutput()

◆ getImageMapTableHTML()

◆ getLinkTypeOfArea()

◆ getMapAreaLinkString()

◆ getTargetFrameOfArea()

◆ getTargetOfArea()

◆ getToolbar()

◆ getTypeOfArea()

◆ handleMapParameters()

◆ initAreaEditingForm()

◆ linkWholePicture()

◆ makeMapWorkCopy()

◆ outputPostProcessing()

◆ saveArea()

◆ setHighlight()

◆ setInternalLink()

◆ setLink()

◆ setShape()

◆ showImageMap()

◆ updateAreas()

Field Documentation

◆ $ctrl

◆ $lng

◆ $main_tpl

◆ $map

◆ $media_object

◆ $request

◆ $toolbar

◆ $tpl