Class ilMediaItem Media Item, component of a media object (file or reference) More...

Collaboration diagram for ilMediaItem:

Public Member Functions
	__construct ($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 ()

	setDuration ($a_val)
	Set duration. More...

	getDuration ()
	Get duration. More...

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

	getTextRepresentation ()
	Get text representation. More...

	setUploadHash ($a_val)
	Set upload hash. More...

	getUploadHash ()
	Get upload hash. 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...

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

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

	determineDuration ()

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	_getMediaItemsOfMObId ($a_mobId, $a_purpose)

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

static	deleteAllItemsOfMob ($a_mob_id)
	Delete all items of a mob. More...

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

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

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

static	getMediaItemsForUploadHash ($a_hash)
	Get media items for upload hash. More...

Data Fields
	$id

	$purpose

	$location

	$location_type

	$format

	$width

	$height

	$caption

	$halign

	$parameters

	$mob_id

	$nr

	$mapareas

	$map_cnt

	$map_image

	$color1

	$color2

Protected Attributes
	$db

	$lng

	$duration = 0

	$upload_hash

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 13 of file class.ilMediaItem.php.

Constructor & Destructor Documentation

◆ __construct()

ilMediaItem::__construct ( $a_id = 0 )

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

References $DIC, read(), and setId().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->lng = $DIC->language();
         $this->parameters = array();
         $this->mapareas = array();
         $this->map_cnt = 0;
 
         if ($a_id != 0) {
             $this->setId($a_id);
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getMapAreasIntLinks()

static ilMediaItem::_getMapAreasIntLinks ( $a_mob_id )

static

get all internal links of map areas of a mob

Parameters

int $a_mob_id media object id

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getMediaItemsOfMOb()

static ilMediaItem::_getMediaItemsOfMOb ( & $a_mob )

static

read media items into media objects (static)

Parameters

object $a_mob media object

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

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

Referenced by ilObjMediaObject\read().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         // 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"]);
             $media_item->setUploadHash($item_rec["upload_hash"]);
             $media_item->setDuration((int) $item_rec["duration"]);
 
             // 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);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getMediaItemsOfMObId()

static ilMediaItem::_getMediaItemsOfMObId	(	$a_mobId,
		$a_purpose
	)

static

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

References $DIC, $ilDB, and $query.

Referenced by ilObjectFeedWriter\__construct().

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

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 350 of file class.ilMediaItem.php.

References $DIC, $ilDB, and $query.

Referenced by ilObjMediaObject\_lookupItemPath().

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

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 372 of file class.ilMediaItem.php.

References $DIC, $ilDB, and $query.

Referenced by ilMapArea\_getMobsForTarget().

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

Here is the caller graph for this function:

◆ _resolveMapAreaLinks()

static ilMediaItem::_resolveMapAreaLinks ( $a_mob_id )

static

resolve internal links of all media items of a media object

Parameters

int $a_mob_id media object id

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

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

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

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

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 991 of file class.ilMediaItem.php.

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

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

Here is the call graph for this function:

◆ addMapArea()

ilMediaItem::addMapArea ( & $a_map_area )

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

References $map_cnt.

Referenced by read().

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

Here is the caller graph for this function:

◆ buildMapWorkImage()

ilMediaItem::buildMapWorkImage ( )

build image map work image

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

References getMapWorkCopyName(), and getMapWorkCopyType().

Referenced by addAreaToMapWorkCopy(), and makeMapWorkCopy().

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

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 716 of file class.ilMediaItem.php.

Referenced by ilMediaAliasItem\setParameters().

     {
         // 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;
     }

Here is the caller graph for this function:

◆ copyOriginal()

ilMediaItem::copyOriginal ( )

Copy the orginal file.

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

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

Referenced by makeMapWorkCopy().

     {
         $lng = $this->lng;
         $this->createWorkDirectory();
 
         $geom = ($this->getWidth() != "" && $this->getHeight() != "")
             ? $this->getWidth() . "x" . $this->getHeight()
             : "";
 
         if ($this->getLocationType() != "Reference") {
             ilUtil::convertImage(
                 $this->getDirectory() . "/" . $this->getLocation(),
                 $this->getMapWorkCopyName(),
                 $this->getMapWorkCopyType(),
                 $geom
             );
         } 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(),
                 $geom
             );
         }
 
         if (!is_file($this->getMapWorkCopyName())) {
             ilUtil::sendFailure($lng->txt("cont_map_file_not_generated"));
             return false;
         }
         return true;
     }

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 172 of file class.ilMediaItem.php.

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

     {
         $ilDB = $this->db;
 
         $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, upload_hash, duration) 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->quote($this->getUploadHash(), "text") . "," .
             $ilDB->quote($this->getDuration(), "integer") .
             ")";
         $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();
             }
         }
     }

Here is the call graph for this function:

◆ createWorkDirectory()

ilMediaItem::createWorkDirectory ( )

create work directory for image map editing

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

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

Referenced by copyOriginal().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAllItemsOfMob()

static ilMediaItem::deleteAllItemsOfMob ( $a_mob_id )

static

Delete all items of a mob.

Parameters

int $a_mob_id media object id

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

References $DIC, $ilDB, and $query.

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

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

Here is the caller graph for this function:

◆ deleteMapArea()

ilMediaItem::deleteMapArea ( $nr )

delete map area

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

References $i, $map_cnt, and $nr.

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

◆ determineDuration()

ilMediaItem::determineDuration ( )

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

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

     {
         $ana = new ilMediaAnalyzer();
         $ana->setFile(ilObjMediaObject::_getDirectory($this->getMobId()) . "/" . $this->getLocation());
         $ana->analyzeFile();
         $this->setDuration((int) $ana->getPlaytimeSeconds());
     }

Here is the call graph for this function:

◆ extractUrlParameters()

ilMediaItem::extractUrlParameters ( )

Extract parameters of special external references to parameter array.

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

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

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

Here is the call graph for this function:

◆ getCaption()

ilMediaItem::getCaption ( )

get caption

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

References $caption.

Referenced by create(), and update().

     {
         return $this->caption;
     }

Here is the caller graph for this function:

◆ getDirectory()

ilMediaItem::getDirectory ( )

get media file directory

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

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

Referenced by copyOriginal(), and getThumbnailTarget().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDuration()

ilMediaItem::getDuration ( )

Get duration.

Returns: int duration

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

References $duration.

Referenced by create(), and update().

     {
         return $this->duration;
     }

Here is the caller graph for this function:

◆ getFormat()

ilMediaItem::getFormat ( )

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

References $format.

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

     {
         return $this->format;
     }

Here is the caller graph for this function:

◆ getHAlign()

ilMediaItem::getHAlign ( )

get horizontal align

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

References $halign.

Referenced by create(), and update().

     {
         return $this->halign;
     }

Here is the caller graph for this function:

◆ getHeight()

ilMediaItem::getHeight ( )

get height

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

References $height.

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

     {
         return $this->height;
     }

Here is the caller graph for this function:

◆ getId()

ilMediaItem::getId ( )

get media item id

Returns: int media item id

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

References $id.

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

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getLocation()

ilMediaItem::getLocation ( )

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

References $location.

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

     {
         return $this->location;
     }

Here is the caller graph for this function:

◆ getLocationType()

ilMediaItem::getLocationType ( )

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

References $location_type.

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

     {
         return $this->location_type;
     }

Here is the caller graph for this function:

◆ getMapArea()

& ilMediaItem::getMapArea ( $nr )

get map area

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

References $nr.

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

◆ getMapAreas()

ilMediaItem::getMapAreas ( )

get map areas

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

References $mapareas.

     {
         return $this->mapareas;
     }

◆ getMapAreasXML()

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

get xml code of media items' areas

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

References $i, $xml, and IL_INT_LINK.

     {
         $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=\"" .
                     str_replace("&", "&amp;", $area->getExtTitle()) . "\">";
                 $xml .= str_replace("&", "&amp;", $area->getTitle());
                 $xml .= "</ExtLink>";
             }
             $xml .= "</MapArea>";
         }
         return $xml;
     }

◆ 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 802 of file class.ilMediaItem.php.

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

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

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

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 793 of file class.ilMediaItem.php.

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

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

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

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 1097 of file class.ilMediaItem.php.

References $map_image.

Referenced by addAreaToMapWorkCopy(), and makeMapWorkCopy().

     {
         return $this->map_image;
     }

Here is the caller graph for this function:

◆ getMediaItemsForUploadHash()

static ilMediaItem::getMediaItemsForUploadHash ( $a_hash )

static

Get media items for upload hash.

Parameters

string $a_hash upload hash

Returns: array

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

References $db, and $DIC.

Referenced by ilObjMediaPoolGUI\editTitlesAndDescriptions(), and ilObjMediaPoolGUI\saveTitlesAndDescriptions().

     {
         global $DIC;
 
         $db = $DIC->database();
 
         $set = $db->queryF(
             "SELECT * FROM media_item " .
             " WHERE upload_hash = %s ",
             array("text"),
             array($a_hash)
         );
         $media_items = array();
         while ($rec = $db->fetchAssoc($set)) {
             $media_items[] = $rec;
         }
         return $media_items;
     }

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 97 of file class.ilMediaItem.php.

References $mob_id.

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

     {
         return $this->mob_id;
     }

Here is the caller graph for this function:

◆ getNr()

ilMediaItem::getNr ( )

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

References $nr.

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

     {
         return $this->nr;
     }

Here is the caller graph for this function:

◆ getOriginalSize()

ilMediaItem::getOriginalSize ( )

get original size

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

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

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

Here is the call graph for this function:

◆ getParameter()

ilMediaItem::getParameter ( $a_name )

get a single parameter

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

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

◆ getParameters()

ilMediaItem::getParameters ( )

get all parameters (in array)

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

References $parameters.

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

     {
         return $this->parameters;
     }

Here is the caller graph for this function:

◆ getParameterString()

ilMediaItem::getParameterString ( )

get all parameters (as string)

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

References ilUtil\assembleParameterString().

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

Here is the call graph for this function:

◆ getPurpose()

ilMediaItem::getPurpose ( )

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

References $purpose.

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

     {
         return $this->purpose;
     }

Here is the caller graph for this function:

◆ getSuffix()

ilMediaItem::getSuffix ( )

get location suffix

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

References getLocation().

Referenced by getMapWorkCopyType().

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

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 146 of file class.ilMediaItem.php.

Referenced by create(), and update().

     {
         return $this->text_representation;
     }

Here is the caller graph for this function:

◆ getThumbnailDirectory()

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

get media file directory

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

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

Referenced by getThumbnailTarget().

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

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 836 of file class.ilMediaItem.php.

References $format, ilObjMediaObject\_createThumbnailDirectory(), ilObjMediaObject\_getURL(), getDirectory(), getFormat(), getLocation(), getLocationType(), getMobId(), getPurpose(), getThumbnailDirectory(), getThumbTried(), and writeThumbTried().

     {
         $jpeg_file = $this->getThumbnailDirectory() . "/" .
             $this->getPurpose() . ".jpeg";
         $format = "png";
         if (is_file($jpeg_file)) {
             $format = "jpeg";
         }
         if (is_int(strpos($this->getFormat(), "image"))) {
             $thumb_file = $this->getThumbnailDirectory() . "/" .
                 $this->getPurpose() . "." . $format;
             $thumb_file_small = $this->getThumbnailDirectory() . "/" .
                 $this->getPurpose() . "_small." . $format;
             // generate thumbnail (if not tried before)
             if ($this->getThumbTried() == "n" && $this->getLocationType() == "LocalFile" && $this->getFormat() !== "image/svg+xml") {
                 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)) {
                     $mob = new ilObjMediaObject($this->getMobId());
                     $mob->makeThumbnail($this->getLocation(), $this->getPurpose() . "." . $format, $format, "80");
                     $mob->makeThumbnail($this->getLocation(), $this->getPurpose() . "_small." . $format, $format, "40");
                 }
             }
             if ($this->getFormat() === "image/svg+xml") {
                 return ilObjMediaObject::_getURL($this->getMobId()) . "/" . $this->getLocation();
             }
             if ($a_size == "small") {
                 if (is_file($thumb_file_small)) {
                     $random = new \ilRandom();
                     return $this->getThumbnailDirectory("output") . "/" .
                         $this->getPurpose() . "_small." . $format . "?dummy=" . $random->int(1, 999999);
                 }
             } else {
                 if (is_file($thumb_file)) {
                     $random = new \ilRandom();
                     return $this->getThumbnailDirectory("output") . "/" .
                         $this->getPurpose() . "." . $format . "?dummy=" . $random->int(1, 999999);
                 }
             }
         }
 
         return "";
     }

Here is the call graph for this function:

◆ getThumbTried()

ilMediaItem::getThumbTried ( )

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

Referenced by getThumbnailTarget().

     {
         return $this->tried_thumb;
     }

Here is the caller graph for this function:

◆ getUploadHash()

ilMediaItem::getUploadHash ( )

Get upload hash.

Returns: string upload hash

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

References $upload_hash.

Referenced by create(), and update().

     {
         return $this->upload_hash;
     }

Here is the caller graph for this function:

◆ getWidth()

ilMediaItem::getWidth ( )

get width

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

References $width.

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

     {
         return $this->width;
     }

Here is the caller graph for this function:

◆ getWorkDirectory()

ilMediaItem::getWorkDirectory ( )

get work directory for image map editing

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

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

Referenced by createWorkDirectory(), and getMapWorkCopyName().

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

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 943 of file class.ilMediaItem.php.

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

     {
         $lng = $this->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;
     }

Here is the call graph for this function:

◆ outputMapWorkCopy()

ilMediaItem::outputMapWorkCopy ( )

output raw map work copy file

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

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

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

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 278 of file class.ilMediaItem.php.

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

Referenced by __construct().

     {
         $ilDB = $this->db;
 
         $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");
         } elseif ($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"]);
             $this->setUploadHash($item_rec["upload_hash"]);
             $this->setDuration((int) $item_rec["duration"]);
 
             // 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);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetParameters()

ilMediaItem::resetParameters ( )

reset parameters

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

Referenced by setParameters().

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

Here is the caller graph for this function:

◆ saveMapWorkImage()

ilMediaItem::saveMapWorkImage ( )

save image map work image

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

References getMapWorkCopyName(), and getMapWorkCopyType().

Referenced by addAreaToMapWorkCopy(), and makeMapWorkCopy().

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

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 646 of file class.ilMediaItem.php.

Referenced by read().

     {
         $this->caption = $a_caption;
     }

Here is the caller graph for this function:

◆ setDuration()

ilMediaItem::setDuration ( $a_val )

Set duration.

Parameters

int $a_val duration

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

Referenced by determineDuration(), and read().

     {
         $this->duration = $a_val;
     }

Here is the caller graph for this function:

◆ setFormat()

ilMediaItem::setFormat ( $a_format )

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

Referenced by read().

     {
         $this->format = $a_format;
     }

Here is the caller graph for this function:

◆ setHAlign()

ilMediaItem::setHAlign ( $a_halign )

set horizontal align

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

Referenced by read().

     {
         $this->halign = $a_halign;
     }

Here is the caller graph for this function:

◆ setHeight()

ilMediaItem::setHeight ( $a_height )

set height

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

Referenced by read().

     {
         $this->height = $a_height;
     }

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 70 of file class.ilMediaItem.php.

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

     {
         $this->id = $a_id;
     }

Here is the caller graph for this function:

◆ setLocation()

ilMediaItem::setLocation ( $a_location )

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

Referenced by read().

     {
         $this->location = $a_location;
     }

Here is the caller graph for this function:

◆ setLocationType()

ilMediaItem::setLocationType ( $a_type )

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

Referenced by read().

     {
         $this->location_type = $a_type;
     }

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 88 of file class.ilMediaItem.php.

Referenced by read().

     {
         $this->mob_id = $a_mob_id;
     }

Here is the caller graph for this function:

◆ setNr()

ilMediaItem::setNr ( $a_nr )

set number of media item within media object

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

Referenced by read().

     {
         $this->nr = $a_nr;
     }

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 680 of file class.ilMediaItem.php.

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

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

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 699 of file class.ilMediaItem.php.

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

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

Here is the call graph for this function:

◆ setPurpose()

ilMediaItem::setPurpose ( $a_purpose )

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

Referenced by read().

     {
         $this->purpose = $a_purpose;
     }

Here is the caller graph for this function:

◆ setTextRepresentation()

ilMediaItem::setTextRepresentation ( $a_val )

Set text representation.

Parameters

string text representation

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

Referenced by read().

     {
         $this->text_representation = $a_val;
     }

Here is the caller graph for this function:

◆ setThumbTried()

ilMediaItem::setThumbTried ( $a_tried )

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

Referenced by read().

     {
         $this->tried_thumb = $a_tried;
     }

Here is the caller graph for this function:

◆ setUploadHash()

ilMediaItem::setUploadHash ( $a_val )

Set upload hash.

Parameters

string $a_val upload hash

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

Referenced by read().

     {
         $this->upload_hash = $a_val;
     }

Here is the caller graph for this function:

◆ setWidth()

ilMediaItem::setWidth ( $a_width )

set width

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

Referenced by read().

     {
         $this->width = $a_width;
     }

Here is the caller graph for this function:

◆ update()

ilMediaItem::update ( )

update media item data (without map areas!)

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

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

     {
         $ilDB = $this->db;
 
         $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") . "," .
             " upload_hash = " . $ilDB->quote($this->getUploadHash(), "text") . "," .
             " duration = " . $ilDB->quote($this->getDuration(), "integer") .
             " 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);
         }
     }

Here is the call graph for this function:

◆ writeParameter()

ilMediaItem::writeParameter	(	$a_name,
		$a_value
	)

Write parameter.

Parameters

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

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

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

Here is the call graph for this function:

◆ writeThumbTried()

ilMediaItem::writeThumbTried ( $a_tried )

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

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

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

Referenced by getThumbnailTarget().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $caption

ilMediaItem::$caption

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

Referenced by getCaption().

◆ $color1

ilMediaItem::$color1

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

◆ $color2

ilMediaItem::$color2

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

◆ $db

ilMediaItem::$db

protected

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

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

◆ $duration

ilMediaItem::$duration = 0

protected

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

Referenced by getDuration().

◆ $format

ilMediaItem::$format

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

Referenced by getFormat(), and getThumbnailTarget().

◆ $halign

ilMediaItem::$halign

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

Referenced by getHAlign().

◆ $height

ilMediaItem::$height

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

Referenced by getHeight().

◆ $id

ilMediaItem::$id

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

Referenced by getId().

◆ $lng

ilMediaItem::$lng

protected

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

Referenced by copyOriginal(), and makeMapWorkCopy().

◆ $location

ilMediaItem::$location

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

Referenced by getLocation().

◆ $location_type

ilMediaItem::$location_type

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

Referenced by getLocationType().

◆ $map_cnt

ilMediaItem::$map_cnt

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

Referenced by addMapArea(), and deleteMapArea().

◆ $map_image

ilMediaItem::$map_image

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

Referenced by getMapWorkImage().

◆ $mapareas

ilMediaItem::$mapareas

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

Referenced by getMapAreas().

◆ $mob_id

ilMediaItem::$mob_id

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

Referenced by getMobId(), and read().

◆ $nr

ilMediaItem::$nr

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

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

◆ $parameters

ilMediaItem::$parameters

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

Referenced by getParameters().

◆ $purpose

ilMediaItem::$purpose

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

Referenced by getPurpose().

◆ $upload_hash

ilMediaItem::$upload_hash

protected

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

Referenced by getUploadHash().

◆ $width

ilMediaItem::$width

Definition at line 30 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

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getMapAreasIntLinks()

◆ _getMediaItemsOfMOb()

◆ _getMediaItemsOfMObId()

◆ _lookupLocationForMobId()

◆ _lookupMobId()

◆ _resolveMapAreaLinks()

◆ addAreaToMapWorkCopy()

◆ addMapArea()

◆ buildMapWorkImage()

◆ checkParameter()

◆ copyOriginal()

◆ create()

◆ createWorkDirectory()

◆ deleteAllItemsOfMob()

◆ deleteMapArea()

◆ determineDuration()

◆ extractUrlParameters()

◆ getCaption()

◆ getDirectory()

◆ getDuration()

◆ getFormat()

◆ getHAlign()

◆ getHeight()

◆ getId()

◆ getLocation()

◆ getLocationType()

◆ getMapArea()

◆ getMapAreas()

◆ getMapAreasXML()

◆ getMapWorkCopyName()

◆ getMapWorkCopyType()

◆ getMapWorkImage()

◆ getMediaItemsForUploadHash()

◆ getMobId()

◆ getNr()

◆ getOriginalSize()

◆ getParameter()

◆ getParameters()

◆ getParameterString()

◆ getPurpose()

◆ getSuffix()

◆ getTextRepresentation()

◆ getThumbnailDirectory()

◆ getThumbnailTarget()

◆ getThumbTried()

◆ getUploadHash()

◆ getWidth()

◆ getWorkDirectory()

◆ makeMapWorkCopy()

◆ outputMapWorkCopy()

◆ read()

◆ resetParameters()

◆ saveMapWorkImage()

◆ setCaption()

◆ setDuration()

◆ setFormat()

◆ setHAlign()

◆ setHeight()

◆ setId()

◆ setLocation()

◆ setLocationType()

◆ setMobId()

◆ setNr()

◆ setParameter()

◆ setParameters()

◆ setPurpose()

◆ setTextRepresentation()

◆ setThumbTried()

◆ setUploadHash()

◆ setWidth()

◆ update()

◆ writeParameter()