User interface class for page content map editor. More...

Inheritance diagram for ilPCImageMapEditorGUI:

Collaboration diagram for ilPCImageMapEditorGUI:

Public Member Functions
	__construct ( $a_content_obj, ilPageObject $a_page, EditGUIRequest $request)

	getParentNodeName ()

	getImageMapTableHTML ()

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

	deleteAreas ()
	Delete map areas. More...

	getLinkTypeOfArea (int $a_nr)
	Get Link Type of Area. More...

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

	updateAreas ()
	Update map areas. More...

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

	getAliasXML ()

Public Member Functions inherited from ilImageMapEditorGUI
	__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...

Protected Attributes
MapEditorSessionRepository	$map_repo

ilMediaAliasItem	$std_alias_item

ilPageObject	$page

	$content_obj

EditGUIRequest	$edit_request

Protected Attributes inherited from ilImageMapEditorGUI
ILIAS COPage Xsl XslManager	$xsl

ilObjMediaObject	$media_object

ImageMapGUIRequest	$request

ImageMapManager	$map

ilTemplate	$tpl

ilGlobalTemplateInterface	$main_tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilToolbarGUI	$toolbar

Additional Inherited Members
Static Public Member Functions inherited from ilImageMapEditorGUI
static	_recoverParameters ()
	Recover parameters from session variables (static) More...

Detailed Description

User interface class for page content map editor.

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

Definition at line 28 of file class.ilPCImageMapEditorGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPCImageMapEditorGUI::__construct	(		$a_content_obj,
		ilPageObject	$a_page,
		EditGUIRequest	$request
	)

Parameters

ilPCMediaObject | ilPCInteractiveImage $a_content_obj

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

      {
        global $DIC;
 
        $this->content_obj = $a_content_obj;
        $this->page = $a_page;
        $this->edit_request = $request;
        parent::__construct($a_content_obj->getMediaObject());
 
        $this->std_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->content_obj->hier_id,
            "Standard",
            $this->content_obj->getPCId(),
            $this->getParentNodeName()
        );
        $this->map_repo = $DIC
            ->copage()
            ->internal()
            ->repo()
            ->pc()
            ->mediaMap();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ deleteAreas()

ilPCImageMapEditorGUI::deleteAreas ( )

Delete map areas.

Reimplemented from ilImageMapEditorGUI.

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

                                 : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $areas = $this->edit_request->getStringArray("area");
        if (count($areas) == 0) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "editMapAreas");
        }
 
        //              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
        //                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
 
        $i = 0;
        arsort($areas);
        foreach ($areas as $area_nr) {
            $this->std_alias_item->deleteMapArea($area_nr);
        }
        $this->page->update();
        $this->main_tpl->setOnScreenMessage('success', $lng->txt("cont_areas_deleted"), true);
 
        $ilCtrl->redirect($this, "editMapAreas");
    }

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

Here is the call graph for this function:

◆ getAliasXML()

ilPCImageMapEditorGUI::getAliasXML ( )

Reimplemented from ilImageMapEditorGUI.

Definition at line 332 of file class.ilPCImageMapEditorGUI.php.

                                 : string
    {
        return $this->content_obj->dumpXML();
    }

◆ getHrefOfArea()

ilPCImageMapEditorGUI::getHrefOfArea ( int $a_nr )

Get Href of Area (only external link)

Reimplemented from ilImageMapEditorGUI.

Definition at line 242 of file class.ilPCImageMapEditorGUI.php.

                                            : string
    {
        return $this->std_alias_item->getHrefOfArea($a_nr);
    }

◆ getImageMapTableHTML()

ilPCImageMapEditorGUI::getImageMapTableHTML ( )

Reimplemented from ilImageMapEditorGUI.

Definition at line 74 of file class.ilPCImageMapEditorGUI.php.

                                          : string
    {
        $image_map_table = new ilPCImageMapTableGUI(
            $this,
            "editMapAreas",
            $this->content_obj,
            $this->getParentNodeName()
        );
        return $image_map_table->getHTML();
    }

References getParentNodeName().

Here is the call graph for this function:

◆ getLinkTypeOfArea()

ilPCImageMapEditorGUI::getLinkTypeOfArea ( int $a_nr )

Get Link Type of Area.

Reimplemented from ilImageMapEditorGUI.

Definition at line 210 of file class.ilPCImageMapEditorGUI.php.

                                                : string
    {
        return $this->std_alias_item->getLinkTypeOfArea($a_nr);
    }

◆ getParentNodeName()

ilPCImageMapEditorGUI::getParentNodeName ( )

Definition at line 69 of file class.ilPCImageMapEditorGUI.php.

                                       : string
    {
        return "MediaObject";
    }

Referenced by getImageMapTableHTML().

Here is the caller graph for this function:

◆ getTargetFrameOfArea()

ilPCImageMapEditorGUI::getTargetFrameOfArea ( int $a_nr )

Get TargetFrame of Area (only internal link)

Reimplemented from ilImageMapEditorGUI.

Definition at line 234 of file class.ilPCImageMapEditorGUI.php.

                                                   : string
    {
        return $this->std_alias_item->getTargetFrameOfArea($a_nr);
    }

◆ getTargetOfArea()

ilPCImageMapEditorGUI::getTargetOfArea ( int $a_nr )

Get Target of Area (only internal link)

Reimplemented from ilImageMapEditorGUI.

Definition at line 226 of file class.ilPCImageMapEditorGUI.php.

                                              : string
    {
        return $this->std_alias_item->getTargetOfArea($a_nr);
    }

◆ getTypeOfArea()

ilPCImageMapEditorGUI::getTypeOfArea ( int $a_nr )

Get Type of Area (only internal link)

Reimplemented from ilImageMapEditorGUI.

Definition at line 218 of file class.ilPCImageMapEditorGUI.php.

                                            : string
    {
        return $this->std_alias_item->getTypeOfArea($a_nr);
    }

◆ makeMapWorkCopy()

ilPCImageMapEditorGUI::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 from ilImageMapEditorGUI.

Definition at line 288 of file class.ilPCImageMapEditorGUI.php.

     : ilMediaItem {
        // old for pc media object
        //              $media_object = $this->media_object->getMediaItem("Standard");
        $media_object = $this->content_obj->getMediaObject();
 
        // create/update imagemap work copy
        $st_item = $media_object->getMediaItem("Standard");
        $st_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->content_obj->hier_id,
            "Standard",
            $this->content_obj->getPCId(),
            $this->getParentNodeName()
        );
 
        if ($a_edit_property == "shape") {
            $st_alias_item->makeMapWorkCopy(
                $st_item,
                $a_area_nr,
                true,
                $a_output_new_area,
                $a_area_type,
                $a_coords
            );  // exclude area currently being edited
        } else {
            $st_alias_item->makeMapWorkCopy(
                $st_item,
                $a_area_nr,
                false,
                $a_output_new_area,
                $a_area_type,
                $a_coords
            );
        }
 
        return $st_item;
    }

◆ saveArea()

ilPCImageMapEditorGUI::saveArea ( )

Save new or updated map area.

Reimplemented from ilImageMapEditorGUI.

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

                              : string
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        switch ($this->map->getMode()) {
            // save edited link
            case "edit_link":
                //                              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
                //                                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
 
                $area_link_type = $this->edit_request->getString("area_link_type");
                if ($area_link_type == IL_INT_LINK) {
                    $int_link = $this->map->getInternalLink();
                    $this->std_alias_item->setAreaIntLink(
                        $this->map->getAreaNr(),
                        $int_link["type"],
                        $int_link["target"],
                        $int_link["target_frame"]
                    );
                } elseif ($area_link_type == IL_NO_LINK) {
                    $this->std_alias_item->setAreaExtLink(
                        $this->map->getAreaNr(),
                        ""
                    );
                } else {
                    $this->std_alias_item->setAreaExtLink(
                        $this->map->getAreaNr(),
                        $this->edit_request->getString("area_link_ext")
                    );
                }
                $this->page->update();
                break;
 
                // save edited shape
            case "edit_shape":
                $this->std_alias_item->setShape(
                    $this->map->getAreaNr(),
                    $this->map->getAreaType(),
                    $this->map->getCoords()
                );
                $this->page->update();
                break;
 
                // save new area
            default:
                $area_type = $this->map->getAreaType();
                $coords = $this->map->getCoords();
                $link = [];
                $area_link_type = $this->edit_request->getString("area_link_type");
                switch ($area_link_type) {
                    case IL_EXT_LINK:
                        $link = array(
                            "LinkType" => IL_EXT_LINK,
                            "Href" => $this->edit_request->getString("area_link_ext"));
                        break;
 
                    case IL_NO_LINK:
                        $link = array(
                            "LinkType" => IL_EXT_LINK,
                            "Href" => "");
                        break;
 
                    case IL_INT_LINK:
                        $int_link = $this->map->getInternalLink();
                        $link = array(
                            "LinkType" => IL_INT_LINK,
                            "Type" => $int_link["type"],
                            "Target" => $int_link["target"],
                            "TargetFrame" => $int_link["target_frame"]);
                        break;
                }
 
                //                              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
                //                                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
                $this->std_alias_item->addMapArea(
                    $area_type,
                    $coords,
                    $this->edit_request->getString("area_name"),
                    $link
                );
                $this->page->update();
                break;
        }
 
        //$this->initMapParameters();
        $this->main_tpl->setOnScreenMessage('success', $lng->txt("cont_saved_map_area"), true);
        $ilCtrl->redirect($this, "editMapAreas");
        return "";
    }

References ilImageMapEditorGUI\$ctrl, ilImageMapEditorGUI\$lng, IL_EXT_LINK, IL_INT_LINK, IL_NO_LINK, and ilLanguage\txt().

Here is the call graph for this function:

◆ updateAreas()

ilPCImageMapEditorGUI::updateAreas ( )

Update map areas.

Reimplemented from ilImageMapEditorGUI.

Definition at line 250 of file class.ilPCImageMapEditorGUI.php.

                                 : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        //              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
        //                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
        $areas = $this->std_alias_item->getMapAreas();
        foreach ($areas as $area) {
            // fix #26032 empty values lead to "empty text node" errors on page update
            $name = $this->edit_request->getString("name_" . $area["Nr"]);
            $hl_mode = $this->edit_request->getString("hl_mode_" . $area["Nr"]);
            $hl_class = $this->edit_request->getString("hl_class_" . $area["Nr"]);
            if ($name == "") {
                $name = " ";
            }
            $this->std_alias_item->setAreaTitle(
                $area["Nr"],
                $name
            );
            $this->std_alias_item->setAreaHighlightMode(
                $area["Nr"],
                $hl_mode
            );
            $this->std_alias_item->setAreaHighlightClass(
                $area["Nr"],
                $hl_class
            );
        }
        $this->page->update();
 
        $this->main_tpl->setOnScreenMessage('success', $lng->txt("cont_saved_map_data"), true);
        $ilCtrl->redirect($this, "editMapAreas");
    }

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

Here is the call graph for this function:

Field Documentation

◆ $content_obj

ilPCImageMapEditorGUI::$content_obj

protected

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

◆ $edit_request

EditGUIRequest ilPCImageMapEditorGUI::$edit_request

protected

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

◆ $map_repo

MapEditorSessionRepository ilPCImageMapEditorGUI::$map_repo

protected

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

◆ $page

ilPageObject ilPCImageMapEditorGUI::$page

protected

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

◆ $std_alias_item

ilMediaAliasItem ilPCImageMapEditorGUI::$std_alias_item

protected

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

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

components/ILIAS/COPage/PC/MediaObject/class.ilPCImageMapEditorGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteAreas()

◆ getAliasXML()

◆ getHrefOfArea()

◆ getImageMapTableHTML()

◆ getLinkTypeOfArea()

◆ getParentNodeName()

◆ getTargetFrameOfArea()

◆ getTargetOfArea()

◆ getTypeOfArea()

◆ makeMapWorkCopy()

◆ saveArea()

◆ updateAreas()

Field Documentation

◆ $content_obj

◆ $edit_request

◆ $map_repo

◆ $page

◆ $std_alias_item