Collaboration diagram for ilMediaItem:

Public Member Functions
	ilMediaItem ($a_id=0)

	setId ($a_id)
	set media item id More...

	getId ()
	get media item id More...

	setMobId ($a_mob_id)
	set id of parent media object More...

	getMobId ()
	get id of parent media object More...

	setNr ($a_nr)
	set number of media item within media object More...

	getNr ()

	setTextRepresentation ($a_val)
	Set text representation. More...

	getTextRepresentation ()
	Get text representation. More...

	create ()
	create persistent media item More...

	update ()
	update media item data (without map areas!) More...

	writeParameter ($a_name, $a_value)
	Write parameter. More...

	read ()
	read media item data (item id or (mob_id and nr) must be set) More...

	writeThumbTried ($a_tried)
	write thumbnail creation try data ("y"/"n") More...

	_getMediaItemsOfMObId ($a_mobId, $a_purpose)

	_getMediaItemsOfMOb (&$a_mob)
	read media items into media objects (static) More...

	deleteAllItemsOfMob ($a_mob_id)
	static More...

	setPurpose ($a_purpose)

	getPurpose ()

	setLocation ($a_location)

	getLocation ()

	setLocationType ($a_type)

	getLocationType ()

	setFormat ($a_format)

	getFormat ()

	setThumbTried ($a_tried)

	getThumbTried ()

	addMapArea (&$a_map_area)

	deleteMapArea ($nr)
	delete map area More...

&	getMapArea ($nr)
	get map area More...

	getMapAreas ()
	get map areas More...

	getWidth ()
	get width More...

	setWidth ($a_width)
	set width More...

	getHeight ()
	get height More...

	setHeight ($a_height)
	set height More...

	getOriginalSize ()
	get original size More...

	setCaption ($a_caption)
	set caption More...

	getCaption ()
	get caption More...

	setHAlign ($a_halign)
	set horizontal align More...

	getHAlign ()
	get horizontal align More...

	setParameter ($a_name, $a_value)
	set parameter More...

	resetParameters ()
	reset parameters More...

	setParameters ($a_par)
	set alle parameters via parameter string (format: par1="value1", par2="value2", ...) More...

	getParameters ()
	get all parameters (in array) More...

	getParameterString ()
	get all parameters (as string) More...

	getParameter ($a_name)
	get a single parameter More...

	getWorkDirectory ()
	get work directory for image map editing More...

	createWorkDirectory ()
	create work directory for image map editing More...

	getSuffix ()
	get location suffix More...

	getMapWorkCopyType ()
	get image type of image map work copy More...

	getMapWorkCopyName ($a_reference_copy=false)
	Get name of image map work copy file. More...

	getDirectory ()
	get media file directory More...

	getThumbnailDirectory ($a_mode="filesystem")
	get media file directory More...

	getThumbnailTarget ($a_size="")
	get thumbnail target More...

	copyOriginal ()
	Copy the orginal file. More...

	makeMapWorkCopy ($a_area_nr=0, $a_exclude=false)
	make map work copy of image More...

	addAreaToMapWorkCopy ($a_shape, $a_coords)
	draw a new area in work image More...

	outputMapWorkCopy ()
	output raw map work copy file More...

	buildMapWorkImage ()
	build image map work image More...

	saveMapWorkImage ()
	save image map work image More...

&	getMapWorkImage ()
	get image map work image More...

	getMapAreasXML ($a_insert_inst=false, $a_inst=0)
	get xml code of media items' areas More...

	_resolveMapAreaLinks ($a_mob_id)
	resolve internal links of all media items of a media object More...

	_getMapAreasIntLinks ($a_mob_id)
	get all internal links of map areas of a mob More...

	extractUrlParameters ()
	Extract parameters of special external references to parameter array. More...

Static Public Member Functions
static	_lookupLocationForMobId ($a_mob_id, $a_purpose)
	Lookup location for mob id. More...

static	_lookupMobId ($a_med_id)
	Lookup Mob ID. More...

static	checkParameter ($a_par, $a_val)
	Check parameter (filter javascript related and other unsafe parameters/values) More...

Data Fields
	$id

	$purpose

	$location

	$location_type

	$format

	$width

	$height

	$caption

	$halign

	$parameters

	$mob_id

	$nr

	$mapareas

	$map_cnt

	$map_image

	$color1

	$color2

Detailed Description

Class ilMediaItem.

Media Item, component of a media object (file or reference)

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

Version: $Id$

Definition at line 16 of file class.ilMediaItem.php.

Member Function Documentation

◆ _getMapAreasIntLinks()

ilMediaItem::_getMapAreasIntLinks ( $a_mob_id )

get all internal links of map areas of a mob

Parameters

int $a_mob_id media object id

Definition at line 1173 of file class.ilMediaItem.php.

        {
                global $ilDB;
                
                // read media_items records
                $query = "SELECT * FROM media_item WHERE mob_id = ".
                        $ilDB->quote($a_mob_id, "integer")." ORDER BY nr";
 
                $item_set = $ilDB->query($query);
                $links = array();
                while ($item_rec = $ilDB->fetchAssoc($item_set))
                {
                        $map_links = ilMapArea::_getIntLinks($item_rec["id"]);
                        foreach($map_links as $key => $map_link)
                        {
                                $links[$key] = $map_link;
                        }
                }
                return $links;
        }

References $ilDB, $query, and ilMapArea\_getIntLinks().

Referenced by ilPageObjectGUI\displayMedia(), ilObjMediaObject\exportMediaFullscreen(), ilPageObject\getInternalLinks(), ilLMPresentationGUI\ilMedia(), and ilGlossaryPresentationGUI\media().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getMediaItemsOfMOb()

ilMediaItem::_getMediaItemsOfMOb ( & $a_mob )

read media items into media objects (static)

Parameters

object $a_mob media object

Definition at line 376 of file class.ilMediaItem.php.

        {
                global $ilDB;
                
                // read media_object record
                $query = "SELECT * FROM media_item WHERE mob_id = ".
                        $ilDB->quote($a_mob->getId(), "integer")." ".
                        "ORDER BY nr";
                $item_set = $ilDB->query($query);
                while ($item_rec = $ilDB->fetchAssoc($item_set))
                {
                        $media_item =& new ilMediaItem();
                        $media_item->setNr($item_rec["nr"]);
                        $media_item->setId($item_rec["id"]);
                        $media_item->setLocation($item_rec["location"]);
                        $media_item->setLocationType($item_rec["location_type"]);
                        $media_item->setFormat($item_rec["format"]);
                        $media_item->setWidth($item_rec["width"]);
                        $media_item->setHeight($item_rec["height"]);
                        $media_item->setHAlign($item_rec["halign"]);
                        $media_item->setCaption($item_rec["caption"]);
                        $media_item->setPurpose($item_rec["purpose"]);
                        $media_item->setMobId($item_rec["mob_id"]);
                        $media_item->setThumbTried($item_rec["tried_thumb"]);
                        $media_item->setTextRepresentation($item_rec["text_representation"]);
 
                        // get item parameter
                        $query = "SELECT * FROM mob_parameter WHERE med_item_id = ".
                                $ilDB->quote($item_rec["id"], "integer");
                        $par_set = $ilDB->query($query);
                        while ($par_rec = $ilDB->fetchAssoc($par_set))
                        {
                                $media_item->setParameter($par_rec["name"], $par_rec["value"]);
                        }
 
                        // get item map areas
                        $max = ilMapArea::_getMaxNr($media_item->getId());
                        for ($i = 1; $i <= $max; $i++)
                        {
                                $area =& new ilMapArea($media_item->getId(), $i);
                                $media_item->addMapArea($area);
                        }
 
                        // add media item to media object
                        $a_mob->addMediaItem($media_item);
                }
        }

References $ilDB, $query, ilMapArea\_getMaxNr(), and ilMediaItem().

Referenced by ilObjMediaObject\read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getMediaItemsOfMObId()

ilMediaItem::_getMediaItemsOfMObId	(	$a_mobId,
		$a_purpose
	)

Definition at line 354 of file class.ilMediaItem.php.

        {
                global $ilDB;
                
                // read media_object record
                $query = "SELECT * FROM media_item WHERE mob_id = ".
                        $ilDB->quote($a_mobId, "integer")." ".
                        "AND purpose=" . $ilDB->quote($a_purpose, "text")." ORDER BY nr";
                $item_set = $ilDB->query($query);
                
                while ($item_rec = $ilDB->fetchAssoc($item_set))
                {
                        return $item_rec;
                }
                return false;
        }

References $ilDB, and $query.

Referenced by ilObjectFeedWriter\ilObjectFeedWriter().

Here is the caller graph for this function:

◆ _lookupLocationForMobId()

static ilMediaItem::_lookupLocationForMobId	(	$a_mob_id,
		$a_purpose
	)

static

Lookup location for mob id.

Parameters

int	$a_mob_id	media object id
string	$a_purpose	purpose

Definition at line 310 of file class.ilMediaItem.php.

        {
                global $ilDB;
                
                // read media_object record
                $query = "SELECT * FROM media_item WHERE mob_id = ".
                        $ilDB->quote($a_mob_id, "integer")." ".
                        "AND purpose = ".$ilDB->quote($a_purpose, "text");
                $set = $ilDB->query($query);
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return $rec["location"];
                }
 
                return "";
        }

References $ilDB, and $query.

Referenced by ilObjMediaObject\_lookupItemPath().

Here is the caller graph for this function:

◆ _lookupMobId()

static ilMediaItem::_lookupMobId ( $a_med_id )

static

Lookup Mob ID.

Parameters

int $a_med_id media item id

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

        {
                global $ilDB;
                
                // read media_object record
                $query = "SELECT * FROM media_item WHERE id = ".
                        $ilDB->quote($a_med_id, "integer");
                $set = $ilDB->query($query);
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return $rec["mob_id"];
                }
 
                return "";
        }

References $ilDB, and $query.

Referenced by ilMapArea\_getMobsForTarget().

Here is the caller graph for this function:

◆ _resolveMapAreaLinks()

ilMediaItem::_resolveMapAreaLinks ( $a_mob_id )

resolve internal links of all media items of a media object

Parameters

int $a_mob_id media object id

Definition at line 1152 of file class.ilMediaItem.php.

        {
                global $ilDB;
                
//echo "mediaItems::resolve<br>";
                // read media_object record
                $query = "SELECT * FROM media_item WHERE mob_id = ".
                        $ilDB->quote($a_mob_id, "integer")." ".
                        "ORDER BY nr";
                $item_set = $ilDB->query($query);
                while ($item_rec = $ilDB->fetchAssoc($item_set))
                {
                        ilMapArea::_resolveIntLinks($item_rec["id"]);
                }
        }

References $ilDB, $query, and ilMapArea\_resolveIntLinks().

Referenced by ilContObjParser\processPagesToParse(), and ilPageObject\resolveIntLinks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAreaToMapWorkCopy()

ilMediaItem::addAreaToMapWorkCopy	(	$a_shape,
		$a_coords
	)

draw a new area in work image

Parameters

string	$a_shape	shape
string	$a_coords	coordinates string

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

        {
                $this->buildMapWorkImage();
 
                // determine ratios
                $size = @getimagesize($this->getMapWorkCopyName());
                $x_ratio = 1;
                if ($size[0] > 0 && $this->getWidth() > 0)
                {
                        $x_ratio = $this->getWidth() / $size[0];
                }
                $y_ratio = 1;
                if ($size[1] > 0 && $this->getHeight() > 0)
                {
                        $y_ratio = $this->getHeight() / $size[1];
                }
 
                // add new area to work image
                $area = new ilMapArea();
                $area->setShape($a_shape);
                $area->setCoords($a_coords);
                $area->draw($this->getMapWorkImage(), $this->color1, $this->color2, false,
                        $x_ratio, $y_ratio);
 
                $this->saveMapWorkImage();
        }

References $size, buildMapWorkImage(), getHeight(), getMapWorkCopyName(), getMapWorkImage(), getWidth(), and saveMapWorkImage().

Here is the call graph for this function:

◆ addMapArea()

ilMediaItem::addMapArea ( & $a_map_area )

Definition at line 504 of file class.ilMediaItem.php.

        {
                $this->mapareas[$this->map_cnt] =& $a_map_area;
                $this->map_cnt++;
        }

References $map_cnt.

Referenced by read().

Here is the caller graph for this function:

◆ buildMapWorkImage()

ilMediaItem::buildMapWorkImage ( )

build image map work image

Definition at line 1021 of file class.ilMediaItem.php.

        {
                $im_type = strtolower($this->getMapWorkCopyType());
 
                switch ($im_type)
                {
                        case "gif":
                                $this->map_image = ImageCreateFromGIF($this->getMapWorkCopyName());
                                break;
 
                        case "jpg":
                        case "jpeg":
                                $this->map_image = ImageCreateFromJPEG($this->getMapWorkCopyName());
                                break;
 
                        case "png":
                                $this->map_image = ImageCreateFromPNG($this->getMapWorkCopyName());
                                break;
                }
 
                // try to allocate black and white as color. if this is not possible, get the closest colors
                if (imagecolorstotal($this->map_image) > 250)
                {
                        $this->color1 = imagecolorclosest($this->map_image, 0, 0, 0);
                        $this->color2 = imagecolorclosest($this->map_image, 255, 255, 255);
                }
                else
                {
                        $this->color1 = imagecolorallocate($this->map_image, 0, 0, 0);
                        $this->color2 = imagecolorallocate($this->map_image, 255, 255, 255);
                }
        }

References getMapWorkCopyName(), and getMapWorkCopyType().

Referenced by addAreaToMapWorkCopy(), and makeMapWorkCopy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkParameter()

static ilMediaItem::checkParameter	(	$a_par,
		$a_val
	)

static

Check parameter (filter javascript related and other unsafe parameters/values)

Parameters

string	$a_par	parameter
string	$a_val	value

Returns: bool

Definition at line 687 of file class.ilMediaItem.php.

        {
                // do not allow event attributes
                if (substr(strtolower(trim($a_par)), 0, 2) == "on")
                {
                        return false;
                }
                // no javascript in value
                if (is_int(strpos(strtolower($a_val), "javascript")))
                {
                        return false;
                }
                // do not allow to change the src attribute
                if (in_array(strtolower(trim($a_par)), array("src")))
                {
                        return false;
                }
 
                return true;
        }

Referenced by ilMediaAliasItem\setParameters().

Here is the caller graph for this function:

◆ copyOriginal()

ilMediaItem::copyOriginal ( )

Copy the orginal file.

Definition at line 876 of file class.ilMediaItem.php.

        {
                global $lng;
            $this->createWorkDirectory();
                
                if ($this->getLocationType() != "Reference")
                {
                        ilUtil::convertImage($this->getDirectory()."/".$this->getLocation(),
                                $this->getMapWorkCopyName(),
                                $this->getMapWorkCopyType());
                }
                else
                {
                        // first copy the external file, if necessary
                        if (!is_file($this->getMapWorkCopyName(true)) || (filesize($this->getMapWorkCopyName(true)) == 0))
                        {
                                $handle = @fopen($this->getLocation(), "r");
                                $lcopy = fopen($this->getMapWorkCopyName(true), "w");
                                if ($handle && $lcopy)
                                {
                                        while (!feof($handle))
                                        {
                                                $content = fread($handle, 4096);
                                                fwrite($lcopy, $content);
                                        }
                                }
                                @fclose($lcopy);
                                @fclose($handle);
                        }
                        
                        // now, create working copy
                        ilUtil::convertImage($this->getMapWorkCopyName(true),
                                $this->getMapWorkCopyName(),
                                $this->getMapWorkCopyType());
                }
 
                if (!is_file($this->getMapWorkCopyName()))
                {
                    
                        ilUtil::sendFailure($lng->txt("cont_map_file_not_generated"));
                        return false;
                }
                return true;
        }

References $lng, ilUtil\convertImage(), createWorkDirectory(), getDirectory(), getLocation(), getLocationType(), getMapWorkCopyName(), getMapWorkCopyType(), and ilUtil\sendFailure().

Referenced by makeMapWorkCopy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilMediaItem::create ( )

create persistent media item

Definition at line 126 of file class.ilMediaItem.php.

        {
                global $ilDB;
 
                $item_id = $ilDB->nextId("media_item");
                $query = "INSERT INTO media_item (id,mob_id, purpose, location, ".
                        "location_type, format, width, ".
                        "height, halign, caption, nr, text_representation) VALUES ".
                        "(".
                        $ilDB->quote($item_id, "integer").",".
                        $ilDB->quote($this->getMobId(), "integer").",".
                        $ilDB->quote($this->getPurpose(), "text").",".
                        $ilDB->quote($this->getLocation(), "text").",".
                        $ilDB->quote($this->getLocationType(), "text").",".
                        $ilDB->quote($this->getFormat(), "text").",".
                        $ilDB->quote($this->getWidth(), "text").",".
                        $ilDB->quote($this->getHeight(), "text").",".
                        $ilDB->quote($this->getHAlign(), "text").",".
                        $ilDB->quote($this->getCaption(), "text").",".
                        $ilDB->quote($this->getNr(), "integer").",".
                        $ilDB->quote($this->getTextRepresentation(), "text").")";
                $ilDB->manipulate($query);
                
                $this->setId($item_id);
 
                // create mob parameters
                $params = $this->getParameters();
                foreach($params as $name => $value)
                {
                        $query = "INSERT INTO mob_parameter (med_item_id, name, value) VALUES ".
                                "(".$ilDB->quote($item_id, "integer").",".
                                $ilDB->quote($name, "text").",".
                                $ilDB->quote($value, "text").")";
                        $ilDB->manipulate($query);
                }
 
                // create map areas
                for ($i=0; $i < count($this->mapareas); $i++)
                {
                        if (is_object($this->mapareas[$i]))
                        {
                                $this->mapareas[$i]->setItemId($this->getId());
                                $this->mapareas[$i]->setNr($i + 1);
                                $this->mapareas[$i]->create();
                        }
                }
        }

References $ilDB, $query, getCaption(), getFormat(), getHAlign(), getHeight(), getId(), getLocation(), getLocationType(), getMobId(), getNr(), getParameters(), getPurpose(), getTextRepresentation(), getWidth(), and setId().

Here is the call graph for this function:

◆ createWorkDirectory()

ilMediaItem::createWorkDirectory ( )

create work directory for image map editing

Definition at line 746 of file class.ilMediaItem.php.

        {
                if(!@is_dir(ilUtil::getDataDir()."/map_workfiles"))
                {
                        ilUtil::createDirectory(ilUtil::getDataDir()."/map_workfiles");
                }
                $work_dir = $this->getWorkDirectory();
                if(!@is_dir($work_dir))
                {
                        ilUtil::createDirectory($work_dir);
                }
        }

References ilUtil\createDirectory(), ilUtil\getDataDir(), and getWorkDirectory().

Referenced by copyOriginal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAllItemsOfMob()

ilMediaItem::deleteAllItemsOfMob ( $a_mob_id )

static

Definition at line 427 of file class.ilMediaItem.php.

        {
                global $ilDB;
                
                // iterate all media items ob mob
                $query = "SELECT * FROM media_item WHERE mob_id = ".
                        $ilDB->quote($a_mob_id, "integer");
                $item_set = $ilDB->query($query);
                while ($item_rec = $ilDB->fetchAssoc($item_set))
                {
                        // delete all parameters of media item
                        $query = "DELETE FROM mob_parameter WHERE med_item_id = ".
                                $ilDB->quote($item_rec["id"], "integer");
                        $ilDB->manipulate($query);
 
                        // delete all map areas of media item
                        $query = "DELETE FROM map_area WHERE item_id = ".
                                $ilDB->quote($item_rec["id"], "integer");
                        $ilDB->manipulate($query);
                }
 
                // delete media items
                $query = "DELETE FROM media_item WHERE mob_id = ".
                        $ilDB->quote($a_mob_id, "integer");
                $ilDB->manipulate($query);
        }

References $ilDB, and $query.

Referenced by ilObjMediaObject\delete(), and ilObjMediaObject\update().

Here is the caller graph for this function:

◆ deleteMapArea()

ilMediaItem::deleteMapArea ( $nr )

delete map area

Definition at line 513 of file class.ilMediaItem.php.

        {
                for ($i=1; $i<=$this->map_cnt; $i++)
                {
                        if($i > $nr)
                        {
                                $this->mapareas[$i-2] =& $this->mapareas[$i-1];
                                $this->mapareas[$i-2]->setNr($i-1);
                        }
                }
                if($nr <= $this->map_cnt)
                {
                        unset($this->mapareas[$this->map_cnt - 1]);
                        $this->map_cnt--;
                }
        }

References $map_cnt, and $nr.

◆ extractUrlParameters()

ilMediaItem::extractUrlParameters ( )

Extract parameters of special external references to parameter array.

Definition at line 1197 of file class.ilMediaItem.php.

        {
                include_once("./Services/MediaObjects/classes/class.ilExternalMediaAnalyzer.php");
                $par = ilExternalMediaAnalyzer::extractUrlParameters(
                        $this->getLocation(), $this->getParameters());
                foreach ($par as $k => $v)
                {
                        $this->setParameter($k, $v);
                }
        }

References ilExternalMediaAnalyzer\extractUrlParameters(), getLocation(), getParameters(), and setParameter().

Here is the call graph for this function:

◆ getCaption()

ilMediaItem::getCaption ( )

get caption

Definition at line 618 of file class.ilMediaItem.php.

        {
                return $this->caption;
        }

References $caption.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getDirectory()

ilMediaItem::getDirectory ( )

get media file directory

Definition at line 803 of file class.ilMediaItem.php.

        {
                return ilObjMediaObject::_getDirectory($this->getMobId());
        }

References ilObjMediaObject\_getDirectory(), and getMobId().

Referenced by copyOriginal(), and getThumbnailTarget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormat()

ilMediaItem::getFormat ( )

Definition at line 489 of file class.ilMediaItem.php.

        {
                return $this->format;
        }

References $format.

Referenced by create(), getOriginalSize(), getThumbnailTarget(), and update().

Here is the caller graph for this function:

◆ getHAlign()

ilMediaItem::getHAlign ( )

get horizontal align

Definition at line 634 of file class.ilMediaItem.php.

        {
                return $this->halign;
        }

References $halign.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getHeight()

ilMediaItem::getHeight ( )

get height

Definition at line 565 of file class.ilMediaItem.php.

        {
                return $this->height;
        }

References $height.

Referenced by addAreaToMapWorkCopy(), create(), makeMapWorkCopy(), and update().

Here is the caller graph for this function:

◆ getId()

ilMediaItem::getId ( )

get media item id

Returns: int media item id

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

        {
                return $this->id;
        }

References $id.

Referenced by create(), getWorkDirectory(), read(), update(), writeParameter(), and writeThumbTried().

Here is the caller graph for this function:

◆ getLocation()

ilMediaItem::getLocation ( )

Definition at line 469 of file class.ilMediaItem.php.

        {
                return $this->location;
        }

References $location.

Referenced by copyOriginal(), create(), extractUrlParameters(), getMapWorkCopyName(), getOriginalSize(), getSuffix(), getThumbnailTarget(), and update().

Here is the caller graph for this function:

◆ getLocationType()

ilMediaItem::getLocationType ( )

Definition at line 479 of file class.ilMediaItem.php.

        {
                return $this->location_type;
        }

References $location_type.

Referenced by copyOriginal(), create(), getOriginalSize(), getThumbnailTarget(), and update().

Here is the caller graph for this function:

◆ getMapArea()

& ilMediaItem::getMapArea ( $nr )

get map area

Definition at line 533 of file class.ilMediaItem.php.

        {
                return $this->mapareas[$nr-1];
        }

References $nr.

◆ getMapAreas()

ilMediaItem::getMapAreas ( )

get map areas

Definition at line 541 of file class.ilMediaItem.php.

        {
                return $this->mapareas;
        }

References $mapareas.

◆ getMapAreasXML()

ilMediaItem::getMapAreasXML	(	$a_insert_inst = `false`,
		$a_inst = `0`
	)

get xml code of media items' areas

Definition at line 1093 of file class.ilMediaItem.php.

        {
                $xml = "";
 
                // build xml of map areas
                for ($i=0; $i < count($this->mapareas); $i++)
                {
                        $area =& $this->mapareas[$i];
                        
                        // highlight mode
                        $hm = "";
                        if ($area->getHighlightMode() != "")
                        {
                                $hm = ' HighlightMode="'.$area->getHighlightMode().'" ';
                                $hcl = ($area->getHighlightClass() != "")
                                        ? $area->getHighlightClass()
                                        : "Accented";
                                $hm.= 'HighlightClass="'.$hcl.'" ';
                        }
                        
                        $xml .= "<MapArea Shape=\"".$area->getShape()."\" Coords=\"".$area->getCoords()."\" ".$hm.">";
                        if ($area->getLinkType() == IL_INT_LINK)
                        {
                                $target_frame = $area->getTargetFrame();
 
                                if ($area->getType() == "GlossaryItem" && $target_frame == "")
                                {
                                        $target_frame = "Glossary";
                                }
 
                                $tf_str = ($target_frame == "")
                                        ? ""
                                        : "TargetFrame=\"".$target_frame."\"";
                                
                                $xml .= "<IntLink Target=\"".$area->getTarget($a_insert_inst, $a_inst)."\" Type=\"".
                                        $area->getType()."\" $tf_str>";
                                // see bug 17893 and http://stackoverflow.com/questions/4026502/xml-error-at-ampersand
                                $xml .= htmlspecialchars($area->getTitle(), ENT_QUOTES);
                                $xml .="</IntLink>";
                        }
                        else
                        {
                                $xml .= "<ExtLink Href=\"".str_replace("&", "&amp;",$area->getHref())."\" Title=\"".
                                        $area->getExtTitle()."\">";
                                $xml .= $area->getTitle();
                                $xml .="</ExtLink>";
                        }
                        $xml .= "</MapArea>";
                }
 
                return $xml;
        }

References IL_INT_LINK.

◆ getMapWorkCopyName()

ilMediaItem::getMapWorkCopyName ( $a_reference_copy = false )

Get name of image map work copy file.

Parameters

string Get name, for copy of external referenced image

Definition at line 782 of file class.ilMediaItem.php.

        {
                $file_arr = explode("/", $this->getLocation());
                $o_file = $file_arr[count($file_arr) - 1];
                $file_arr = explode(".", $o_file);
                unset($file_arr[count($file_arr) - 1]);
                $file = implode($file_arr, ".");
 
                if (!$a_reference_copy)
                {
                        return $this->getWorkDirectory()."/".$file.".".$this->getMapWorkCopyType();
                }
                else
                {
                        return $this->getWorkDirectory()."/l_copy_".$o_file;
                }
        }

References $file, getLocation(), getMapWorkCopyType(), and getWorkDirectory().

Referenced by addAreaToMapWorkCopy(), buildMapWorkImage(), copyOriginal(), makeMapWorkCopy(), outputMapWorkCopy(), and saveMapWorkImage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMapWorkCopyType()

ilMediaItem::getMapWorkCopyType ( )

get image type of image map work copy

Definition at line 772 of file class.ilMediaItem.php.

        {
                return ilUtil::getGDSupportedImageType($this->getSuffix());
        }

References ilUtil\getGDSupportedImageType(), and getSuffix().

Referenced by buildMapWorkImage(), copyOriginal(), getMapWorkCopyName(), outputMapWorkCopy(), and saveMapWorkImage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMapWorkImage()

& ilMediaItem::getMapWorkImage ( )

get image map work image

Definition at line 1084 of file class.ilMediaItem.php.

        {
                return $this->map_image;
        }

References $map_image.

Referenced by addAreaToMapWorkCopy(), and makeMapWorkCopy().

Here is the caller graph for this function:

◆ getMobId()

ilMediaItem::getMobId ( )

get id of parent media object

Returns: int media object id

Definition at line 84 of file class.ilMediaItem.php.

        {
                return $this->mob_id;
        }

References $mob_id.

Referenced by create(), getDirectory(), getOriginalSize(), getThumbnailDirectory(), getThumbnailTarget(), read(), and update().

Here is the caller graph for this function:

◆ getNr()

ilMediaItem::getNr ( )

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

        {
                return $this->nr;
        }

References $nr.

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

Here is the caller graph for this function:

◆ getOriginalSize()

ilMediaItem::getOriginalSize ( )

get original size

Definition at line 581 of file class.ilMediaItem.php.

        {
                $mob_dir = ilObjMediaObject::_getDirectory($this->getMobId());
 
                if (ilUtil::deducibleSize($this->getFormat()))
                {
                        if ($this->getLocationType() == "LocalFile")
                        {
                                $loc = $mob_dir."/".$this->getLocation();
                        }
                        else
                        {
                                $loc = $this->getLocation();
                        }
 
                        include_once("./Services/MediaObjects/classes/class.ilMediaImageUtil.php");
                        $size = ilMediaImageUtil::getImageSize($loc);
                        if ($size[0] > 0 && $size[1] > 0)
                        {
                                return array("width" => $size[0], "height" => $size[1]);
                        }
                }
 
                return false;
        }

References $size, ilObjMediaObject\_getDirectory(), ilUtil\deducibleSize(), getFormat(), ilMediaImageUtil\getImageSize(), getLocation(), getLocationType(), and getMobId().

Here is the call graph for this function:

◆ getParameter()

ilMediaItem::getParameter ( $a_name )

get a single parameter

Definition at line 730 of file class.ilMediaItem.php.

        {
                return $this->parameters[$a_name];
        }

◆ getParameters()

ilMediaItem::getParameters ( )

get all parameters (in array)

Definition at line 712 of file class.ilMediaItem.php.

        {
                return $this->parameters;
        }

References $parameters.

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

Here is the caller graph for this function:

◆ getParameterString()

ilMediaItem::getParameterString ( )

get all parameters (as string)

Definition at line 721 of file class.ilMediaItem.php.

        {
                return ilUtil::assembleParameterString($this->parameters);
        }

References ilUtil\assembleParameterString().

Here is the call graph for this function:

◆ getPurpose()

ilMediaItem::getPurpose ( )

Definition at line 459 of file class.ilMediaItem.php.

        {
                return $this->purpose;
        }

References $purpose.

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

Here is the caller graph for this function:

◆ getSuffix()

ilMediaItem::getSuffix ( )

get location suffix

Definition at line 762 of file class.ilMediaItem.php.

        {
                $loc_arr = explode(".", $this->getLocation());
 
                return $loc_arr[count($loc_arr) - 1];
        }

References getLocation().

Referenced by getMapWorkCopyType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTextRepresentation()

ilMediaItem::getTextRepresentation ( )

Get text representation.

Returns: string text representation

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

        {
                return $this->text_representation;
        }

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getThumbnailDirectory()

ilMediaItem::getThumbnailDirectory ( $a_mode = "filesystem" )

get media file directory

Definition at line 811 of file class.ilMediaItem.php.

        {
                return ilObjMediaObject::_getThumbnailDirectory($this->getMobId(), $a_mode);
        }

References ilObjMediaObject\_getThumbnailDirectory(), and getMobId().

Referenced by getThumbnailTarget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThumbnailTarget()

ilMediaItem::getThumbnailTarget ( $a_size = "" )

get thumbnail target

Definition at line 819 of file class.ilMediaItem.php.

        {
                if (is_int(strpos($this->getFormat(), "image")))
                {
                        $thumb_file = $this->getThumbnailDirectory()."/".
                                $this->getPurpose().".jpeg";
 
                        $thumb_file_small = $this->getThumbnailDirectory()."/".
                                $this->getPurpose()."_small.jpeg";
 
                        // generate thumbnail (if not tried before)
                        if ($this->getThumbTried() == "n" && $this->getLocationType() == "LocalFile")
                        {
                                if (is_file($thumb_file))
                                {
                                        unlink($thumb_file);
                                }
                                if (is_file($thumb_file_small))
                                {
                                        unlink($thumb_file_small);
                                }
                                $this->writeThumbTried("y");
                                ilObjMediaObject::_createThumbnailDirectory($this->getMobId());
                                $med_file = $this->getDirectory()."/".$this->getLocation();
 
                                if (is_file($med_file))
                                {
                                        ilUtil::convertImage($med_file, $thumb_file, "jpeg", "80");
                                        ilUtil::convertImage($med_file, $thumb_file_small, "jpeg", "40");
                                }
                        }
 
                        if ($a_size == "small")
                        {
                                if (is_file($thumb_file_small))
                                {
                                        return $this->getThumbnailDirectory("output")."/".
                                                $this->getPurpose()."_small.jpeg?dummy=".rand(1, 999999);
                                }
                        }
                        else
                        {
                                if (is_file($thumb_file))
                                {
                                        return $this->getThumbnailDirectory("output")."/".
                                                $this->getPurpose().".jpeg?dummy=".rand(1, 999999);
                                }
                        }
                }
 
                return "";
        }

References ilObjMediaObject\_createThumbnailDirectory(), ilUtil\convertImage(), getDirectory(), getFormat(), getLocation(), getLocationType(), getMobId(), getPurpose(), getThumbnailDirectory(), getThumbTried(), and writeThumbTried().

Here is the call graph for this function:

◆ getThumbTried()

ilMediaItem::getThumbTried ( )

Definition at line 499 of file class.ilMediaItem.php.

        {
                return $this->tried_thumb;
        }

Referenced by getThumbnailTarget().

Here is the caller graph for this function:

◆ getWidth()

ilMediaItem::getWidth ( )

get width

Definition at line 549 of file class.ilMediaItem.php.

        {
                return $this->width;
        }

References $width.

Referenced by addAreaToMapWorkCopy(), create(), makeMapWorkCopy(), and update().

Here is the caller graph for this function:

◆ getWorkDirectory()

ilMediaItem::getWorkDirectory ( )

get work directory for image map editing

Definition at line 738 of file class.ilMediaItem.php.

        {
                return ilUtil::getDataDir()."/map_workfiles/item_".$this->getId();
        }

References ilUtil\getDataDir(), and getId().

Referenced by createWorkDirectory(), and getMapWorkCopyName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ilMediaItem()

ilMediaItem::ilMediaItem ( $a_id = 0 )

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

        {
                $this->parameters = array();
                $this->mapareas = array();
                $this->map_cnt = 0;
 
                if ($a_id != 0)
                {
                        $this->setId($a_id);
                        $this->read();
                }
        }

References read(), and setId().

Referenced by _getMediaItemsOfMOb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeMapWorkCopy()

ilMediaItem::makeMapWorkCopy	(	$a_area_nr = `0`,
		$a_exclude = `false`
	)

make map work copy of image

Parameters

int	$a_area_nr	draw area $a_area_nr only
boolean	$a_exclude	true: draw all areas but area $a_area_nr

Definition at line 927 of file class.ilMediaItem.php.

        {
                global $lng;
                
                if (!$this->copyOriginal())
                {
                        return false;
                }
                $this->buildMapWorkImage();
                
                // determine ratios
                $size = @getimagesize($this->getMapWorkCopyName());
                $x_ratio = 1;
                if ($size[0] > 0 && $this->getWidth() > 0)
                {
                        $x_ratio = $this->getWidth() / $size[0];
                }
                $y_ratio = 1;
                if ($size[1] > 0 && $this->getHeight() > 0)
                {
                        $y_ratio = $this->getHeight() / $size[1];
                }
 
                // draw map areas
                for ($i=0; $i < count($this->mapareas); $i++)
                {
                        if (    ((($i+1) == $a_area_nr) && !$a_exclude) ||
                                        ((($i+1) != $a_area_nr) && $a_exclude) ||
                                        ($a_area_nr == 0)
                                )
                        {
                                $area =& $this->mapareas[$i];
                                $area->draw($this->getMapWorkImage(), $this->color1, $this->color2, true,
                                        $x_ratio, $y_ratio);
                        }
                }
 
                $this->saveMapWorkImage();
                
                return true;
        }

References $color1, $color2, $lng, $size, buildMapWorkImage(), copyOriginal(), getHeight(), getMapWorkCopyName(), getMapWorkImage(), getWidth(), and saveMapWorkImage().

Here is the call graph for this function:

◆ outputMapWorkCopy()

ilMediaItem::outputMapWorkCopy ( )

output raw map work copy file

Definition at line 1006 of file class.ilMediaItem.php.

        {
                if ($this->getMapWorkCopyType() != "")
                {
                        header("Pragma: no-cache");
                        header("Expires: 0");
                        header("Content-type: image/".strtolower($this->getMapWorkCopyType()));
                        readfile($this->getMapWorkCopyName());
                }
                exit;
        }

References exit, getMapWorkCopyName(), and getMapWorkCopyType().

Here is the call graph for this function:

◆ read()

ilMediaItem::read ( )

read media item data (item id or (mob_id and nr) must be set)

Definition at line 232 of file class.ilMediaItem.php.

        {
                global $ilDB;
 
                $item_id = $this->getId();
                $mob_id = $this->getMobId();
                $nr = $this->getNr();
                $query = "";
                if($item_id > 0)
                {
                        $query = "SELECT * FROM media_item WHERE id = ".
                                $ilDB->quote($this->getId(), "integer");
                }
                else if ($mob_id > 0 && $nr > 0)
                {
                        $query = "SELECT * FROM media_item WHERE mob_id = ".
                                $ilDB->quote($this->getMobId(), "integer")." ".
                                "AND nr=".$ilDB->quote($this->getNr(), "integer");
                }
                if ($query != "")
                {
                        $item_set = $ilDB->query($query);
                        $item_rec = $ilDB->fetchAssoc($item_set);
 
                        $this->setLocation($item_rec["location"]);
                        $this->setLocationType($item_rec["location_type"]);
                        $this->setFormat($item_rec["format"]);
                        $this->setWidth($item_rec["width"]);
                        $this->setHeight($item_rec["height"]);
                        $this->setHAlign($item_rec["halign"]);
                        $this->setCaption($item_rec["caption"]);
                        $this->setPurpose($item_rec["purpose"]);
                        $this->setNr($item_rec["nr"]);
                        $this->setMobId($item_rec["mob_id"]);
                        $this->setId($item_rec["id"]);
                        $this->setThumbTried($item_rec["tried_thumb"]);
                        $this->setTextRepresentation($item_rec["text_representation"]);
 
                        // get item parameter
                        $query = "SELECT * FROM mob_parameter WHERE med_item_id = ".
                                $ilDB->quote($this->getId(), "integer");
                        $par_set = $ilDB->query($query);
                        while ($par_rec = $ilDB->fetchAssoc($par_set))
                        {
                                $this->setParameter($par_rec["name"], $par_rec["value"]);
                        }
 
                        // get item map areas
                        $max = ilMapArea::_getMaxNr($this->getId());
                        for ($i = 1; $i <= $max; $i++)
                        {
                                $area =& new ilMapArea($this->getId(), $i);
                                $this->addMapArea($area);
                        }
                }
 
        }

References $ilDB, $nr, $query, ilMapArea\_getMaxNr(), addMapArea(), getId(), getMobId(), getNr(), setCaption(), setFormat(), setHAlign(), setHeight(), setId(), setLocation(), setLocationType(), setMobId(), setNr(), setParameter(), setPurpose(), setTextRepresentation(), setThumbTried(), and setWidth().

Referenced by ilMediaItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetParameters()

ilMediaItem::resetParameters ( )

reset parameters

Definition at line 657 of file class.ilMediaItem.php.

        {
                $this->parameters = array();
        }

Referenced by setParameters().

Here is the caller graph for this function:

◆ saveMapWorkImage()

ilMediaItem::saveMapWorkImage ( )

save image map work image

Definition at line 1057 of file class.ilMediaItem.php.

        {
                $im_type = strtolower($this->getMapWorkCopyType());
 
                // save image work-copy and free memory
                switch ($im_type)
                {
                        case "gif":
                                ImageGIF($this->map_image, $this->getMapWorkCopyName());
                                break;
 
                        case "jpg":
                        case "jpeg":
                                ImageJPEG($this->map_image, $this->getMapWorkCopyName());
                                break;
 
                        case "png":
                                ImagePNG($this->map_image, $this->getMapWorkCopyName());
                                break;
                }
 
                ImageDestroy($this->map_image);
        }

References getMapWorkCopyName(), and getMapWorkCopyType().

Referenced by addAreaToMapWorkCopy(), and makeMapWorkCopy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCaption()

ilMediaItem::setCaption ( $a_caption )

set caption

Definition at line 610 of file class.ilMediaItem.php.

        {
                $this->caption = $a_caption;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setFormat()

ilMediaItem::setFormat ( $a_format )

Definition at line 484 of file class.ilMediaItem.php.

        {
                $this->format = $a_format;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setHAlign()

ilMediaItem::setHAlign ( $a_halign )

set horizontal align

Definition at line 626 of file class.ilMediaItem.php.

        {
                $this->halign = $a_halign;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setHeight()

ilMediaItem::setHeight ( $a_height )

set height

Definition at line 573 of file class.ilMediaItem.php.

        {
                $this->height = $a_height;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setId()

ilMediaItem::setId ( $a_id )

set media item id

Parameters

int $a_id media item id

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

        {
                $this->id = $a_id;
        }

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

Here is the caller graph for this function:

◆ setLocation()

ilMediaItem::setLocation ( $a_location )

Definition at line 464 of file class.ilMediaItem.php.

        {
                $this->location = $a_location;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setLocationType()

ilMediaItem::setLocationType ( $a_type )

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

        {
                $this->location_type = $a_type;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setMobId()

ilMediaItem::setMobId ( $a_mob_id )

set id of parent media object

Parameters

int $a_mob_id media object id

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

        {
                $this->mob_id = $a_mob_id;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setNr()

ilMediaItem::setNr ( $a_nr )

set number of media item within media object

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

        {
                $this->nr = $a_nr;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setParameter()

ilMediaItem::setParameter	(	$a_name,
		$a_value
	)

set parameter

Parameters

string	$a_name	parameter name
string	$a_value	parameter value

Definition at line 646 of file class.ilMediaItem.php.

        {
                if (self::checkParameter($a_name, $a_value))
                {
                        $this->parameters[$a_name] = $a_value;
                }
        }

Referenced by extractUrlParameters(), read(), and setParameters().

Here is the caller graph for this function:

◆ setParameters()

ilMediaItem::setParameters ( $a_par )

set alle parameters via parameter string (format: par1="value1", par2="value2", ...)

Parameters

string $a_par parameter string

Definition at line 667 of file class.ilMediaItem.php.

        {
                $this->resetParameters();
                $par_arr = ilUtil::extractParameterString($a_par);
                if(is_array($par_arr))
                {
                        foreach($par_arr as $par => $val)
                        {
                                $this->setParameter($par, $val);
                        }
                }
        }

References ilUtil\extractParameterString(), resetParameters(), and setParameter().

Here is the call graph for this function:

◆ setPurpose()

ilMediaItem::setPurpose ( $a_purpose )

Definition at line 454 of file class.ilMediaItem.php.

        {
                $this->purpose = $a_purpose;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setTextRepresentation()

ilMediaItem::setTextRepresentation ( $a_val )

Set text representation.

Parameters

string text representation

Definition at line 107 of file class.ilMediaItem.php.

        {
                $this->text_representation = $a_val;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setThumbTried()

ilMediaItem::setThumbTried ( $a_tried )

Definition at line 494 of file class.ilMediaItem.php.

        {
                $this->tried_thumb = $a_tried;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setWidth()

ilMediaItem::setWidth ( $a_width )

set width

Definition at line 557 of file class.ilMediaItem.php.

        {
                $this->width = $a_width;
        }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilMediaItem::update ( )

update media item data (without map areas!)

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

        {
                global $ilDB;
 
                $query = "UPDATE media_item SET ".
                        " mob_id = ".$ilDB->quote($this->getMobId(), "integer").",".
                        " purpose = ".$ilDB->quote($this->getPurpose(), "text").",".
                        " location = ".$ilDB->quote($this->getLocation(), "text").",".
                        " location_type = ".$ilDB->quote($this->getLocationType(), "text").",".
                        " format = ".$ilDB->quote($this->getFormat(), "text").",".
                        " width = ".$ilDB->quote($this->getWidth(), "text").",".
                        " height = ".$ilDB->quote($this->getHeight(), "text").",".
                        " halign = ".$ilDB->quote($this->getHAlign(), "text").",".
                        " caption = ".$ilDB->quote($this->getCaption(), "text").",".
                        " nr = ".$ilDB->quote($this->getNr(), "integer").",".
                        " text_representation = ".$ilDB->quote($this->getTextRepresentation(), "text").
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($query);
 
                // delete mob parameters
                $query = "DELETE FROM mob_parameter WHERE med_item_id = ".
                        $ilDB->quote($this->getId(), "integer");
 
                // create mob parameters
                $params = $this->getParameters();
                foreach($params as $name => $value)
                {
                        $query = "INSERT INTO mob_parameter (med_item_id, name, value) VALUES ".
                                "(".$ilDB->quote($this->getId(), "integer").",".
                                $ilDB->quote($name, "text").",".
                                $ilDB->quote($value, "text").")";
                        $ilDB->manipulate($query);
                }
        }

References $ilDB, $query, getCaption(), getFormat(), getHAlign(), getHeight(), getId(), getLocation(), getLocationType(), getMobId(), getNr(), getParameters(), getPurpose(), getTextRepresentation(), and getWidth().

Here is the call graph for this function:

◆ writeParameter()

ilMediaItem::writeParameter	(	$a_name,
		$a_value
	)

Write parameter.

Parameters

return

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

        {
                global $ilDB;
 
                $query = "INSERT INTO mob_parameter (med_item_id, name, value) VALUES ".
                        "(".$ilDB->quote($this->getId(), "integer").",".
                        $ilDB->quote($a_name, "text").",".
                        $ilDB->quote($a_value, "text").")";
                $ilDB->manipulate($query);
        }

References $ilDB, $query, and getId().

Here is the call graph for this function:

◆ writeThumbTried()

ilMediaItem::writeThumbTried ( $a_tried )

write thumbnail creation try data ("y"/"n")

Definition at line 293 of file class.ilMediaItem.php.

        {
                global $ilDB;
                
                $q = "UPDATE media_item SET tried_thumb = ".
                        $ilDB->quote($a_tried, "text").
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer");
                        
                $ilDB->manipulate($q);
        }

References $ilDB, and getId().

Referenced by getThumbnailTarget().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $caption

ilMediaItem::$caption

Definition at line 25 of file class.ilMediaItem.php.

Referenced by getCaption().

◆ $color1

ilMediaItem::$color1

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

Referenced by makeMapWorkCopy().

◆ $color2

ilMediaItem::$color2

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

Referenced by makeMapWorkCopy().

◆ $format

ilMediaItem::$format

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

Referenced by getFormat().

◆ $halign

ilMediaItem::$halign

Definition at line 26 of file class.ilMediaItem.php.

Referenced by getHAlign().

◆ $height

ilMediaItem::$height

Definition at line 24 of file class.ilMediaItem.php.

Referenced by getHeight().

◆ $id

ilMediaItem::$id

Definition at line 18 of file class.ilMediaItem.php.

Referenced by getId().

◆ $location

ilMediaItem::$location

Definition at line 20 of file class.ilMediaItem.php.

Referenced by getLocation().

◆ $location_type

ilMediaItem::$location_type

Definition at line 21 of file class.ilMediaItem.php.

Referenced by getLocationType().

◆ $map_cnt

ilMediaItem::$map_cnt

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

Referenced by addMapArea(), and deleteMapArea().

◆ $map_image

ilMediaItem::$map_image

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

Referenced by getMapWorkImage().

◆ $mapareas

ilMediaItem::$mapareas

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

Referenced by getMapAreas().

◆ $mob_id

ilMediaItem::$mob_id

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

Referenced by getMobId().

◆ $nr

ilMediaItem::$nr

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

Referenced by deleteMapArea(), getMapArea(), getNr(), and read().

◆ $parameters

ilMediaItem::$parameters

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

Referenced by getParameters().

◆ $purpose

ilMediaItem::$purpose

Definition at line 19 of file class.ilMediaItem.php.

Referenced by getPurpose().

◆ $width

ilMediaItem::$width

Definition at line 23 of file class.ilMediaItem.php.

Referenced by getWidth().

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

Services/MediaObjects/classes/class.ilMediaItem.php

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ _getMapAreasIntLinks()

◆ _getMediaItemsOfMOb()

◆ _getMediaItemsOfMObId()

◆ _lookupLocationForMobId()

◆ _lookupMobId()

◆ _resolveMapAreaLinks()

◆ addAreaToMapWorkCopy()

◆ addMapArea()

◆ buildMapWorkImage()

◆ checkParameter()

◆ copyOriginal()

◆ create()

◆ createWorkDirectory()

◆ deleteAllItemsOfMob()

◆ deleteMapArea()

◆ extractUrlParameters()

◆ getCaption()

◆ getDirectory()

◆ getFormat()

◆ getHAlign()

◆ getHeight()

◆ getId()

◆ getLocation()

◆ getLocationType()

◆ getMapArea()

◆ getMapAreas()

◆ getMapAreasXML()

◆ getMapWorkCopyName()

◆ getMapWorkCopyType()

◆ getMapWorkImage()

◆ getMobId()

◆ getNr()

◆ getOriginalSize()

◆ getParameter()

◆ getParameters()

◆ getParameterString()

◆ getPurpose()

◆ getSuffix()

◆ getTextRepresentation()

◆ getThumbnailDirectory()

◆ getThumbnailTarget()

◆ getThumbTried()

◆ getWidth()

◆ getWorkDirectory()

◆ ilMediaItem()

◆ makeMapWorkCopy()

◆ outputMapWorkCopy()

◆ read()

◆ resetParameters()

◆ saveMapWorkImage()

◆ setCaption()

◆ setFormat()

◆ setHAlign()

◆ setHeight()

◆ setId()

◆ setLocation()

◆ setLocationType()

◆ setMobId()

◆ setNr()

◆ setParameter()

◆ setParameters()

◆ setPurpose()

◆ setTextRepresentation()

◆ setThumbTried()

◆ setWidth()

◆ update()

◆ writeParameter()

◆ writeThumbTried()

Field Documentation

◆ $caption

◆ $color1

◆ $color2

◆ $format

◆ $halign

◆ $height