ilPCImageMapEditorGUI Class Reference

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

Inheritance diagram for ilPCImageMapEditorGUI:

Collaboration diagram for ilPCImageMapEditorGUI:

Public Member Functions
	__construct ($a_content_obj, $a_page)
	Constructor. More...
	getParentNodeName ()
	Get parent node name. More...
	getImageMapTableHTML ()
	Get table HTML. More...
	saveArea ()
	Save new or updated map area. More...
	deleteAreas ()
	Delete map areas. More...
	getLinkTypeOfArea ($a_nr)
	Get Link Type of Area. More...
	getTypeOfArea ($a_nr)
	Get Type of Area (only internal link) More...
	getTargetOfArea ($a_nr)
	Get Target of Area (only internal link) More...
	getTargetFrameOfArea ($a_nr)
	Get TargetFrame of Area (only internal link) More...
	getHrefOfArea ($a_nr)
	Get Href of Area (only external link) More...
	updateAreas ()
	Update map areas. More...
	makeMapWorkCopy ( $a_edit_property="", $a_area_nr=0, $a_output_new_area=false, $a_area_type="", $a_coords="")
	Make work file for editing. More...
	getAliasXML ()
Public Member Functions inherited from ilImageMapEditorGUI
	__construct ($a_media_object)
	Constructor. More...
	executeCommand ()
	Execute current command. More...
	editMapAreas ()
	Show map areas. More...
	getToolbar ()
	Get toolbar. More...
	getEditorTitle ()
	Get editor title. More...
	getImageMapTableHTML ()
	Get table HTML. More...
	handleMapParameters ()
	handle parameter during map area editing (storing to session) More...
	showImageMap ()
	show image map More...
	updateAreas ()
	Update map areas. More...
	addNewArea ()
	Add area. More...
	linkWholePicture ()
	Link the whole picture. More...
	addRectangle ()
	Add a new rectangle. More...
	addCircle ()
	Add a new circle. More...
	addPolygon ()
	Add a new polygon. More...
	clearSessionVars ()
	Clear Session Vars. More...
	addArea ($a_handle=true)
	Handle adding new area process. More...
	editMapArea ( $a_get_next_coordinate=false, $a_output_new_area=false, $a_save_form=false, $a_edit_property="", $a_area_nr=0)
	Edit a single map area. More...
	initAreaEditingForm ($a_edit_property)
	Init area editing form. More...
	makeMapWorkCopy ( $a_edit_property="", $a_area_nr=0, $a_output_new_area=false, $a_area_type="", $a_coords="")
	Make work file for editing. More...
	getImageMapOutput ($a_map_edit_mode="")
	Render the image map. More...
	getAdditionalPageXML ()
	Get additional page xml (to be overwritten) More...
	outputPostProcessing ($a_output)
	Output post processing. More...
	getAliasXML ()
	getMapAreaLinkString ($a_target, $a_type, $a_frame)
	Get text name of internal link. More...
	editImagemapForward ()
	Get image map coordinates. More...
	saveArea ()
	Save new or updated map area. More...
	setInternalLink ()
	Set internal link. More...
	setLink ($a_handle=true)
	Set link. More...
	getLinkTypeOfArea ($a_nr)
	Get Link Type of Area. More...
	getTypeOfArea ($a_nr)
	Get Type of Area (only internal link) More...
	getTargetOfArea ($a_nr)
	Get Target of Area (only internal link) More...
	getTargetFrameOfArea ($a_nr)
	Get TargetFrame of Area (only internal link) More...
	getHrefOfArea ($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 ($a_handle=true)
	edit shape of existing map area More...
	setHighlight ()
	Set highlight settings. More...

Protected Attributes
	$lng
	$ctrl
Protected Attributes inherited from ilImageMapEditorGUI
	$ctrl
	$tpl
	$lng
	$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

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilPCImageMapEditorGUI: ilInternalLinkGUI

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

Constructor & Destructor Documentation

__construct()

ilPCImageMapEditorGUI::__construct	(		$a_content_obj,
			$a_page
	)

Constructor.

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

References $DIC, and getParentNodeName().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->content_obj = $a_content_obj;
        $this->page = $a_page;
        parent::__construct($a_content_obj->getMediaObject());
                
        $this->std_alias_item = new ilMediaAliasItem(
            $this->content_obj->dom,
            $this->content_obj->hier_id,
            "Standard",
            $this->content_obj->getPcId(),
            $this->getParentNodeName()
        );
    }

Here is the call graph for this function:

Member Function Documentation

deleteAreas()

ilPCImageMapEditorGUI::deleteAreas

(

)

Delete map areas.

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

References $_POST, $ctrl, $i, $ilCtrl, $lng, ilUtil\sendFailure(), and ilUtil\sendSuccess().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        if (!isset($_POST["area"])) {
            ilUtil::sendFailure($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());

        if (count($_POST["area"]) > 0) {
            $i = 0;
            arsort($_POST["area"]);
            foreach ($_POST["area"] as $area_nr) {
                $this->std_alias_item->deleteMapArea($area_nr);
            }
            $this->updated = $this->page->update();
            ilUtil::sendSuccess($lng->txt("cont_areas_deleted"), true);
        }

        $ilCtrl->redirect($this, "editMapAreas");
    }

Here is the call graph for this function:

getAliasXML()

ilPCImageMapEditorGUI::getAliasXML

(

)

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

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

getHrefOfArea()

ilPCImageMapEditorGUI::getHrefOfArea

(

$a_nr

)

Get Href of Area (only external link)

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

    {
        //              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
        //                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
        return $this->std_alias_item->getHrefOfArea($a_nr);
    }

getImageMapTableHTML()

ilPCImageMapEditorGUI::getImageMapTableHTML

(

)

Get table HTML.

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

References getParentNodeName().

    {
        include_once("./Services/COPage/classes/class.ilPCImageMapTableGUI.php");
        $image_map_table = new ilPCImageMapTableGUI(
            $this,
            "editMapAreas",
            $this->content_obj,
            $this->getParentNodeName()
        );
        return $image_map_table->getHTML();
    }

Here is the call graph for this function:

getLinkTypeOfArea()

ilPCImageMapEditorGUI::getLinkTypeOfArea

(

$a_nr

)

Get Link Type of Area.

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

    {
        //              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
        //                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
        return $this->std_alias_item->getLinkTypeOfArea($a_nr);
    }

getParentNodeName()

ilPCImageMapEditorGUI::getParentNodeName

(

)

Get parent node name.

Returns

string name of parent node

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

Referenced by __construct(), getImageMapTableHTML(), and makeMapWorkCopy().

    {
        return "MediaObject";
    }

Here is the caller graph for this function:

getTargetFrameOfArea()

ilPCImageMapEditorGUI::getTargetFrameOfArea

(

$a_nr

)

Get TargetFrame of Area (only internal link)

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

    {
        //              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
        //                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
        return $this->std_alias_item->getTargetFrameOfArea($a_nr);
    }

getTargetOfArea()

ilPCImageMapEditorGUI::getTargetOfArea

(

$a_nr

)

Get Target of Area (only internal link)

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

    {
        //              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
        //                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
        return $this->std_alias_item->getTargetOfArea($a_nr);
    }

getTypeOfArea()

ilPCImageMapEditorGUI::getTypeOfArea

(

$a_nr

)

Get Type of Area (only internal link)

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

    {
        //              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
        //                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
        return $this->std_alias_item->getTypeOfArea($a_nr);
    }

makeMapWorkCopy()

ilPCImageMapEditorGUI::makeMapWorkCopy	(		$a_edit_property = "",
			$a_area_nr = 0,
			$a_output_new_area = false,
			$a_area_type = "",
			$a_coords = ""
	)

Make work file for editing.

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

References getParentNodeName(), and ilMediaAliasItem\makeMapWorkCopy().

      {
        // 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->dom,
            $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
            );
        }
    }

Here is the call graph for this function:

saveArea()

ilPCImageMapEditorGUI::saveArea

(

)

Save new or updated map area.

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

References $_POST, $_SESSION, $coords, $ctrl, $ilCtrl, $lng, array, IL_EXT_LINK, IL_INT_LINK, IL_NO_LINK, ilUtil\sendSuccess(), and ilUtil\stripSlashes().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        switch ($_SESSION["il_map_edit_mode"]) {
            // 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());

                if ($_POST["area_link_type"] == IL_INT_LINK) {
                    $this->std_alias_item->setAreaIntLink(
                        $_SESSION["il_map_area_nr"],
                        $_SESSION["il_map_il_type"],
                        $_SESSION["il_map_il_target"],
                        $_SESSION["il_map_il_targetframe"]
                    );
                } elseif ($_POST["area_link_type"] == IL_NO_LINK) {
                    $this->std_alias_item->setAreaExtLink(
                        $_SESSION["il_map_area_nr"],
                        ""
                    );
                } else {
                    $this->std_alias_item->setAreaExtLink(
                        $_SESSION["il_map_area_nr"],
                        ilUtil::stripSlashes($_POST["area_link_ext"])
                    );
                }
                $this->updated = $this->page->update();
                break;

            // save edited shape
            case "edit_shape":
//                              $std_alias_item = new ilMediaAliasItem($this->content_obj->dom,
//                                      $this->content_obj->hier_id, "Standard", $this->content_obj->getPcId());
                $this->std_alias_item->setShape(
                    $_SESSION["il_map_area_nr"],
                    $_SESSION["il_map_edit_area_type"],
                    $_SESSION["il_map_edit_coords"]
                );
                $this->updated = $this->page->update();
                break;

            // save new area
            default:
                $area_type = $_SESSION["il_map_edit_area_type"];
                $coords = $_SESSION["il_map_edit_coords"];

                switch ($_POST["area_link_type"]) {
                    case IL_EXT_LINK:
                        $link = array(
                            "LinkType" => IL_EXT_LINK,
                            "Href" => ilUtil::stripSlashes($_POST["area_link_ext"]));
                        break;

                    case IL_NO_LINK:
                        $link = array(
                            "LinkType" => IL_EXT_LINK,
                            "Href" => "");
                        break;

                    case IL_INT_LINK:
                        $link = array(
                            "LinkType" => IL_INT_LINK,
                            "Type" => $_SESSION["il_map_il_type"],
                            "Target" => $_SESSION["il_map_il_target"],
                            "TargetFrame" => $_SESSION["il_map_il_targetframe"]);
                        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,
                    ilUtil::stripSlashes($_POST["area_name"]),
                    $link
                );
                $this->updated = $this->page->update();

                break;
        }

        //$this->initMapParameters();
        ilUtil::sendSuccess($lng->txt("cont_saved_map_area"), true);
        $ilCtrl->redirect($this, "editMapAreas");
    }

Here is the call graph for this function:

updateAreas()

ilPCImageMapEditorGUI::updateAreas

(

)

Update map areas.

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

References $_POST, $ctrl, $ilCtrl, $lng, $name, ilUtil\sendSuccess(), and ilUtil\stripSlashes().

    {
        $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 = ilUtil::stripSlashes($_POST["name_" . $area["Nr"]]);
            if ($name == "") {
                $name = " ";
            }
            $this->std_alias_item->setAreaTitle(
                $area["Nr"],
                $name
            );
            $this->std_alias_item->setAreaHighlightMode(
                $area["Nr"],
                ilUtil::stripSlashes($_POST["hl_mode_" . $area["Nr"]])
            );
            $this->std_alias_item->setAreaHighlightClass(
                $area["Nr"],
                ilUtil::stripSlashes($_POST["hl_class_" . $area["Nr"]])
            );
        }
        $this->page->update();
        
        ilUtil::sendSuccess($lng->txt("cont_saved_map_data"), true);
        $ilCtrl->redirect($this, "editMapAreas");
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilPCImageMapEditorGUI::$ctrl

protected

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

Referenced by deleteAreas(), saveArea(), and updateAreas().

$lng

ilPCImageMapEditorGUI::$lng

protected

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

Referenced by deleteAreas(), saveArea(), and updateAreas().

---

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

• Services/COPage/classes/class.ilPCImageMapEditorGUI.php