Collaboration diagram for ilMapArea:

Public Member Functions
	__construct (int $a_item_id=0, int $a_nr=0)

	create ()
	create persistent map area object in db More...

	read ()

	update ()

	setHighlightMode (string $a_val)

	getHighlightMode ()

	setHighlightClass (string $a_val)

	getHighlightClass ()

	setItemId (int $a_item_id)

	getItemId ()

	setNr (int $a_nr)

	getNr ()

	setShape (string $a_shape)
	set shape (IL_AREA_RECT, IL_AREA_CIRCLE, IL_AREA_POLY, IL_AREA_WHOLE_PICTURE) More...

	getShape ()

	setCoords (string $a_coords)
	set coords of area More...

	getCoords ()

	setTitle (string $a_title)
	set (tooltip)title of area More...

	appendTitle (string $a_title_str)

	getTitle ()

	setLinkType (string $a_link_type)
	set link type More...

	getLinkType ()

	setHref (string $a_href)
	set hyper reference (external link only) More...

	getHref ()

	setExtTitle (string $a_title)
	set link text (external link only) More...

	getExtTitle ()

	setTarget (string $a_target)
	set link target (internal link only) More...

	getTarget (bool $a_insert_inst=false)
	get link target (internal link only) More...

	setType (string $a_type)
	set link type (internal link only) More...

	getType ()

	setTargetFrame (string $a_target_frame)
	set link target frame (internal link only) More...

	getTargetFrame ()

	draw ( $a_image, int $a_col1, int $a_col2, bool $a_close_poly=true, float $a_x_ratio=1, float $a_y_ratio=1)

	drawLine ( $im, int $x1, int $y1, int $x2, int $y2, int $c1, int $c2)
	draws an outlined two color line in an image More...

	drawRect ( $im, string $coords, int $c1, int $c2, float $a_x_ratio=1, float $a_y_ratio=1)
	draws an outlined two color rectangle More...

	drawPoly ( $im, string $coords, int $c1, int $c2, bool $closed, float $a_x_ratio=1, float $a_y_ratio=1)
	draws an outlined two color polygon More...

	drawCircle ( $im, string $coords, int $c1, int $c2, float $a_x_ratio=1, float $a_y_ratio=1)
	draws an outlined two colored circle More...

Static Public Member Functions
static	_getMaxNr (int $a_item_id)
	get maximum nr of media item (static) More...

static	_resolveIntLinks (int $a_item_id)
	resolve internal links of an item id More...

static	_getIntLinks (int $a_item_id)
	get all internal links of a media items map areas More...

static	_getMobsForTarget (string $a_type, string $a_target)
	Get areas for a certain target. More...

static	getAllHighlightModes ()

static	getAllHighlightClasses ()

static	countCoords (string $c)
	count the number of coordinates (x,y) in a coordinate string (format: "x1,y1,x2,y2,x3,y3,...") More...

Data Fields
const	HL_NONE = ""

const	HL_HOVER = "Hover"

const	HL_ALWAYS = "Always"

const	HLCL_ACCENTED = ""

const	HLCL_LIGHT = "Light"

const	HLCL_DARK = "Dark"

int	$item_id = 0

int	$nr = 0

string	$shape = ""

string	$coords = ""

string	$title = ""

string	$linktype = ""

string	$xl_title = ""

string	$xl_href = ""

string	$il_target = ""

string	$il_type = ""

string	$il_target_frame = ""

Protected Attributes
string	$highlight_mode = ""

string	$highlight_class = ""

ilDBInterface	$db

Detailed Description

Class ilMapArea.

Map Area of an Image Map, subobject of Media Item

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

Definition at line 46 of file class.ilMapArea.php.

Constructor & Destructor Documentation

◆ __construct()

ilMapArea::__construct	(	int	$a_item_id = `0`,
		int	$a_nr = `0`
	)

Parameters

int	$a_item_id	parent media item id
int	$a_nr	map area number within media item

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

References $DIC, read(), setItemId(), and setNr().

       {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->title = "";
         if ($a_item_id != 0 && $a_nr != 0) {
             $this->setItemId($a_item_id);
             $this->setNr($a_nr);
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getIntLinks()

static ilMapArea::_getIntLinks ( int $a_item_id )

static

get all internal links of a media items map areas

Parameters

int $a_item_id media item id

Definition at line 212 of file class.ilMapArea.php.

References $DIC, $ilDB, $type, and IL_INT_LINK.

Referenced by ilMediaItem\_getMapAreasIntLinks(), and ilObjMediaObject\getLinkedMediaObjects().

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $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;
     }

Here is the caller graph for this function:

◆ _getMaxNr()

static ilMapArea::_getMaxNr ( int $a_item_id )

static

get maximum nr of media item (static)

Definition at line 117 of file class.ilMapArea.php.

References $DIC, and $ilDB.

Referenced by ilMediaItem\_getMediaItemsOfMOb(), ilImageMapEditorGUI\deleteAreas(), ilImageMapTableGUI\getItems(), ilMediaItem\read(), ilImageMapEditorGUI\saveArea(), and ilImageMapEditorGUI\updateAreas().

      : int {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $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 (int) $max_rec["max_nr"];
     }

Here is the caller graph for this function:

◆ _getMobsForTarget()

static ilMapArea::_getMobsForTarget	(	string	$a_type,
		string	$a_target
	)

static

Get areas for a certain target.

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

References $DIC, $ilDB, $mobs, and ilMediaItem\_lookupMobId().

Referenced by ilLMObject\updateInternalLinks().

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _resolveIntLinks()

static ilMapArea::_resolveIntLinks ( int $a_item_id )

static

resolve internal links of an item id

Definition at line 177 of file class.ilMapArea.php.

References $DIC, $ilDB, $query, $type, ilInternalLink\_getIdForImportId(), and IL_INT_LINK.

Referenced by ilMediaItem\_resolveMapAreaLinks().

      : void {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         //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);
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendTitle()

ilMapArea::appendTitle ( string $a_title_str )

Definition at line 366 of file class.ilMapArea.php.

                                                     : void
     {
         $this->title .= $a_title_str;
     }

◆ countCoords()

static ilMapArea::countCoords ( string $c )

static

count the number of coordinates (x,y) in a coordinate string (format: "x1,y1,x2,y2,x3,y3,...")

Parameters

string $c coordinate string

Returns: int number of coordinates

Definition at line 702 of file class.ilMapArea.php.

Referenced by ilImageMapEditorGUI\addArea(), drawPoly(), ilImageMapEditorGUI\editMapArea(), and ilImageMapEditorGUI\setShape().

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

Here is the caller graph for this function:

◆ create()

ilMapArea::create ( )

create persistent map area object in db

Definition at line 92 of file class.ilMapArea.php.

References $db, $ilDB, getCoords(), getHighlightClass(), getHighlightMode(), getHref(), getItemId(), getLinkType(), getNr(), getShape(), getTarget(), getTargetFrame(), getTitle(), and getType().

                             : void
     {
         $ilDB = $this->db;
 
         $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);
     }

Here is the call graph for this function:

◆ draw()

ilMapArea::draw	(		$a_image,
		int	$a_col1,
		int	$a_col2,
		bool	$a_close_poly = `true`,
		float	$a_x_ratio = `1`,
		float	$a_y_ratio = `1`
	)

Parameters

resource | GdImage $a_image (GdImage comes with 8.0)

Definition at line 474 of file class.ilMapArea.php.

References drawCircle(), drawPoly(), drawRect(), getCoords(), and getShape().

      : void {
         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;
         }
     }

Here is the call graph for this function:

◆ drawCircle()

ilMapArea::drawCircle	(		$im,
		string	$coords,
		int	$c1,
		int	$c2,
		float	$a_x_ratio = `1`,
		float	$a_y_ratio = `1`
	)

draws an outlined two colored circle

Parameters

resource \| GdImage	$im	(GdImage comes with 8.0)
string	$coords	coordinate string, format : "x,y,r" with (x,y) as center point and r as radius
int	$c1	color identifier 1
int	$c2	color identifier 2

Definition at line 656 of file class.ilMapArea.php.

References $c.

Referenced by draw().

      : void {
         $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
         );
     }

Here is the caller graph for this function:

◆ drawLine()

ilMapArea::drawLine	(		$im,
		int	$x1,
		int	$y1,
		int	$x2,
		int	$y2,
		int	$c1,
		int	$c2
	)

draws an outlined two color line in an image

Parameters

resource \| GdImage	$im	(GdImage comes with 8.0)
int	$x1	x-coordinate of starting point
int	$y1	y-coordinate of starting point
int	$x2	x-coordinate of ending point
int	$y2	y-coordinate of ending point
int	$c1	color identifier 1
int	$c2	color identifier 2

Definition at line 529 of file class.ilMapArea.php.

Referenced by drawPoly(), and drawRect().

      : void {
         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);
     }

Here is the caller graph for this function:

◆ drawPoly()

ilMapArea::drawPoly	(		$im,
		string	$coords,
		int	$c1,
		int	$c2,
		bool	$closed,
		float	$a_x_ratio = `1`,
		float	$a_y_ratio = `1`
	)

draws an outlined two color polygon

Parameters

resource \| GdImage	$im	(GdImage comes with 8.0)
string	$coords	coordinate string, format : "x1,y1,x2,y2,..." with every (x,y) pair is an ending point of a line of the polygon
int	$c1	color identifier 1
int	$c2	color identifier 2
bool	$closed	true: the first and the last point will be connected with a line

Definition at line 611 of file class.ilMapArea.php.

References $c, $i, countCoords(), and drawLine().

Referenced by draw().

      : void {
         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
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ drawRect()

ilMapArea::drawRect	(		$im,
		string	$coords,
		int	$c1,
		int	$c2,
		float	$a_x_ratio = `1`,
		float	$a_y_ratio = `1`
	)

draws an outlined two color rectangle

Parameters

resource \| GdImage	$im	(GdImage comes with 8.0)
string	$coords	coordinate string, format : "x1,y1,x2,y2" with (x1,y1) is top left and (x2,y2) is bottom right point of the rectangle
int	$c1	color identifier 1
int	$c2	color identifier 2

Definition at line 553 of file class.ilMapArea.php.

References drawLine().

Referenced by draw().

      : void {
         $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
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllHighlightClasses()

static ilMapArea::getAllHighlightClasses ( )

static

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

References $DIC, and $lng.

Referenced by ilImageMapTableGUI\__construct().

                                                    : array
     {
         global $DIC;
 
         $lng = $DIC->language();
 
         return array(
             self::HLCL_ACCENTED => $lng->txt("cont_accented"),
             self::HLCL_LIGHT => $lng->txt("cont_light"),
             self::HLCL_DARK => $lng->txt("cont_dark"),
         );
     }

Here is the caller graph for this function:

◆ getAllHighlightModes()

static ilMapArea::getAllHighlightModes ( )

static

Definition at line 264 of file class.ilMapArea.php.

References $DIC, and $lng.

Referenced by ilImageMapTableGUI\__construct().

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

Here is the caller graph for this function:

◆ getCoords()

ilMapArea::getCoords ( )

Definition at line 353 of file class.ilMapArea.php.

References $coords.

Referenced by create(), draw(), and update().

                                : string
     {
         return $this->coords;
     }

Here is the caller graph for this function:

◆ getExtTitle()

ilMapArea::getExtTitle ( )

Definition at line 412 of file class.ilMapArea.php.

References $xl_title.

                                  : string
     {
         return $this->xl_title;
     }

◆ getHighlightClass()

ilMapArea::getHighlightClass ( )

Definition at line 306 of file class.ilMapArea.php.

References $highlight_class.

Referenced by create(), and update().

                                        : string
     {
         return $this->highlight_class;
     }

Here is the caller graph for this function:

◆ getHighlightMode()

ilMapArea::getHighlightMode ( )

Definition at line 283 of file class.ilMapArea.php.

References $highlight_mode.

Referenced by create(), and update().

                                       : string
     {
         return $this->highlight_mode;
     }

Here is the caller graph for this function:

◆ getHref()

ilMapArea::getHref ( )

Definition at line 398 of file class.ilMapArea.php.

References $xl_href.

Referenced by create(), and update().

                              : string
     {
         return $this->xl_href;
     }

Here is the caller graph for this function:

◆ getItemId()

ilMapArea::getItemId ( )

Definition at line 316 of file class.ilMapArea.php.

References $item_id.

Referenced by create(), read(), and update().

                                : int
     {
         return $this->item_id;
     }

Here is the caller graph for this function:

◆ getLinkType()

ilMapArea::getLinkType ( )

Definition at line 385 of file class.ilMapArea.php.

References $linktype.

Referenced by create(), and update().

                                  : string
     {
         return $this->linktype;
     }

Here is the caller graph for this function:

◆ getNr()

ilMapArea::getNr ( )

Definition at line 326 of file class.ilMapArea.php.

References $nr.

Referenced by create(), read(), and update().

                            : int
     {
         return $this->nr;
     }

Here is the caller graph for this function:

◆ getShape()

ilMapArea::getShape ( )

Definition at line 339 of file class.ilMapArea.php.

References $shape.

Referenced by create(), draw(), and update().

                               : string
     {
         return $this->shape;
     }

Here is the caller graph for this function:

◆ getTarget()

ilMapArea::getTarget ( bool $a_insert_inst = false )

get link target (internal link only)

Definition at line 429 of file class.ilMapArea.php.

References $il_target, and IL_INST_ID.

Referenced by create(), and update().

                                                           : string
     {
         $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;
     }

Here is the caller graph for this function:

◆ getTargetFrame()

ilMapArea::getTargetFrame ( )

Definition at line 466 of file class.ilMapArea.php.

References $il_target_frame.

Referenced by create(), and update().

                                     : string
     {
         return $this->il_target_frame;
     }

Here is the caller graph for this function:

◆ getTitle()

ilMapArea::getTitle ( )

Definition at line 371 of file class.ilMapArea.php.

References $title.

Referenced by create(), and update().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getType()

ilMapArea::getType ( )

Definition at line 450 of file class.ilMapArea.php.

References $il_type.

Referenced by create(), and update().

                              : string
     {
         return $this->il_type;
     }

Here is the caller graph for this function:

◆ read()

ilMapArea::read ( )

Definition at line 132 of file class.ilMapArea.php.

References $db, $ilDB, getItemId(), getNr(), setCoords(), setHighlightClass(), setHighlightMode(), setHref(), setLinkType(), setNr(), setShape(), setTarget(), setTargetFrame(), setTitle(), and setType().

Referenced by __construct().

                           : void
     {
         $ilDB = $this->db;
 
         $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((string) $area_rec["shape"]);
         //echo $area_rec["Shape"];
         $this->setNr((int) $area_rec["nr"]);
         $this->setCoords((string) $area_rec["coords"]);
         $this->setLinkType((string) $area_rec["link_type"]);
         $this->setTitle((string) $area_rec["title"]);
         $this->setHref((string) $area_rec["href"]);
         $this->setTarget((string) $area_rec["target"]);
         $this->setType((string) $area_rec["type"]);
         $this->setTargetFrame((string) $area_rec["target_frame"]);
         $this->setHighlightMode((string) $area_rec["highlight_mode"]);
         $this->setHighlightClass((string) $area_rec["highlight_class"]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCoords()

ilMapArea::setCoords ( string $a_coords )

set coords of area

Parameters

string $a_coords coords (comma separated integers)

Definition at line 348 of file class.ilMapArea.php.

Referenced by read().

                                                : void
     {
         $this->coords = $a_coords;
     }

Here is the caller graph for this function:

◆ setExtTitle()

ilMapArea::setExtTitle ( string $a_title )

set link text (external link only)

Parameters

string $a_title link text

Definition at line 407 of file class.ilMapArea.php.

                                                 : void
     {
         $this->xl_title = $a_title;
     }

◆ setHighlightClass()

ilMapArea::setHighlightClass ( string $a_val )

Definition at line 301 of file class.ilMapArea.php.

Referenced by read().

                                                     : void
     {
         $this->highlight_class = $a_val;
     }

Here is the caller graph for this function:

◆ setHighlightMode()

ilMapArea::setHighlightMode ( string $a_val )

Definition at line 277 of file class.ilMapArea.php.

Referenced by read().

      : void {
         $this->highlight_mode = $a_val;
     }

Here is the caller graph for this function:

◆ setHref()

ilMapArea::setHref ( string $a_href )

set hyper reference (external link only)

Definition at line 393 of file class.ilMapArea.php.

Referenced by read().

                                            : void
     {
         $this->xl_href = $a_href;
     }

Here is the caller graph for this function:

◆ setItemId()

ilMapArea::setItemId ( int $a_item_id )

Definition at line 311 of file class.ilMapArea.php.

Referenced by __construct().

                                              : void
     {
         $this->item_id = $a_item_id;
     }

Here is the caller graph for this function:

◆ setLinkType()

ilMapArea::setLinkType ( string $a_link_type )

set link type

Parameters

string $a_link_type link type (IL_INT_LINK, IL_EXT_LINK)

Definition at line 380 of file class.ilMapArea.php.

Referenced by read(), and ilImageMapEditorGUI\saveArea().

                                                     : void
     {
         $this->linktype = $a_link_type;
     }

Here is the caller graph for this function:

◆ setNr()

ilMapArea::setNr ( int $a_nr )

Definition at line 321 of file class.ilMapArea.php.

Referenced by __construct(), and read().

                                     : void
     {
         $this->nr = $a_nr;
     }

Here is the caller graph for this function:

◆ setShape()

ilMapArea::setShape ( string $a_shape )

set shape (IL_AREA_RECT, IL_AREA_CIRCLE, IL_AREA_POLY, IL_AREA_WHOLE_PICTURE)

Definition at line 334 of file class.ilMapArea.php.

Referenced by read(), and ilImageMapEditorGUI\saveArea().

                                              : void
     {
         $this->shape = $a_shape;
     }

Here is the caller graph for this function:

◆ setTarget()

ilMapArea::setTarget ( string $a_target )

set link target (internal link only)

Parameters

string $a_target link target (e.g. "il__pg_23")

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

Referenced by read().

                                                : void
     {
         $this->il_target = $a_target;
     }

Here is the caller graph for this function:

◆ setTargetFrame()

ilMapArea::setTargetFrame ( string $a_target_frame )

set link target frame (internal link only)

Parameters

string $a_target_frame target frame (IL_TF_MEDIA | IL_TF_FAQ | IL_TF_GLOSSARY | IL_TF_NEW)

Definition at line 461 of file class.ilMapArea.php.

Referenced by read().

                                                           : void
     {
         $this->il_target_frame = $a_target_frame;
     }

Here is the caller graph for this function:

◆ setTitle()

ilMapArea::setTitle ( string $a_title )

set (tooltip)title of area

Definition at line 361 of file class.ilMapArea.php.

Referenced by read(), and ilImageMapEditorGUI\updateAreas().

                                              : void
     {
         $this->title = $a_title;
     }

Here is the caller graph for this function:

◆ setType()

ilMapArea::setType ( string $a_type )

set link type (internal link only)

Parameters

string $a_type link type (IL_LT_STRUCTURE | IL_LT_PAGE | IL_LT_MEDIA | IL_LT_GLITEM)

Definition at line 445 of file class.ilMapArea.php.

Referenced by read().

                                            : void
     {
         $this->il_type = $a_type;
     }

Here is the caller graph for this function:

◆ update()

ilMapArea::update ( )

Definition at line 155 of file class.ilMapArea.php.

References $db, $ilDB, getCoords(), getHighlightClass(), getHighlightMode(), getHref(), getItemId(), getLinkType(), getNr(), getShape(), getTarget(), getTargetFrame(), getTitle(), and getType().

                             : void
     {
         $ilDB = $this->db;
 
         $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);
     }

Here is the call graph for this function:

Field Documentation

◆ $coords

string ilMapArea::$coords = ""

Definition at line 61 of file class.ilMapArea.php.

Referenced by getCoords().

◆ $db

ilDBInterface ilMapArea::$db

protected

Definition at line 57 of file class.ilMapArea.php.

Referenced by create(), read(), and update().

◆ $highlight_class

string ilMapArea::$highlight_class = ""

protected

Definition at line 55 of file class.ilMapArea.php.

Referenced by getHighlightClass().

◆ $highlight_mode

string ilMapArea::$highlight_mode = ""

protected

Definition at line 54 of file class.ilMapArea.php.

Referenced by getHighlightMode().

◆ $il_target

string ilMapArea::$il_target = ""

Definition at line 66 of file class.ilMapArea.php.

Referenced by getTarget().

◆ $il_target_frame

string ilMapArea::$il_target_frame = ""

Definition at line 68 of file class.ilMapArea.php.

Referenced by getTargetFrame().

◆ $il_type

string ilMapArea::$il_type = ""

Definition at line 67 of file class.ilMapArea.php.

Referenced by getType().

◆ $item_id

int ilMapArea::$item_id = 0

Definition at line 58 of file class.ilMapArea.php.

Referenced by getItemId().

◆ $linktype

string ilMapArea::$linktype = ""

Definition at line 63 of file class.ilMapArea.php.

Referenced by getLinkType().

◆ $nr

int ilMapArea::$nr = 0

Definition at line 59 of file class.ilMapArea.php.

Referenced by getNr().

◆ $shape

string ilMapArea::$shape = ""

Definition at line 60 of file class.ilMapArea.php.

Referenced by getShape().

◆ $title

string ilMapArea::$title = ""

Definition at line 62 of file class.ilMapArea.php.

Referenced by getTitle().

◆ $xl_href

string ilMapArea::$xl_href = ""

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

Referenced by getHref().

◆ $xl_title

string ilMapArea::$xl_title = ""

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

Referenced by getExtTitle().

◆ HL_ALWAYS

const ilMapArea::HL_ALWAYS = "Always"

Definition at line 50 of file class.ilMapArea.php.

◆ HL_HOVER

const ilMapArea::HL_HOVER = "Hover"

Definition at line 49 of file class.ilMapArea.php.

◆ HL_NONE

const ilMapArea::HL_NONE = ""

Definition at line 48 of file class.ilMapArea.php.

◆ HLCL_ACCENTED

const ilMapArea::HLCL_ACCENTED = ""

Definition at line 51 of file class.ilMapArea.php.

◆ HLCL_DARK

const ilMapArea::HLCL_DARK = "Dark"

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

◆ HLCL_LIGHT

const ilMapArea::HLCL_LIGHT = "Light"

Definition at line 52 of file class.ilMapArea.php.

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

Services/MediaObjects/ImageMap/class.ilMapArea.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getIntLinks()

◆ _getMaxNr()

◆ _getMobsForTarget()

◆ _resolveIntLinks()

◆ appendTitle()

◆ countCoords()

◆ create()

◆ draw()

◆ drawCircle()

◆ drawLine()

◆ drawPoly()

◆ drawRect()

◆ getAllHighlightClasses()

◆ getAllHighlightModes()

◆ getCoords()

◆ getExtTitle()

◆ getHighlightClass()

◆ getHighlightMode()

◆ getHref()

◆ getItemId()

◆ getLinkType()

◆ getNr()

◆ getShape()

◆ getTarget()

◆ getTargetFrame()

◆ getTitle()

◆ getType()

◆ read()

◆ setCoords()

◆ setExtTitle()

◆ setHighlightClass()

◆ setHighlightMode()

◆ setHref()

◆ setItemId()

◆ setLinkType()

◆ setNr()

◆ setShape()

◆ setTarget()

◆ setTargetFrame()

◆ setTitle()

◆ setType()

◆ update()

Field Documentation

◆ $coords

◆ $db

◆ $highlight_class

◆ $highlight_mode

◆ $il_target

◆ $il_target_frame

◆ $il_type

◆ $item_id

◆ $linktype

◆ $nr

◆ $shape

◆ $title

◆ $xl_href

◆ $xl_title

◆ HL_ALWAYS

◆ HL_HOVER

◆ HL_NONE

◆ HLCL_ACCENTED

◆ HLCL_DARK

◆ HLCL_LIGHT