ilMediaItem Class Reference

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

Collaboration diagram for ilMediaItem:

Public Member Functions
	__construct (int $a_id=0)
	setId (int $a_id)
	set media item id More...
	getId ()
	setMobId (int $a_mob_id)
	set id of parent media object More...
	getMobId ()
	setNr (int $a_nr)
	set number of media item within media object More...
	getNr ()
	setDuration (int $a_val)
	getDuration ()
	setTextRepresentation (string $a_val)
	getTextRepresentation ()
	setUploadHash (string $a_val)
	getUploadHash ()
	create ()
	update ()
	writeParameter (string $a_name, string $a_value)
	read ()
	read media item data (item id or (mob_id and nr) must be set) More...
	writeThumbTried (string $a_tried)
	write thumbnail creation try data ("y"/"n") More...
	setPurpose (string $a_purpose)
	getPurpose ()
	setLocation (string $a_location)
	getLocation ()
	setLocationType (string $a_type)
	getLocationType ()
	setFormat (string $a_format)
	getFormat ()
	setThumbTried (string $a_tried)
	getThumbTried ()
	addMapArea (ilMapArea $a_map_area)
	deleteMapArea (int $nr)
	getMapArea (int $nr)
	getMapAreas ()
	getWidth ()
	setWidth (string $a_width)
	getHeight ()
	setHeight (string $a_height)
	getOriginalSize ()
	setCaption (string $a_caption)
	getCaption ()
	setHAlign (string $a_halign)
	set horizontal align More...
	getHAlign ()
	setParameter (string $a_name, string $a_value)
	resetParameters ()
	setParameters (string $a_par)
	set all parameters via parameter string (format: par1="value1", par2="value2", ...) More...
	getParameters ()
	getParameterString ()
	getParameter (string $a_name)
	getSuffix ()
	get location suffix More...
	getMapWorkCopyType ()
	get image type of image map work copy More...
	getDirectory ()
	get media file directory More...
	getOriginalSource ()
	makeMapWorkCopy (int $a_area_nr=0, bool $a_exclude=false)
	make map work copy of image More...
	addAreaToMapWorkCopy (string $a_shape, string $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...
	outputWorkImage ()
	getMapWorkImage ()
	getMapAreasXML (bool $a_insert_inst=false, int $a_inst=0)
	get xml code of media items' areas More...
	extractUrlParameters ()
	Extract parameters of special external references to parameter array. More...
	determineDuration ()
	getLocationSrc (bool $autoplay=false)
	getLocationStream ()

Static Public Member Functions
static	_lookupLocationForMobId (int $a_mob_id, string $a_purpose)
static	_lookupMobId (int $a_med_id)
static	_getMediaItemsOfMObId (int $a_mobId, string $a_purpose)
	read media item with specific purpose and mobId More...
static	_getMediaItemsOfMOb (ilObjMediaObject $a_mob)
	Read media items into(!) media object (static) More...
static	deleteAllItemsOfMob (int $a_mob_id)
static	checkParameter (string $a_par, string $a_val)
	Check parameter (filter javascript related and other unsafe parameters/values) More...
static	_resolveMapAreaLinks (int $a_mob_id)
	resolve internal links of all media items of a media object More...
static	_getMapAreasIntLinks (int $a_mob_id)
	get all internal links of map areas of a mob More...
static	getMediaItemsForUploadHash (string $a_hash)
	Get media items for upload hash. More...

Data Fields
int	$id = 0
string	$purpose = ""
string	$location = ""
string	$location_type = ""
string	$format = ""
string	$width = ""
string	$height = ""
string	$caption = ""
string	$halign = ""
array	$parameters = []
int	$mob_id = 0
int	$nr = 0
array	$mapareas = []
int	$map_cnt = 0
	$map_image = null
int	$color1
int	$color2

Protected Attributes
ILIAS MediaObjects MediaObjectManager	$mob_manager
string	$tried_thumb = ""
string	$text_representation = ""
ilDBInterface	$db
ilLanguage	$lng
ILIAS Filesystem Util Convert LegacyImages	$image_converter
int	$duration = 0
string	$upload_hash = ''

Static Private Member Functions
static	getGDSupportedImageType (string $a_desired_type)
	returns the best supported image type by this PHP build More...

Detailed Description

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

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilMediaItem::__construct

(

int

$a_id = 0

)

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

References $DIC, ILIAS\Repository\lng(), ILIAS\UI\examples\Prompt\Standard\parameters(), read(), and setId().

      {
        global $DIC;

        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->image_converter = $DIC->fileConverters()->legacyImages();
        $this->parameters = array();
        $this->mapareas = array();
        $this->map_cnt = 0;

        if ($a_id != 0) {
            $this->setId($a_id);
            $this->read();
        }
        $this->mob_manager = $DIC->mediaObjects()->internal()->domain()->mediaObject();
    }

Here is the call graph for this function:

Member Function Documentation

_getMapAreasIntLinks()

static ilMediaItem::_getMapAreasIntLinks ( int  $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 991 of file class.ilMediaItem.php.

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

Referenced by ilPageObjectGUI\displayMedia(), ilCOPageHTMLExport\exportHTMLMOB(), ILIAS\Data\Link\LinkManager\getDefaultMediaCollector(), ilLMPresentationGUI\ilMedia(), and ilGlossaryPresentationGUI\media().

     : array {
        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 ( ilObjMediaObject  $a_mob )

static

Read media items into(!) media object (static)

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

References $DIC, $ilDB, ilMapArea\_getMaxNr(), ilObjMediaObject\addMediaItem(), and ilObject\getId().

Referenced by ilObjMediaObject\read().

     : void {
        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((int) $item_rec["nr"]);
            $media_item->setId((int) $item_rec["id"]);
            $media_item->setLocation((string) $item_rec["location"]);
            $media_item->setLocationType((string) $item_rec["location_type"]);
            $media_item->setFormat((string) $item_rec["format"]);
            $media_item->setWidth((string) $item_rec["width"]);
            $media_item->setHeight((string) $item_rec["height"]);
            $media_item->setHAlign((string) $item_rec["halign"]);
            $media_item->setCaption((string) $item_rec["caption"]);
            $media_item->setPurpose((string) $item_rec["purpose"]);
            $media_item->setMobId((int) $item_rec["mob_id"]);
            $media_item->setThumbTried((string) $item_rec["tried_thumb"]);
            $media_item->setTextRepresentation((string) $item_rec["text_representation"]);
            $media_item->setUploadHash((string) $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 ( int  $a_mobId, string  $a_purpose  )

static

read media item with specific purpose and mobId

Parameters

int	$a_mobId
string	$a_purpose

Returns

?ilMediaItem[]

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

References $DIC, $ilDB, and null.

Referenced by ilObjectFeedWriter\__construct().

     : ?array {
        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 null;
    }

Here is the caller graph for this function:

_lookupLocationForMobId()

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

static

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

References $DIC, and $ilDB.

Referenced by ilObjMediaObject\_lookupItemPath().

     : string {
        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 ( int  $a_med_id )

static

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

References $DIC, and $ilDB.

Referenced by ilMapArea\_getMobsForTarget().

     : int {
        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 (int) $rec["mob_id"];
        }

        return 0;
    }

Here is the caller graph for this function:

_resolveMapAreaLinks()

static ilMediaItem::_resolveMapAreaLinks ( int  $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 969 of file class.ilMediaItem.php.

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

Referenced by ilQuestionPageParser\processPagesToParse(), and ILIAS\Data\Link\LinkManager\resolveIntLinks().

     : void {
        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	(	string	$a_shape,
		string	$a_coords
	)

draw a new area in work image

Parameters

string	$a_shape	shape
string	$a_coords	coordinates string

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

References getHeight(), getMapWorkImage(), getOriginalSource(), and getWidth().

     : void {
        //        $this->buildMapWorkImage();

        // determine ratios
        $size = getimagesize($this->getOriginalSource());
        $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
        );
    }

Here is the call graph for this function:

addMapArea()

ilMediaItem::addMapArea

(

ilMapArea

$a_map_area

)

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

References $map_cnt.

Referenced by read().

                                                     : void
    {
        $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 856 of file class.ilMediaItem.php.

References getMapWorkCopyType(), and getOriginalSource().

Referenced by makeMapWorkCopy(), and ilMediaAliasItem\makeMapWorkCopy().

                                       : void
    {
        $im_type = strtolower($this->getMapWorkCopyType());

        switch ($im_type) {
            case "gif":
                $this->map_image = imagecreatefromgif($this->getOriginalSource());
                break;

            case "jpg":
            case "jpeg":
                $this->map_image = imagecreatefromjpeg($this->getOriginalSource());
                break;

            case "png":
                $this->map_image = imagecreatefrompng($this->getOriginalSource());
                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 ( string  $a_par, string  $a_val  )

static

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

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

Referenced by ilMediaAliasItem\setParameters().

     : bool {
        // 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 (strtolower(trim($a_par)) == "src") {
            return false;
        }

        return true;
    }

Here is the caller graph for this function:

create()

ilMediaItem::create

(

)

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

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

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

deleteAllItemsOfMob()

static ilMediaItem::deleteAllItemsOfMob ( int  $a_mob_id )

static

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

References $DIC, and $ilDB.

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

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

(

int

$nr

)

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

References $map_cnt.

                                          : void
    {
        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 1027 of file class.ilMediaItem.php.

References Vendor\Package\$e, ilExternalMediaAnalyzer\extractVimeoParameters(), getLocation(), getLocationSrc(), ilExternalMediaAnalyzer\getVimeoMetadata(), ilFileUtils\ilTempnam(), ilExternalMediaAnalyzer\isVimeo(), ilFileUtils\makeDir(), and setDuration().

Referenced by ilObjMediaCastGUI\getDuration().

                                       : void
    {
        $ana = new ilMediaAnalyzer();

        if (ilExternalMediaAnalyzer::isVimeo($this->getLocation())) {
            $par = ilExternalMediaAnalyzer::extractVimeoParameters($this->getLocation());
            $meta = ilExternalMediaAnalyzer::getVimeoMetadata($par["id"]);
            if ($meta["duration"] > 0) {
                $this->setDuration((int) $meta["duration"]);
            }
        } else {
            $file = $this->getLocationSrc();

            $remote = false;

            try {
                if (substr($file, 0, 4) == "http") {
                    if ($fp_remote = fopen($file, 'rb')) {
                        $tmpdir = ilFileUtils::ilTempnam();
                        ilFileUtils::makeDir($tmpdir);
                        $localtempfilename = tempnam($tmpdir, 'getID3');
                        if ($fp_local = fopen($localtempfilename, 'wb')) {
                            while ($buffer = fread($fp_remote, 8192)) {
                                fwrite($fp_local, $buffer);
                            }
                            fclose($fp_local);
                            $file = $localtempfilename;
                        }
                        fclose($fp_remote);
                    }
                }

                $ana->setFile($file);
                $ana->analyzeFile();
                $this->setDuration((int) $ana->getPlaytimeSeconds());

                if ($remote) {
                    unlink($localtempfilename);
                }
            } catch (Exception $e) {
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

extractUrlParameters()

ilMediaItem::extractUrlParameters

(

)

Extract parameters of special external references to parameter array.

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

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

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

(

)

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

References $caption.

Referenced by create(), and update().

                                : string
    {
        return $this->caption;
    }

Here is the caller graph for this function:

getDirectory()

ilMediaItem::getDirectory

(

)

get media file directory

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

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

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

Here is the call graph for this function:

getDuration()

ilMediaItem::getDuration

(

)

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

References $duration.

Referenced by create(), ilObjMediaCastGUI\getDuration(), and update().

                                 : int
    {
        return $this->duration;
    }

Here is the caller graph for this function:

getFormat()

ilMediaItem::getFormat

(

)

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

References $format.

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

                               : string
    {
        return $this->format;
    }

Here is the caller graph for this function:

getGDSupportedImageType()

static ilMediaItem::getGDSupportedImageType ( string  $a_desired_type )

staticprivate

returns the best supported image type by this PHP build

Parameters

string

$a_desired_type

Returns

string supported image type ("jpg" | "gif" | "png" | "")

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

                                                                           : string
    {
        $a_desired_type = strtolower($a_desired_type);
        // get supported Image Types
        $im_types = ImageTypes();

        switch ($a_desired_type) {
            case "jpg":
            case "jpeg":
                if ($im_types & IMG_JPG) {
                    return "jpg";
                }
                if ($im_types & IMG_GIF) {
                    return "gif";
                }
                if ($im_types & IMG_PNG) {
                    return "png";
                }
                break;

            case "gif":
                if ($im_types & IMG_GIF) {
                    return "gif";
                }
                if ($im_types & IMG_JPG) {
                    return "jpg";
                }
                if ($im_types & IMG_PNG) {
                    return "png";
                }
                break;

            case "svg":
            case "png":
                if ($im_types & IMG_PNG) {
                    return "png";
                }
                if ($im_types & IMG_JPG) {
                    return "jpg";
                }
                if ($im_types & IMG_GIF) {
                    return "gif";
                }
                break;
        }

        return "";
    }

getHAlign()

ilMediaItem::getHAlign

(

)

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

References $halign.

Referenced by create(), and update().

                               : string
    {
        return $this->halign;
    }

Here is the caller graph for this function:

getHeight()

ilMediaItem::getHeight

(

)

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

References $height.

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

                               : string
    {
        return $this->height;
    }

Here is the caller graph for this function:

getId()

ilMediaItem::getId

(

)

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

References $id.

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

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getLocation()

ilMediaItem::getLocation

(

)

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

References $location.

Referenced by create(), determineDuration(), extractUrlParameters(), getLocationSrc(), getLocationStream(), getOriginalSource(), getSuffix(), update(), and ilObjMediaCastGUI\updateMediaItem().

                                 : string
    {
        return $this->location;
    }

Here is the caller graph for this function:

getLocationSrc()

ilMediaItem::getLocationSrc

(

bool

$autoplay = false

)

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

References $params, ilExternalMediaAnalyzer\extractVimeoParameters(), ilExternalMediaAnalyzer\extractYouTubeParameters(), getFormat(), getLocation(), getLocationType(), and getMobId().

Referenced by determineDuration().

                                                          : string
    {
        if (strcasecmp("Reference", $this->getLocationType()) === 0) {
            $src = $this->getLocation();
            if ($this->getFormat() === "video/vimeo") {
                $params = "";
                if ($autoplay) {
                    $params = "&autoplay=1&muted=1";
                }
                $par = ilExternalMediaAnalyzer::extractVimeoParameters($src);
                $src = "//player.vimeo.com/video/" . $par["id"] . "?api=1" . $params;
            }
            if ($this->getFormat() === "video/youtube") {
                $params = "";
                if ($autoplay) {
                    $params = "&autoplay=1&muted=1";
                }
                $par = ilExternalMediaAnalyzer::extractYouTubeParameters($src);
                $src = "//www.youtube.com/embed/" . $par["v"] . "?enablejsapi=1" . $params;
            }
        } else {
            $src = $this->mob_manager->getLocalSrc(
                $this->getMobId(),
                $this->getLocation()
            );
        }
        return $src;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLocationStream()

ilMediaItem::getLocationStream

(

)

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

References getLocation(), and getMobId().

                                       : ZIPStream
    {
        return $this->mob_manager->getLocationStream(
            $this->getMobId(),
            $this->getLocation()
        );
    }

Here is the call graph for this function:

getLocationType()

ilMediaItem::getLocationType

(

)

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

References $location_type.

Referenced by create(), getLocationSrc(), getOriginalSource(), update(), and ilObjMediaCastGUI\updateMediaItem().

                                     : string
    {
        return $this->location_type;
    }

Here is the caller graph for this function:

getMapArea()

ilMediaItem::getMapArea

(

int

$nr

)

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

References null.

                                       : ?ilMapArea
    {
        return $this->mapareas[$nr - 1] ?? null;
    }

getMapAreas()

ilMediaItem::getMapAreas

(

)

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

References $mapareas.

                                 : array
    {
        return $this->mapareas;
    }

getMapAreasXML()

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

get xml code of media items' areas

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

References IL_INT_LINK.

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

getMapWorkCopyType()

ilMediaItem::getMapWorkCopyType

(

)

get image type of image map work copy

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

References getSuffix().

Referenced by buildMapWorkImage(), outputMapWorkCopy(), and outputWorkImage().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getMapWorkImage()

ilMediaItem::getMapWorkImage

(

)

Returns

GdImage|resource|null

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

References $map_image.

Referenced by addAreaToMapWorkCopy(), makeMapWorkCopy(), and ilMediaAliasItem\makeMapWorkCopy().

    {
        return $this->map_image;
    }

Here is the caller graph for this function:

getMediaItemsForUploadHash()

static ilMediaItem::getMediaItemsForUploadHash ( string  $a_hash )

static

Get media items for upload hash.

Parameters

string

$a_hash

upload hash

Returns

array[]

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

References $DIC, ilDBInterface\fetchAssoc(), and ilDBInterface\queryF().

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

     : array {
        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 call graph for this function:

Here is the caller graph for this function:

getMobId()

ilMediaItem::getMobId

(

)

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

References $mob_id.

Referenced by create(), getDirectory(), getLocationSrc(), getLocationStream(), getOriginalSource(), read(), and update().

                              : int
    {
        return $this->mob_id;
    }

Here is the caller graph for this function:

getNr()

ilMediaItem::getNr

(

)

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

References $nr.

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

                           : int
    {
        return $this->nr;
    }

Here is the caller graph for this function:

getOriginalSize()

ilMediaItem::getOriginalSize

(

)

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

References ilUtil\deducibleSize(), getFormat(), ilMediaImageUtil\getImageSize(), getOriginalSource(), and null.

                                     : ?array
    {
        if (ilUtil::deducibleSize($this->getFormat())) {
            $loc = $this->getOriginalSource();
            $size = ilMediaImageUtil::getImageSize($loc);
            if ($size[0] > 0 && $size[1] > 0) {
                return array("width" => $size[0], "height" => $size[1]);
            }
        }

        return null;
    }

Here is the call graph for this function:

getOriginalSource()

ilMediaItem::getOriginalSource

(

)

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

References getLocation(), getLocationType(), and getMobId().

Referenced by addAreaToMapWorkCopy(), buildMapWorkImage(), getOriginalSize(), makeMapWorkCopy(), and ilMediaAliasItem\makeMapWorkCopy().

                                       : string
    {
        if ($this->getLocationType() !== "Reference") {
            return $this->mob_manager->getLocalSrc(
                $this->getMobId(),
                $this->getLocation()
            );
        }
        return $this->getLocation();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParameter()

ilMediaItem::getParameter

(

string

$a_name

)

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

References ILIAS\UI\examples\Prompt\Standard\parameters().

                                                : string
    {
        return (string) ($this->parameters[$a_name] ?? "");
    }

Here is the call graph for this function:

getParameters()

ilMediaItem::getParameters

(

)

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

References $parameters.

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

                                   : array
    {
        return $this->parameters;
    }

Here is the caller graph for this function:

getParameterString()

ilMediaItem::getParameterString

(

)

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

References ILIAS\UI\examples\Prompt\Standard\parameters().

                                        : string
    {
        if (is_array($this->parameters)) {
            $target_arr = [];
            foreach ($this->parameters as $par => $val) {
                $target_arr[] = "$par=\"$val\"";
            }
            return implode(", ", $target_arr);
        }
        return "";
    }

Here is the call graph for this function:

getPurpose()

ilMediaItem::getPurpose

(

)

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

References $purpose.

Referenced by create(), update(), and ilObjMediaCastGUI\updateMediaItem().

                                : string
    {
        return $this->purpose;
    }

Here is the caller graph for this function:

getSuffix()

ilMediaItem::getSuffix

(

)

get location suffix

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

References getLocation().

Referenced by getMapWorkCopyType().

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

(

)

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

References $text_representation.

Referenced by create(), and update().

                                           : string
    {
        return $this->text_representation;
    }

Here is the caller graph for this function:

getThumbTried()

ilMediaItem::getThumbTried

(

)

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

References $tried_thumb.

                                   : string
    {
        return $this->tried_thumb;
    }

getUploadHash()

ilMediaItem::getUploadHash

(

)

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

References $upload_hash.

Referenced by create(), and update().

                                   : string
    {
        return $this->upload_hash;
    }

Here is the caller graph for this function:

getWidth()

ilMediaItem::getWidth

(

)

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

References $width.

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

                              : string
    {
        return $this->width;
    }

Here is the caller graph for this function:

makeMapWorkCopy()

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

make map work copy of image

Parameters

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

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

References buildMapWorkImage(), getHeight(), getMapWorkImage(), getOriginalSource(), and getWidth().

Referenced by ilImageMapEditorGUI\makeMapWorkCopy().

     : void {
        $this->buildMapWorkImage();

        // determine ratios
        $size = getimagesize($this->getOriginalSource());
        $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
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

outputMapWorkCopy()

ilMediaItem::outputMapWorkCopy

(

)

output raw map work copy file

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

References exit, getMapWorkCopyType(), ILIAS\UI\examples\Symbol\Glyph\Header\header(), and outputWorkImage().

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

Here is the call graph for this function:

outputWorkImage()

ilMediaItem::outputWorkImage

(

)

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

References getMapWorkCopyType().

Referenced by outputMapWorkCopy().

                                     : void
    {
        $im_type = strtolower($this->getMapWorkCopyType());

        // save image work-copy and free memory
        switch ($im_type) {
            case "gif":
                imagegif($this->map_image);
                break;

            case "jpg":
            case "jpeg":
                imagejpeg($this->map_image);
                break;

            case "png":
                imagepng($this->map_image);
                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilMediaItem::read

(

)

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

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

References $db, $ilDB, 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().

                          : void
    {
        $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((string) $item_rec["location"]);
            $this->setLocationType((string) $item_rec["location_type"]);
            $this->setFormat((string) $item_rec["format"]);
            $this->setWidth((string) $item_rec["width"]);
            $this->setHeight((string) $item_rec["height"]);
            $this->setHAlign((string) $item_rec["halign"]);
            $this->setCaption((string) $item_rec["caption"]);
            $this->setPurpose((string) $item_rec["purpose"]);
            $this->setNr((int) $item_rec["nr"]);
            $this->setMobId((int) $item_rec["mob_id"]);
            $this->setId((int) $item_rec["id"]);
            $this->setThumbTried((string) $item_rec["tried_thumb"]);
            $this->setTextRepresentation((string) $item_rec["text_representation"]);
            $this->setUploadHash((string) $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

(

)

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

References ILIAS\UI\examples\Prompt\Standard\parameters().

Referenced by setParameters().

                                     : void
    {
        $this->parameters = [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCaption()

ilMediaItem::setCaption

(

string

$a_caption

)

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

Referenced by read().

                                                 : void
    {
        $this->caption = $a_caption;
    }

Here is the caller graph for this function:

setDuration()

ilMediaItem::setDuration

(

int

$a_val

)

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

Referenced by determineDuration(), and read().

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

Here is the caller graph for this function:

setFormat()

ilMediaItem::setFormat

(

string

$a_format

)

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

Referenced by read(), and ilObjMediaCastGUI\updateMediaItem().

                                               : void
    {
        $this->format = $a_format;
    }

Here is the caller graph for this function:

setHAlign()

ilMediaItem::setHAlign

(

string

$a_halign

)

set horizontal align

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

Referenced by read(), and ilObjMediaCastGUI\updateMediaItem().

                                               : void
    {
        $this->halign = $a_halign;
    }

Here is the caller graph for this function:

setHeight()

ilMediaItem::setHeight

(

string

$a_height

)

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

Referenced by read(), and ilObjMediaCastGUI\updateMediaItem().

                                               : void
    {
        $this->height = $a_height;
    }

Here is the caller graph for this function:

setId()

ilMediaItem::setId

(

int

$a_id

)

set media item id

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

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

                                    : void
    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setLocation()

ilMediaItem::setLocation

(

string

$a_location

)

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

Referenced by read(), and ilObjMediaCastGUI\updateMediaItem().

                                                   : void
    {
        $this->location = $a_location;
    }

Here is the caller graph for this function:

setLocationType()

ilMediaItem::setLocationType

(

string

$a_type

)

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

Referenced by read(), and ilObjMediaCastGUI\updateMediaItem().

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

Here is the caller graph for this function:

setMobId()

ilMediaItem::setMobId

(

int

$a_mob_id

)

set id of parent media object

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

Referenced by read().

                                           : void
    {
        $this->mob_id = $a_mob_id;
    }

Here is the caller graph for this function:

setNr()

ilMediaItem::setNr

(

int

$a_nr

)

set number of media item within media object

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

Referenced by read().

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

Here is the caller graph for this function:

setParameter()

ilMediaItem::setParameter	(	string	$a_name,
		string	$a_value
	)

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

References ILIAS\UI\examples\Prompt\Standard\parameters().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

setParameters()

ilMediaItem::setParameters

(

string

$a_par

)

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

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

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

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

(

string

$a_purpose

)

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

Referenced by read().

                                                 : void
    {
        $this->purpose = $a_purpose;
    }

Here is the caller graph for this function:

setTextRepresentation()

ilMediaItem::setTextRepresentation

(

string

$a_val

)

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

Referenced by read().

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

Here is the caller graph for this function:

setThumbTried()

ilMediaItem::setThumbTried

(

string

$a_tried

)

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

Referenced by read().

                                                  : void
    {
        $this->tried_thumb = $a_tried;
    }

Here is the caller graph for this function:

setUploadHash()

ilMediaItem::setUploadHash

(

string

$a_val

)

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

Referenced by read().

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

Here is the caller graph for this function:

setWidth()

ilMediaItem::setWidth

(

string

$a_width

)

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

Referenced by read().

                                             : void
    {
        $this->width = $a_width;
    }

Here is the caller graph for this function:

update()

ilMediaItem::update

(

)

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

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

                            : void
    {
        $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");
        $ilDB->manipulate($query);

        // 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	(	string	$a_name,
		string	$a_value
	)

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

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

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

(

string

$a_tried

)

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

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

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

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

Field Documentation

$caption

string ilMediaItem::$caption = ""

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

Referenced by getCaption().

$color1

int ilMediaItem::$color1

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

$color2

int ilMediaItem::$color2

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

$db

ilDBInterface ilMediaItem::$db

protected

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

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

$duration

int ilMediaItem::$duration = 0

protected

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

Referenced by getDuration().

$format

string ilMediaItem::$format = ""

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

Referenced by getFormat().

$halign

string ilMediaItem::$halign = ""

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

Referenced by getHAlign().

$height

string ilMediaItem::$height = ""

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

Referenced by getHeight().

$id

int ilMediaItem::$id = 0

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

Referenced by getId().

$image_converter

ILIAS Filesystem Util Convert LegacyImages ilMediaItem::$image_converter

protected

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

$lng

ilLanguage ilMediaItem::$lng

protected

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

$location

string ilMediaItem::$location = ""

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

Referenced by getLocation().

$location_type

string ilMediaItem::$location_type = ""

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

Referenced by getLocationType().

$map_cnt

int ilMediaItem::$map_cnt = 0

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

Referenced by addMapArea(), and deleteMapArea().

$map_image

ilMediaItem::$map_image = null

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

Referenced by getMapWorkImage().

$mapareas

array ilMediaItem::$mapareas = []

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

Referenced by getMapAreas().

$mob_id

int ilMediaItem::$mob_id = 0

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

Referenced by getMobId().

$mob_manager

ILIAS MediaObjects MediaObjectManager ilMediaItem::$mob_manager

protected

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

$nr

int ilMediaItem::$nr = 0

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

Referenced by getNr().

$parameters

array ilMediaItem::$parameters = []

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

Referenced by getParameters().

$purpose

string ilMediaItem::$purpose = ""

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

Referenced by getPurpose().

$text_representation

string ilMediaItem::$text_representation = ""

protected

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

Referenced by getTextRepresentation().

$tried_thumb

string ilMediaItem::$tried_thumb = ""

protected

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

Referenced by getThumbTried().

$upload_hash

string ilMediaItem::$upload_hash = ''

protected

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

Referenced by getUploadHash().

$width

string ilMediaItem::$width = ""

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

Referenced by getWidth().

---

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

• components/ILIAS/MediaObjects/classes/class.ilMediaItem.php