class.ilMapArea.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once("./Services/Link/classes/class.ilInternalLink.php");

define("IL_AREA_RECT", "Rect");
define("IL_AREA_CIRCLE", "Circle");
define("IL_AREA_POLY", "Poly");
define("IL_AREA_WHOLE_PICTURE", "WholePicture");

define("IL_INT_LINK", "int");
define("IL_EXT_LINK", "ext");
define("IL_NO_LINK", "no");

define("IL_LT_STRUCTURE", "StructureObject");
define("IL_LT_PAGE", "PageObject");
define("IL_LT_MEDIA", "MediaObject");
define("IL_LT_GLITEM", "GlossaryItem");

define("IL_TF_MEDIA", "Media");
define("IL_TF_FAQ", "FAQ");
define("IL_TF_GLOSSARY", "Glossary");
define("IL_TF_NEW", "New");


class ilMapArea
{
        const HL_NONE = "";
        const HL_HOVER = "Hover";
        const HL_ALWAYS = "Always";
        const HLCL_ACCENTED = "";
        const HLCL_LIGHT = "Light";
        const HLCL_DARK = "Dark";

        var $item_id;
        var $nr;
        var $shape;
        var $coords;
        var $title;
        var $linktype;
        var $xl_title;
        var $xl_href;
        var $il_target;
        var $il_type;
        var $il_target_frame;


        function ilMapArea($a_item_id = 0, $a_nr = 0)
        {
                $this->title = "";
                if ($a_item_id !=0 && $a_nr != 0)
                {
                        $this->setItemId($a_item_id);
                        $this->setNr($a_nr);
                        $this->read();
                }
        }

        function create()
        {
                global $ilDB;

                $q = "INSERT INTO map_area (item_id, nr, shape, ".
                        "coords, link_type, title, href, target, type, highlight_mode, highlight_class, target_frame) ".
                        " VALUES (".
                        $ilDB->quote($this->getItemId(), "integer").",".
                        $ilDB->quote($this->getNr(), "integer").",".
                        $ilDB->quote($this->getShape(), "text").",".
                        $ilDB->quote($this->getCoords(), "text").",".
                        $ilDB->quote($this->getLinkType(), "text").",".
                        $ilDB->quote($this->getTitle(), "text").",".
                        $ilDB->quote($this->getHref(), "text").",".
                        $ilDB->quote($this->getTarget(), "text").",".
                        $ilDB->quote($this->getType(), "text").",".
                        $ilDB->quote($this->getHighlightMode(), "text").",".
                        $ilDB->quote($this->getHighlightClass(), "text").",".
                        $ilDB->quote($this->getTargetFrame(), "text").")";
                $ilDB->manipulate($q);
        }

        function _getMaxNr($a_item_id)
        {
                global $ilDB;
                
                $q = "SELECT max(nr) AS max_nr FROM map_area WHERE item_id = ".
                        $ilDB->quote($a_item_id, "integer");
                $max_set = $ilDB->query($q);
                $max_rec = $ilDB->fetchAssoc($max_set);

                return $max_rec["max_nr"];
        }

        function read()
        {
                global $ilDB;
                
                $q = "SELECT * FROM map_area WHERE item_id = ".
                        $ilDB->quote($this->getItemId(), "integer").
                        " AND nr = ".$ilDB->quote($this->getNr(), "integer");
                $area_set = $ilDB->query($q);
                $area_rec = $ilDB->fetchAssoc($area_set);

                $this->setShape($area_rec["shape"]);
//echo $area_rec["Shape"];
                $this->setNr($area_rec["nr"]);
                $this->setCoords($area_rec["coords"]);
                $this->setLinkType($area_rec["link_type"]);
                $this->setTitle($area_rec["title"]);
                $this->setHref($area_rec["href"]);
                $this->setTarget($area_rec["target"]);
                $this->setType($area_rec["type"]);
                $this->setTargetFrame($area_rec["target_frame"]);
                $this->setHighlightMode($area_rec["highlight_mode"]);
                $this->setHighlightClass($area_rec["highlight_class"]);

        }

        function update()
        {
                global $ilDB;

                $q = "UPDATE map_area SET shape = ".$ilDB->quote($this->getShape(), "text").
                        ", coords = ".$ilDB->quote($this->getCoords(), "text").
                        ", link_type = ".$ilDB->quote($this->getLinkType(), "text").
                        ", title = ".$ilDB->quote($this->getTitle(), "text").
                        ", href = ".$ilDB->quote($this->getHref(), "text").
                        ", target = ".$ilDB->quote($this->getTarget(), "text").
                        ", type = ".$ilDB->quote($this->getType(), "text").
                        ", highlight_mode = ".$ilDB->quote($this->getHighlightMode(), "text").
                        ", highlight_class = ".$ilDB->quote($this->getHighlightClass(), "text").
                        ", target_frame = ".$ilDB->quote($this->getTargetFrame(), "text").
                        " WHERE item_id = ".$ilDB->quote($this->getItemId(), "integer").
                        " AND nr = ".$ilDB->quote($this->getNr(), "integer");
                $ilDB->manipulate($q);
        }

        function _resolveIntLinks($a_item_id)
        {
                global $ilDB;

//echo "maparea::resolve<br>";
                $q = "SELECT * FROM map_area WHERE item_id = ".
                        $ilDB->quote($a_item_id, "integer");
                $area_set = $ilDB->query($q);
                while ($area_rec = $ilDB->fetchAssoc($area_set))
                {
                        $target = $area_rec["target"];
                        $type = $area_rec["type"];
                        $item_id = $area_rec["item_id"];
                        $nr = $area_rec["nr"];

                        if (($area_rec["link_type"] == IL_INT_LINK) && (!is_int(strpos($target, "__"))))
                        {
                                $new_target = ilInternalLink::_getIdForImportId($type, $target);
                                if ($new_target !== false)
                                {
                                        $query = "UPDATE map_area SET ".
                                                "target = ".$ilDB->quote($new_target, "text")." ".
                                                "WHERE item_id = ".$ilDB->quote($item_id, "integer").
                                                " AND nr = ".$ilDB->quote($nr, "integer");
                                        $ilDB->manipulate($query);
                                }
                        }
                }
        }

        function _getIntLinks($a_item_id)
        {
                global $ilDB;
                
                $q = "SELECT * FROM map_area WHERE item_id = ".
                        $ilDB->quote($a_item_id, "integer");
                $area_set = $ilDB->query($q);

                $links = array();

                while ($area_rec = $ilDB->fetchAssoc($area_set))
                {
                        $target = $area_rec["target"];
                        $type = $area_rec["type"];
                        $targetframe = $area_rec["target_frame"];

                        if (($area_rec["link_type"] == IL_INT_LINK) && (is_int(strpos($target, "__"))))
                        {
                                $links[$target.":".$type.":".$targetframe] =
                                        array("Target" => $target, "Type" => $type,
                                                "TargetFrame" => $targetframe);
                        }
                }
                return $links;
        }

        static function _getMobsForTarget($a_type, $a_target)
        {
                global $ilDB;

                $q = "SELECT * FROM map_area WHERE ".
                        " link_type = ".$ilDB->quote($a_type, "text").
                        " AND target = ".$ilDB->quote($a_target, "text");
                $set = $ilDB->query($q);
                
                $mobs = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $mob_id = ilMediaItem::_lookupMobId($rec["item_id"]);
                        $mobs[$mob_id] = $mob_id;
                }
                
                return $mobs;
        }

        function getAllHighlightModes()
        {
                global $lng;
                
                return array(
                        self::HL_NONE => $lng->txt("cont_none"),
                        self::HL_HOVER => $lng->txt("cont_hover"),
                        self::HL_ALWAYS => $lng->txt("cont_always")
                        );

        }
        
        
        function setHighlightMode($a_val)
        {
                $this->highlight_mode = $a_val;
        }
        
        function getHighlightMode()
        {
                return $this->highlight_mode;
        }

        function getAllHighlightClasses()
        {
                global $lng;
                
                return array(
                        self::HLCL_ACCENTED => $lng->txt("cont_accented"),
                        self::HLCL_LIGHT => $lng->txt("cont_light"),
                        self::HLCL_DARK => $lng->txt("cont_dark"),
                );
        }
        
        function setHighlightClass($a_val)
        {
                $this->highlight_class = $a_val;
        }
        
        function getHighlightClass()
        {
                return $this->highlight_class;
        }

        function setItemId($a_item_id)
        {
                $this->item_id = $a_item_id;
        }

        function getItemId()
        {
                return $this->item_id;
        }

        function setNr($a_nr)
        {
                $this->nr = $a_nr;
        }

        function getNr()
        {
                return $this->nr;
        }

        function setShape($a_shape)
        {
                $this->shape = $a_shape;
        }

        function getShape()
        {
                return $this->shape;
        }

        function setCoords($a_coords)
        {
                $this->coords = $a_coords;
        }

        function getCoords()
        {
                return $this->coords;
        }

        function setTitle($a_title)
        {
                $this->title = $a_title;
        }

        function appendTitle($a_title_str)
        {
                $this->title.= $a_title_str;
        }

        function getTitle()
        {
                return $this->title;
        }

        function setLinkType($a_link_type)
        {
                $this->linktype = $a_link_type;
        }

        function getLinkType()
        {
                return $this->linktype;
        }

        function setHref($a_href)
        {
                $this->xl_href = $a_href;
        }

        function getHref()
        {
                return $this->xl_href;
        }

        function setExtTitle($a_title)
        {
                $this->xl_title = $a_title;
        }

        function getExtTitle()
        {
                return $this->xl_title;
        }

        function setTarget($a_target)
        {
                $this->il_target = $a_target;
        }

        function getTarget($a_insert_inst = false)
        {
                $target = $this->il_target;

                if ((substr($target, 0, 4) == "il__") && $a_insert_inst)
                {
                        $target = "il_".IL_INST_ID."_".substr($target, 4, strlen($target) - 4);
                }

                return $target;
        }

        function setType($a_type)
        {
                $this->il_type = $a_type;
        }

        function getType()
        {
                return $this->il_type;
        }

        function setTargetFrame($a_target_frame)
        {
                $this->il_target_frame = $a_target_frame;
        }

        function getTargetFrame()
        {
                return $this->il_target_frame;
        }

        function draw(&$a_image, $a_col1, $a_col2, $a_close_poly = true,
                $a_x_ratio = 1, $a_y_ratio = 1)
        {
                switch ($this->getShape())
                {
                        case "Rect" :
                                $this->drawRect($a_image, $this->getCoords(), $a_col1, $a_col2,
                                        $a_x_ratio, $a_y_ratio);
                                break;

                        case "Circle" :
                                $this->drawCircle($a_image, $this->getCoords(), $a_col1, $a_col2,
                                        $a_x_ratio, $a_y_ratio);
                                break;

                        case "Poly" :
                                $this->drawPoly($a_image, $this->getCoords(), $a_col1, $a_col2, $a_close_poly,
                                        $a_x_ratio, $a_y_ratio);
                                break;
                }
        }

        function drawLine(&$im, $x1, $y1, $x2, $y2, $c1, $c2)
        {
                imageline($im, $x1+1, $y1, $x2+1, $y2, $c1);
                imageline($im, $x1-1, $y1, $x2-1, $y2, $c1);
                imageline($im, $x1, $y1+1, $x2, $y2+1, $c1);
                imageline($im, $x1, $y1-1, $x2, $y2-1, $c1);
                imageline($im, $x1, $y1, $x2, $y2, $c2);
        }

        function drawRect(&$im,$coords,$c1,$c2,$a_x_ratio = 1, $a_y_ratio = 1)
        {
                $coord=explode(",", $coords);

                $this->drawLine($im, $coord[0] / $a_x_ratio, $coord[1] / $a_y_ratio,
                        $coord[0] / $a_x_ratio, $coord[3] / $a_y_ratio, $c1, $c2);
                $this->drawLine($im, $coord[0] / $a_x_ratio, $coord[3] / $a_y_ratio,
                        $coord[2] / $a_x_ratio, $coord[3] / $a_y_ratio, $c1, $c2);
                $this->drawLine($im, $coord[2] / $a_x_ratio, $coord[3] / $a_y_ratio,
                        $coord[2] / $a_x_ratio, $coord[1] / $a_y_ratio, $c1, $c2);
                $this->drawLine($im, $coord[2] / $a_x_ratio, $coord[1] / $a_y_ratio,
                        $coord[0] / $a_x_ratio, $coord[1] / $a_y_ratio, $c1, $c2);
        }


        function drawPoly(&$im, $coords, $c1, $c2, $closed,$a_x_ratio = 1, $a_y_ratio = 1)
        {
                if ($closed)
                {
                        $p = 0;
                }
                else
                {
                        $p = 1;
                }

                $anz = ilMapArea::countCoords($coords);

                if ($anz < (3 - $p))
                {
                        return;
                }

                $c = explode(",", $coords);

                for($i=0; $i<$anz-$p; $i++)
                {
                        $this->drawLine($im, $c[$i*2] / $a_x_ratio, $c[$i*2+1] / $a_y_ratio,
                                $c[($i*2+2)%(2*$anz)] / $a_x_ratio,
                                $c[($i*2+3)%(2*$anz)] / $a_y_ratio, $c1, $c2);
                }
        }


        function drawCircle(&$im, $coords, $c1, $c2,$a_x_ratio = 1, $a_y_ratio = 1)
        {
                $c = explode(",", $coords);
                imagearc($im, $c[0] / $a_x_ratio, $c[1] / $a_y_ratio,
                        ($c[2]+1)*2 / $a_x_ratio, ($c[2]+1)*2 / $a_y_ratio, 1, 360, $c1);
                imagearc($im, $c[0] / $a_x_ratio, $c[1] / $a_y_ratio,
                        ($c[2]-1)*2 / $a_x_ratio, ($c[2]-1)*2 / $a_y_ratio, 1, 360, $c1);
                imagearc($im, $c[0] / $a_x_ratio, $c[1] / $a_y_ratio,
                        $c[2]*2 / $a_x_ratio, $c[2]*2 / $a_y_ratio, 1, 360, $c2);
        }

        function countCoords($c)
        {
                if ($c == "")
                {
                        return 0;
                }
                else
                {
                        $coord_array = explode(",", $c);
                        return (count($coord_array) / 2);
                }
        }

}
?>