ilObjMediaObject Class Reference

Inheritance diagram for ilObjMediaObject:

Collaboration diagram for ilObjMediaObject:

Public Member Functions
	__construct (int $a_id=0)
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	addMediaItem (ilMediaItem $a_item)
&	getMediaItems ()
	getMediaItem (string $a_purpose)
	get item for media purpose More...
	removeMediaItem (string $a_purpose)
	removeAllMediaItems ()
	hasFullscreenItem ()
	hasPurposeItem (string $purpose)
	returns whether object has media item with specific purpose More...
	read ()
	setAlias (bool $a_is_alias)
	isAlias ()
	setOriginID (string $a_id)
	getOriginID ()
	create (bool $a_create_meta_data=false, bool $a_save_media_items=true, int $from_mob_id=0)
	update (bool $a_upload=false)
	createDirectory ()
	Create file directory of media object. More...
	getFilesOfDirectory (string $dir_path="")
	getXML (int $a_mode=IL_MODE_FULL, int $a_inst=0, bool $a_sign_locals=false, bool $offline=false)
	get MediaObject XLM Tag More...
	handleAmps (string $a_str)
	Replace "&" (if not an "&") with "&". More...
	exportXML (ilXmlWriter $a_xml_writer, int $a_inst=0)
	exportFiles (string $a_target_dir)
	export all media files of object to target directory note: target directory must be the export target directory, "/objects/il_<inst>_mob_<mob_id>/..." will be appended to this directory More...
	modifyExportIdentifier (string $a_tag, string $a_param, string $a_value)
	setContainsIntLink (bool $a_contains_link)
	content parser set this flag to true, if the media object contains internal links (this method should only be called by the import parser) More...
	containsIntLink ()
	returns true, if mob was marked as containing an intern link (via setContainsIntLink) (this method should only be called by the import parser) More...
	getUsages (bool $a_include_history=true)
	get all usages of current media object More...
	getDataDirectory ()
	addMediaItemFromLegacyUpload (string $purpose, string $tmp_name, string $name, int $resize_width=0, int $resize_height=0, bool $constrain_proportions=true, bool $deduce_size=false)
	addMediaItemFromUpload (string $purpose, UploadResult $result, string $upload_hash="",)
	addMediaItemFromLocalFile (string $purpose, string $tmp_name, string $name)
	replaceMediaItemFromUpload (string $purpose, UploadResult $result, string $upload_hash="",)
	uploadAdditionalFile (string $a_name, string $tmp_name, string $a_subdir="", string $a_mode="move_uploaded")
	Create new media object and update page in db and return new media object. More...
	addAdditionalFileFromUpload (UploadResult $result, string $subdir)
	uploadSrtFile (string $a_tmp_name, string $a_language, string $a_mode="move_uploaded")
	getSrtFiles (bool $vtt_only=false)
	makeThumbnail (string $source, string $thumbname,)
	Make thumbnail. More...
	removeAdditionalFile (string $a_file)
	getLinkedMediaObjects (array $a_ignore=[])
	Get all media objects linked in map areas of this media object. More...
	duplicate ()
	Duplicate media object, return new media object. More...
	uploadVideoPreviewPic (array $a_prevpic)
	getVideoPreviewPic (bool $a_filename_only=false)
	getMultiSrtUploadDir ()
	Get directory for multi srt upload. More...
	uploadMultipleSubtitleFile (array $a_file)
	Upload multi srt file. More...
	clearMultiSrtDirectory ()
	Clear multi srt directory. More...
	getMultiSrtFiles ()
	Get all srt files of srt multi upload. More...
	getExternalMetadata ()
	getStandardSrc ()
	getFullscreenSrc ()
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getDirectory (int $a_mob_id)
	Get absolute directory. More...
static	_getRelativeDirectory (int $a_mob_id)
	Get relative (to webspace dir) directory. More...
static	_getURL (int $a_mob_id)
	get directory for files of media object More...
static	_lookupItemPath (int $a_mob_id, bool $a_url_encode=false, bool $a_web=true, string $a_purpose="")
	Get path for item with specific purpose. More...
static	_deleteAllUsages (string $a_type, int $a_id, ?int $a_usage_hist_nr=0, string $a_lang="-")
static	_getMobsOfObject (string $a_type, int $a_id, int|false $a_usage_hist_nr=0, string $a_lang="-")
static	_saveUsage (int $a_mob_id, string $a_type, int $a_id, int $a_usage_hist_nr=0, string $a_lang="-")
	Save usage of mob within another container (e.g. More...
static	_removeUsage (int $a_mob_id, string $a_type, int $a_id, int $a_usage_hist_nr=0, string $a_lang="-")
	Remove usage of mob in another container. More...
static	lookupUsages (int $a_id, bool $a_include_history=true)
	Lookup usages of media object. More...
static	getParentObjectIdForUsage (array $a_usage, bool $a_include_all_access_obj_ids=false)
	Get's the repository object ID of a parent object, if possible see ilWebAccessChecker. More...
static	getMimeType (string $a_file, bool $a_external=false)
	get mime type for file More...
static	_determineWidthHeight (string $a_format, string $a_type, string $a_file, string $a_reference, bool $a_constrain_proportions, bool $a_use_original, ?int $a_user_width=null, ?int $a_user_height=null)
static	_saveTempFileAsMediaObject (string $name, string $tmp_name, bool $upload=true)
static	isTypeAllowed (string $a_type)
static	fixFilename (string $a_name)
	Fix filename of uploaded file. More...
static	renameExecutables (string $a_dir)
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Data Fields
const	DEFAULT_THUMB_SIZE = 80
const	DEFAULT_PREVIEW_SIZE = 400
bool	$is_alias
string	$origin_id
array	$media_items
bool	$contains_int_link
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Protected Member Functions
	beforeMDUpdateListener (string $a_element)
	beforeCreateMetaData ()
	beforeUpdateMetaData ()
	beforeDeleteMetaData ()
	escapeProperty (string $a_value)
	Escape property (e.g. More...
	getLocationSrc (string $purpose)
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Static Protected Member Functions
static	handleQuotaUpdate (ilObjMediaObject $a_mob)

Protected Attributes
ThumbsManager	$thumbs
MediaObjectManager	$manager
InternalDomainService	$domain
ilObjUser	$user
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Private Attributes
LegacyImages	$image_converter

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilObjMediaObject::__construct

(

int

$a_id = 0

)

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

      {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->app_event_handler = $DIC["ilAppEventHandler"];
        $this->lng = $DIC->language();
        $this->is_alias = false;
        $this->media_items = array();
        $this->contains_int_link = false;
        $this->type = "mob";
        parent::__construct($a_id, false);
        $this->image_converter = $DIC->fileConverters()->legacyImages();
        $this->domain = $DIC->mediaObjects()->internal()->domain();
        $this->manager = $this->domain->mediaObject();
        $this->thumbs = $this->domain->thumbs();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

_deleteAllUsages()

static ilObjMediaObject::_deleteAllUsages ( string  $a_type, int  $a_id, ?int  $a_usage_hist_nr = 0, string  $a_lang = "-"  )

static

Definition at line 776 of file class.ilObjMediaObject.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $and_hist = "";
        if (!is_null($a_usage_hist_nr)) {
            $and_hist = " AND usage_hist_nr = " . $ilDB->quote($a_usage_hist_nr, "integer");
        }
 
        $mob_ids = array();
        $set = $ilDB->query("SELECT id FROM mob_usage" .
            " WHERE usage_type = " . $ilDB->quote($a_type, "text") .
            " AND usage_id = " . $ilDB->quote($a_id, "integer") .
            " AND usage_lang = " . $ilDB->quote($a_lang, "text") .
            $and_hist);
        while ($row = $ilDB->fetchAssoc($set)) {
            $mob_ids[] = $row["id"];
        }
 
        $q = "DELETE FROM mob_usage WHERE usage_type = " .
            $ilDB->quote($a_type, "text") .
            " AND usage_id= " . $ilDB->quote($a_id, "integer") .
            " AND usage_lang = " . $ilDB->quote($a_lang, "text") .
            $and_hist;
        $ilDB->manipulate($q);
 
        foreach ($mob_ids as $mob_id) {
            self::handleQuotaUpdate(new self($mob_id));
        }
    }

References $ilDB.

Referenced by ilPageObject\delete().

Here is the caller graph for this function:

_determineWidthHeight()

static ilObjMediaObject::_determineWidthHeight ( string  $a_format, string  $a_type, string  $a_file, string  $a_reference, bool  $a_constrain_proportions, bool  $a_use_original, ?int  $a_user_width = null, ?int  $a_user_height = null  )

static

Definition at line 1211 of file class.ilObjMediaObject.php.

     : array {
        global $DIC;
 
        $lng = $DIC->language();
        $size = [];
        $wr = 0;
        $hr = 0;
        $width = 0;
        $height = 0;
 
        // determine width and height of known image types
        //$width = 640;
        //$height = 360;
        $info = "";
 
        /*
        if ($a_format == "audio/mpeg") {
            $width = 300;
            $height = 20;
        }*/
 
        if (ilUtil::deducibleSize($a_format)) {
            if ($a_type == "File") {
                $size = ilMediaImageUtil::getImageSize($a_file);
            } else {
                $size = ilMediaImageUtil::getImageSize($a_reference);
            }
        }
 
        if (!isset($size[0])) {
            $size[0] = 0;
        }
        if (!isset($size[1])) {
            $size[1] = 0;
        }
 
        if ($a_use_original) {
            if ($size[0] > 0 && $size[1] > 0) {
                //$width = $size[0];
                //$height = $size[1];
                $width = "";
                $height = "";
            } else {
                $info = $lng->txt("cont_could_not_determine_resource_size");
            }
        } else {
            $w = $a_user_width;
            $h = $a_user_height;
            $width = $w;
            $height = $h;
            //echo "<br>C-$width-$height-";
            if (ilUtil::deducibleSize($a_format) && $a_constrain_proportions) {
                if ($size[0] > 0 && $size[1] > 0) {
                    if ($w > 0) {
                        $wr = $size[0] / $w;
                    }
                    if ($h > 0) {
                        $hr = $size[1] / $h;
                    }
                    //echo "<br>+".$wr."+".$size[0]."+".$w."+";
                    //echo "<br>+".$hr."+".$size[1]."+".$h."+";
                    $r = max($wr, $hr);
                    if ($r > 0) {
                        $width = (int) round($size[0] / $r);
                        $height = (int) round($size[1] / $r);
                    }
                }
            }
            //echo "<br>D-$width-$height-";
        }
        //echo "<br>E-$width-$height-";
 
        if ($width == 0 && is_null($a_user_width)) {
            $width = "";
        }
        if ($height == 0 && is_null($a_user_height)) {
            $height = "";
        }
        return array("width" => $width, "height" => $height, "info" => $info);
    }

References ilMediaImageUtil\getImageSize().

Referenced by ilObjMediaObjectGUI\savePropertiesObject().

Here is the call graph for this function:

Here is the caller graph for this function:

_exists()

static ilObjMediaObject::_exists ( int  $id, bool  $reference = false, ?string  $type = null  )

static

checks if an object exists in object_data

Parameters

integer	$id	object id or reference id
bool	$reference	true if id is a reference, else false (default)
string | null	$type	string restrict on a certain type.

Returns

bool true if object exists

Reimplemented from ilObject.

Definition at line 69 of file class.ilObjMediaObject.php.

     : bool {
        if (is_int(strpos($id, "_"))) {
            $a_id = ilInternalLink::_extractObjIdOfTarget($id);
        }
 
        if (parent::_exists($id) && ilObject::_lookupType($id) === "mob") {
            return true;
        }
        return false;
    }

References $id, and ilInternalLink\_extractObjIdOfTarget().

Referenced by ilRTE\_cleanupMediaObjectUsage(), ilInternalLink\_exists(), ilRTE\_getMediaObjects(), assQuestionExport\addQTIMaterial(), ilObjTest\addQTIMaterial(), ilDclMobRecordFieldModel\afterClone(), ilObjForumGUI\createThread(), assQuestion\delete(), ilForumDraftsHistory\deleteMobs(), ilForumPostDraft\deleteMobsOfDraft(), ilObjForumGUI\deleteMobsOfDraft(), ilForum\deletePost(), ilObjTest\deleteTest(), ILIAS\Test\ExportImport\Export\exportXHTMLMediaObjects(), ilQuestionpoolExport\exportXHTMLMediaObjects(), ilObjQuestionPool\exportXMLMediaObjects(), ILIAS\MediaObjects\OverviewGUI\Table\Retrieval\getInternalData(), ilDclMobRecordFieldModel\removeData(), ilObjForumGUI\savePostObject(), ilForumXMLWriter\start(), and ilObjForumGUI\viewThreadObject().

Here is the call graph for this function:

Here is the caller graph for this function:

_getDirectory()

static ilObjMediaObject::_getDirectory ( int  $a_mob_id )

static

Get absolute directory.

Definition at line 378 of file class.ilObjMediaObject.php.

     : string {
        return ilFileUtils::getWebspaceDir() . "/" . self::_getRelativeDirectory($a_mob_id);
    }

Referenced by ilObjMediaCastAccess\_lookupDiskUsage(), createDirectory(), ilObjMediaCastGUI\determinePlaytimeObject(), ilMediaItem\getDirectory(), ilBlogPostingGUI\getFirstMediaObjectAsTag(), ilObjMediaObjectGUI\getFullscreenSizeObject(), getMultiSrtUploadDir(), ilObjMediaObjectGUI\getStandardSizeObject(), ilPCMediaObject\modifyPageContentPostXsl(), ilObjMediaObjectGUI\savePropertiesObject(), ilMediaCreationGUI\saveUrl(), and ilPCInteractiveImageGUI\update().

Here is the caller graph for this function:

_getMobsOfObject()

static ilObjMediaObject::_getMobsOfObject ( string  $a_type, int  $a_id, int|false  $a_usage_hist_nr = 0, string  $a_lang = "-"  )

static

Returns

int[]

Definition at line 816 of file class.ilObjMediaObject.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $lstr = "";
        if ($a_lang != "") {
            $lstr = " AND usage_lang = " . $ilDB->quote($a_lang, "text");
        }
        $hist_str = "";
        if ($a_usage_hist_nr !== false) {   // see #45933, restore ILIAS 7 behaviour
            $hist_str = " AND usage_hist_nr = " . $ilDB->quote($a_usage_hist_nr, "integer");
        }
 
        $q = "SELECT * FROM mob_usage WHERE " .
            "usage_type = " . $ilDB->quote($a_type, "text") . " AND " .
            "usage_id = " . $ilDB->quote($a_id, "integer") .
            $lstr . $hist_str;
        $mobs = array();
        $mob_set = $ilDB->query($q);
        while ($mob_rec = $ilDB->fetchAssoc($mob_set)) {
            $mob_id = (int) $mob_rec['id'];
            if (ilObject::_lookupType($mob_id) === "mob") {
                $mobs[$mob_id] = $mob_id;
            }
        }
 
        return $mobs;
    }

References $ilDB.

Referenced by ilRTE\_cleanupMediaObjectUsage(), assQuestionExport\addQTIMaterial(), ilObjTest\addQTIMaterial(), ilPCMediaObject\afterPageUpdate(), assQuestion\cloneXHTMLMediaObjectsOfQuestion(), ilObjForumGUI\createThread(), ilPageObject\delete(), SurveyQuestion\delete(), assQuestion\delete(), ilForumDraftsHistory\deleteMobs(), ilForumPostDraft\deleteMobsOfDraft(), ilObjForumGUI\deleteMobsOfDraft(), ilForum\deletePost(), ilObjSurvey\deleteSurveyRecord(), ilObjTest\deleteTest(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), ILIAS\Test\ExportImport\Export\exportXHTMLMediaObjects(), ilQuestionpoolExport\exportXHTMLMediaObjects(), ILIAS\MediaObjects\OverviewGUI\Table\Retrieval\getInternalData(), ilPageObject\getLastUpdateOfIncludedElements(), ilLMMultiSrt\getMobIds(), ilMepMultiSrt\getMobIds(), ilSoapUtils\getMobsOfObject(), ilCOPageExporter\getXmlExportHeadDependencies(), ilTestExporter\getXmlExportHeadDependencies(), ilPCMediaObject\modifyPageContentPostXsl(), ilObjForumGUI\publishDraftObject(), ILIAS\COPage\PC\MediaObject\MediaObjectManager\resolveMediaAliases(), ilObjForumGUI\savePostObject(), ilForumXMLWriter\start(), assClozeTest\toJSON(), assErrorText\toJSON(), assKprimChoice\toJSON(), assLongMenu\toJSON(), assMatchingQuestion\toJSON(), assMultipleChoice\toJSON(), assOrderingHorizontal\toJSON(), assOrderingQuestion\toJSON(), assSingleChoice\toJSON(), assTextSubset\toJSON(), ilObjForumGUI\updateDraftObject(), and ilObjForumGUI\viewThreadObject().

Here is the caller graph for this function:

_getRelativeDirectory()

static ilObjMediaObject::_getRelativeDirectory ( int  $a_mob_id )

static

Get relative (to webspace dir) directory.

Definition at line 387 of file class.ilObjMediaObject.php.

                                                               : string
    {
        return "mobs/mm_" . $a_mob_id;
    }

_getURL()

static ilObjMediaObject::_getURL ( int  $a_mob_id )

static

get directory for files of media object

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

     : string {
        return ilUtil::getHtmlPath(ilFileUtils::getWebspaceDir() . "/mobs/mm_" . $a_mob_id);
    }

Referenced by ILIAS\MediaObjects\MediaObjectManager\getLocalSrc().

Here is the caller graph for this function:

_lookupItemPath()

static ilObjMediaObject::_lookupItemPath ( int  $a_mob_id, bool  $a_url_encode = false, bool  $a_web = true, string  $a_purpose = ""  )

static

Get path for item with specific purpose.

Definition at line 404 of file class.ilObjMediaObject.php.

     : string {
        if ($a_purpose == "") {
            $a_purpose = "Standard";
        }
        $location = ilMediaItem::_lookupLocationForMobId($a_mob_id, $a_purpose);
        if (preg_match("/https?\:/i", $location)) {
            return $location;
        }
 
        if ($a_url_encode) {
            $location = rawurlencode($location);
        }
 
        $path = ($a_web)
            ? ILIAS_HTTP_PATH
            : ".";
 
        return $path . "/public/data/" . CLIENT_ID . "/mobs/mm_" . $a_mob_id . "/" . $location;
    }

Referenced by ilObjectFeedWriter\__construct(), ilMediaCastManageTableGUI\fillRow(), ilMediaCastTableGUI\fillRow(), and ilMediaCastManageTableGUI\getRows().

Here is the caller graph for this function:

_removeUsage()

static ilObjMediaObject::_removeUsage ( int  $a_mob_id, string  $a_type, int  $a_id, int  $a_usage_hist_nr = 0, string  $a_lang = "-"  )

static

Remove usage of mob in another container.

Definition at line 883 of file class.ilObjMediaObject.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $q = "DELETE FROM mob_usage WHERE " .
            " id = " . $ilDB->quote($a_mob_id, "integer") . " AND " .
            " usage_type = " . $ilDB->quote($a_type, "text") . " AND " .
            " usage_id = " . $ilDB->quote($a_id, "integer") . " AND " .
            " usage_lang = " . $ilDB->quote($a_lang, "text") . " AND " .
            " usage_hist_nr = " . $ilDB->quote($a_usage_hist_nr, "integer");
        $ilDB->manipulate($q);
 
        self::handleQuotaUpdate(new self($a_mob_id));
    }

Referenced by ilRTE\_cleanupMediaObjectUsage(), ilObjForumGUI\createThread(), SurveyQuestion\delete(), assQuestion\delete(), ilForumDraftsHistory\deleteMobs(), ilForumPostDraft\deleteMobsOfDraft(), ilObjForumGUI\deleteMobsOfDraft(), ilForum\deletePost(), ilObjSurvey\deleteSurveyRecord(), ilObjTest\deleteTest(), ilForumAutoSaveAsyncDraftAction\handleMedia(), ilObjForumGUI\publishDraftObject(), ilObjForumGUI\savePostObject(), ilObjForumGUI\updateDraftObject(), and ilObjForumGUI\viewThreadObject().

Here is the caller graph for this function:

_saveTempFileAsMediaObject()

static ilObjMediaObject::_saveTempFileAsMediaObject ( string  $name, string  $tmp_name, bool  $upload = true  )

static

Deprecated:

• for upload cases use $media_object->addMediaItemFrom(Legacy)Upload
• imports must use the dependency mechanism

Definition at line 1311 of file class.ilObjMediaObject.php.

     : ilObjMediaObject {
        // create dummy object in db (we need an id)
        $media_object = new ilObjMediaObject();
        $media_object->setTitle($name);
        $media_object->setDescription("");
        $media_object->create();
 
        // determine and create mob directory, move uploaded file to directory
        $media_object->createDirectory();
        $mob_dir = ilObjMediaObject::_getDirectory($media_object->getId());
 
        $file = $mob_dir . "/" . $name;
        if ($upload) {
            $media_item = $media_object->addMediaItemFromLegacyUpload(
                "Standard",
                $tmp_name,
                $name,
                0,
                0,
                true,
                true
            );
        } else {
            $media_item = $media_object->addMediaItemFromLocalFile(
                "Standard",
                $tmp_name,
                $name
            );
            /*
            $media_item = new ilMediaItem();
            $media_object->addMediaItem($media_item);
            $media_item->setPurpose("Standard");
 
            copy($tmp_name, $file);
            // get mime type
            $format = ilObjMediaObject::getMimeType($file);
            $media_item->setFormat($format);
            $location = $name;
            $media_item->setLocation($location);
            $media_item->setLocationType("LocalFile");*/
        }
 
        // set real meta and object data
        $media_object->setTitle($name);
        $media_object->setDescription($media_item->getFormat());
        $media_item->setHAlign("Left");
 
        /*
        self::renameExecutables($mob_dir);
        ilMediaSvgSanitizer::sanitizeDir($mob_dir);     // see #20339
        */
 
        $media_object->update();
 
        return $media_object;
    }

Referenced by ilForumXMLParser\handlerEndTag(), ilNewsTimelineGUI\save(), ilNewsItemGUI\saveNewsItem(), ilSoapUtils\saveTempFileAsMediaObject(), ilNewsTimelineGUI\update(), and ilNewsItemGUI\updateNewsItem().

Here is the caller graph for this function:

_saveUsage()

static ilObjMediaObject::_saveUsage ( int  $a_mob_id, string  $a_type, int  $a_id, int  $a_usage_hist_nr = 0, string  $a_lang = "-"  )

static

Save usage of mob within another container (e.g.

page)

Definition at line 854 of file class.ilObjMediaObject.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->replace(
            "mob_usage",
            array(
                "id" => array("integer", $a_mob_id),
                "usage_type" => array("text", $a_type),
                "usage_id" => array("integer", $a_id),
                "usage_lang" => array("text", $a_lang),
                "usage_hist_nr" => array("integer", $a_usage_hist_nr)
                ),
            array()
        );
 
        self::handleQuotaUpdate(new self($a_mob_id));
    }

Referenced by ilRTE\_cleanupMediaObjectUsage(), assQuestion\cloneXHTMLMediaObjectsOfQuestion(), SurveyQuestion\copyXHTMLMediaObjectsOfQuestion(), ilObjForumGUI\createThread(), ilDclMobRecordFieldModel\handleFileUpload(), ilForumAutoSaveAsyncDraftAction\handleMedia(), ilForumXMLParser\handlerEndTag(), ilObjForumGUI\publishDraftObject(), ilObjTest\replaceMobsInPageImports(), ilForumUtil\saveMediaObjects(), and ilObjForumGUI\updateDraftObject().

Here is the caller graph for this function:

addAdditionalFileFromUpload()

ilObjMediaObject::addAdditionalFileFromUpload	(	UploadResult	$result,
		string	$subdir
	)

Definition at line 1521 of file class.ilObjMediaObject.php.

     : void {
        $this->manager->addFileFromUpload(
            $this->getId(),
            $result,
            $subdir
        );
    }

addMediaItem()

ilObjMediaObject::addMediaItem

(

ilMediaItem

$a_item

)

Definition at line 186 of file class.ilObjMediaObject.php.

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

Referenced by ilMediaItem\_getMediaItemsOfMOb().

Here is the caller graph for this function:

addMediaItemFromLegacyUpload()

ilObjMediaObject::addMediaItemFromLegacyUpload	(	string	$purpose,
		string	$tmp_name,
		string	$name,
		int	$resize_width = 0,
		int	$resize_height = 0,
		bool	$constrain_proportions = true,
		bool	$deduce_size = false
	)

Definition at line 1372 of file class.ilObjMediaObject.php.

     : \ilMediaItem {
        $media_item = new ilMediaItem();
        $this->addMediaItem($media_item);
        $media_item->setPurpose($purpose);
        //$location = self::fixFilename($_FILES[$upload_name]['name']);
        $location = $name;
        $this->manager->addFileFromLegacyUpload($this->getId(), $tmp_name);
 
        // get mime type
        $format = self::getMimeType($location, true);
 
        // resize standard images
        if ($resize_width > 0 && $resize_height > 0 && is_int(strpos($format, "image"))) {
            /*
            $location = ilObjMediaObject::_resizeImage(
                $file,
                $resize_width,
                $resize_height,
                $constrain_proportions
            );*/
        }
 
        if ($deduce_size) {
            /*
            if (ilUtil::deducibleSize($format)) {
                $size = ilMediaImageUtil::getImageSize($file);
                $media_item->setWidth($size[0]);
                $media_item->setHeight($size[1]);
            }*/
        }
 
        // set real meta and object data
        $media_item->setFormat($format);
        $media_item->setLocation($location);
        $media_item->setLocationType("LocalFile");
        if ($purpose === "Standard") {
            $this->generatePreviewPic(320, 240);
        }
        return $media_item;
    }

addMediaItemFromLocalFile()

ilObjMediaObject::addMediaItemFromLocalFile	(	string	$purpose,
		string	$tmp_name,
		string	$name
	)

Definition at line 1447 of file class.ilObjMediaObject.php.

     : \ilMediaItem {
        $media_item = new ilMediaItem();
        $this->addMediaItem($media_item);
        $media_item->setPurpose($purpose);
        $location = $name;
        $this->manager->addFileFromLocal($this->getId(), $tmp_name, $name);
 
        // get mime type
        $format = self::getMimeType($location, true);
 
        // set real meta and object data
        $media_item->setFormat($format);
        $media_item->setLocation($location);
        $media_item->setLocationType("LocalFile");
        if ($purpose === "Standard") {
            $this->generatePreviewPic(320, 240);
        }
        return $media_item;
    }

addMediaItemFromUpload()

ilObjMediaObject::addMediaItemFromUpload	(	string	$purpose,
		UploadResult	$result,
		string	$upload_hash = ""
	)

Definition at line 1421 of file class.ilObjMediaObject.php.

     : \ilMediaItem {
        $media_item = new ilMediaItem();
        $this->addMediaItem($media_item);
        $media_item->setPurpose($purpose);
        $this->manager->addFileFromUpload($this->getId(), $result);
 
        // get mime type
        $format = self::getMimeType($result->getName(), true);
 
        // set real meta and object data
        $media_item->setFormat($format);
        $media_item->setLocation($result->getName());
        $media_item->setLocationType("LocalFile");
        if ($upload_hash !== "") {
            $media_item->setUploadHash($upload_hash);
        }
        if ($purpose === "Standard") {
            $this->generatePreviewPic(320, 240);
        }
        return $media_item;
    }

beforeCreateMetaData()

ilObjMediaObject::beforeCreateMetaData ( )

protected

Reimplemented from ilObject.

Definition at line 144 of file class.ilObjMediaObject.php.

                                             : bool
    {
        $ilUser = $this->user;
 
        $this->domain->metadata()->learningObjectMetadata()->derive()->fromBasicProperties(
            $this->getTitle(),
            $this->getLongDescription(),
            $ilUser->getPref('language')
        )->forObject(0, $this->getId(), $this->getType());
 
        return false;   // avoid parent to create md
    }

References ILIAS\Survey\Mode\getId(), and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

beforeDeleteMetaData()

ilObjMediaObject::beforeDeleteMetaData ( )

protected

Reimplemented from ilObject.

Definition at line 176 of file class.ilObjMediaObject.php.

                                             : bool
    {
        // Delete meta data
        $this->domain->metadata()->learningObjectMetadata()
                                 ->deleteAll(0, $this->getId(), $this->getType());
 
        return false;
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

beforeMDUpdateListener()

ilObjMediaObject::beforeMDUpdateListener ( string  $a_element )

protected

Reimplemented from ilObject.

Definition at line 124 of file class.ilObjMediaObject.php.

                                                                : bool
    {
        switch ($a_element) {
            case 'General':
                // Update Title and description
                $paths = $this->domain->metadata()->learningObjectMetadata()->paths();
                $reader = $this->domain->metadata()->learningObjectMetadata()->read(
                    0,
                    $this->getId(),
                    $this->getType(),
                    $paths->custom()->withNextStep('general')->get()
                );
 
                ilObject::_writeTitle($this->getId(), $reader->firstData($paths->title())->value());
                ilObject::_writeDescription($this->getId(), $reader->firstData($paths->descriptions())->value());
                break;
        }
        return false;       // prevent parent from creating ilMD
    }

References ilObject\_writeDescription(), ilObject\_writeTitle(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

beforeUpdateMetaData()

ilObjMediaObject::beforeUpdateMetaData ( )

protected

Reimplemented from ilObject.

Definition at line 157 of file class.ilObjMediaObject.php.

                                             : bool
    {
        $paths = $this->domain->metadata()->learningObjectMetadata()->paths();
 
        $manipulator = $this->domain->metadata()->learningObjectMetadata()
                                    ->manipulate(0, $this->getId(), $this->getType())
                                    ->prepareCreateOrUpdate($paths->title(), $this->getTitle());
 
        if ($this->getDescription() !== '') {
            $manipulator = $manipulator->prepareCreateOrUpdate($paths->firstDescription(), $this->getDescription());
        } else {
            $manipulator = $manipulator->prepareDelete($paths->firstDescription());
        }
 
        $manipulator->execute();
 
        return false;
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

clearMultiSrtDirectory()

ilObjMediaObject::clearMultiSrtDirectory

(

)

Clear multi srt directory.

Definition at line 1761 of file class.ilObjMediaObject.php.

                                            : void
    {
        ilFileUtils::delDir($this->getMultiSrtUploadDir());
    }

References ilFileUtils\delDir().

Here is the call graph for this function:

containsIntLink()

ilObjMediaObject::containsIntLink

(

)

returns true, if mob was marked as containing an intern link (via setContainsIntLink) (this method should only be called by the import parser)

Definition at line 771 of file class.ilObjMediaObject.php.

                                     : bool
    {
        return $this->contains_int_link;
    }

create()

ilObjMediaObject::create	(	bool	$a_create_meta_data = false,
		bool	$a_save_media_items = true,
		int	$from_mob_id = 0
	)

Definition at line 286 of file class.ilObjMediaObject.php.

     : int {
        $id = parent::create();
 
        if (!$a_create_meta_data) {
            $this->createMetaData();
        }
        $this->manager->create(
            $id,
            $this->getTitle(),
            $from_mob_id
        );
 
        if ($a_save_media_items) {
            $media_items = $this->getMediaItems();
            for ($i = 0; $i < count($media_items); $i++) {
                $item = $media_items[$i];
                $item->setMobId($this->getId());
                $item->setNr($i + 1);
                $item->create();
            }
        }
 
        self::handleQuotaUpdate($this);
 
        $ilAppEventHandler = $this->app_event_handler;
        $ilAppEventHandler->raise(
            'components/ILIAS/MediaObjects',
            'create',
            array('object' => $this,
            'obj_type' => 'mob',
            'obj_id' => $this->getId())
        );
 
        return $id;
    }

createDirectory()

ilObjMediaObject::createDirectory

(

)

Create file directory of media object.

Exceptions

ilMediaObjectsException

Definition at line 433 of file class.ilObjMediaObject.php.

                                     : void
    {
        $path = ilObjMediaObject::_getDirectory($this->getId());
        ilFileUtils::makeDirParents($path);
        if (!is_dir($path)) {
            throw new ilMediaObjectsException("Failed to create directory $path.");
        }
    }

References $path, _getDirectory(), ILIAS\Survey\Mode\getId(), and ilFileUtils\makeDirParents().

Here is the call graph for this function:

delete()

ilObjMediaObject::delete

(

)

delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!!

Returns

bool true if object was removed completely; false if only a references was removed

Reimplemented from ilObject.

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

                            : bool
    {
        $mob_logger = ilLoggerFactory::getLogger('mob');
        $mob_logger->debug("ilObjMediaObject: Delete called for media object ID '" . $this->getId() . "'.");
 
        if (!($this->getId() > 0)) {
            return false;
        }
 
        $usages = $this->getUsages();
 
        $mob_logger->debug("ilObjMediaObject: ... Found " . count($usages) . " usages.");
 
        if (count($usages) == 0) {
            // delete meta data of mob
            $this->deleteMetaData();
 
            // delete media items
            ilMediaItem::deleteAllItemsOfMob($this->getId());
 
            // this is just to make sure, there should be no entries left at
            // this point as they depend on the usage
            self::handleQuotaUpdate($this);
 
            // delete object
            parent::delete();
 
            $mob_logger->debug("ilObjMediaObject: ... deleted.");
        } else {
            foreach ($usages as $u) {
                $mob_logger->debug("ilObjMediaObject: ... usage type:" . $u["type"] .
                    ", id:" . $u["id"] .
                    ", lang:" . ($u["lang"] ?? "") .
                    ", hist_nr:" . ($u["hist_nr"] ?? "") . ".");
            }
            $mob_logger->debug("ilObjMediaObject: ... not deleted.");
        }
        return true;
    }

References ilMediaItem\deleteAllItemsOfMob(), ILIAS\Survey\Mode\getId(), and ilLoggerFactory\getLogger().

Here is the call graph for this function:

duplicate()

ilObjMediaObject::duplicate

(

)

Duplicate media object, return new media object.

Definition at line 1619 of file class.ilObjMediaObject.php.

                               : ilObjMediaObject
    {
        $new_obj = new ilObjMediaObject();
        $new_obj->setTitle($this->getTitle());
        $new_obj->setDescription($this->getDescription());
 
        // media items
        foreach ($this->getMediaItems() as $key => $val) {
            $new_obj->addMediaItem($val);
        }
 
        $new_obj->create(
            false,
            true,
            $this->getId()              // "from" id
        );
 
        // meta data
        $this->domain->metadata()->learningObjectMetadata()
                                 ->derive()
                                 ->fromObject(0, $this->getId(), "mob")
                                 ->forObject(0, $new_obj->getId(), "mob");
 
        return $new_obj;
    }

References ILIAS\Survey\Mode\getId(), and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

escapeProperty()

ilObjMediaObject::escapeProperty ( string  $a_value )

protected

Escape property (e.g.

title, caption) to XSLT -> HTML output

Definition at line 696 of file class.ilObjMediaObject.php.

     : string {
        return htmlspecialchars($a_value);
    }

exportFiles()

ilObjMediaObject::exportFiles

(

string

$a_target_dir

)

export all media files of object to target directory note: target directory must be the export target directory, "/objects/il_<inst>_mob_<mob_id>/..." will be appended to this directory

Exceptions

ILIAS\Filesystem\Exception\DirectoryNotFoundException

Exceptions

ILIAS\Filesystem\Exception\FileNotFoundException

Exceptions

ILIAS\Filesystem\Exception\IOException

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

     : void {
        $subdir = "il_" . IL_INST_ID . "_mob_" . $this->getId();
        ilFileUtils::makeDir($a_target_dir . "/objects/" . $subdir);
 
        $mobdir = ilFileUtils::getWebspaceDir() . "/mobs/mm_" . $this->getId();
        ilFileUtils::rCopy($mobdir, $a_target_dir . "/objects/" . $subdir);
    }

exportXML()

ilObjMediaObject::exportXML	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst = 0
	)

Definition at line 714 of file class.ilObjMediaObject.php.

     : void {
        $a_xml_writer->appendXML($this->getXML(IL_MODE_FULL, $a_inst));
    }

fixFilename()

static ilObjMediaObject::fixFilename ( string  $a_name )

static

Fix filename of uploaded file.

Definition at line 1718 of file class.ilObjMediaObject.php.

     : string {
        $a_name = ilFileUtils::getASCIIFilename($a_name);
 
        $rchars = array("`", "=", "$", "{", "}", "'", ";", " ", "(", ")");
        $a_name = str_replace($rchars, "_", $a_name);
        $a_name = str_replace("__", "_", $a_name);
        return $a_name;
    }

getDataDirectory()

ilObjMediaObject::getDataDirectory

(

)

Definition at line 1301 of file class.ilObjMediaObject.php.

                                      : string
    {
        return ilFileUtils::getWebspaceDir() . "/mobs/mm_" . $this->getId();
    }

References ILIAS\Survey\Mode\getId(), and ilFileUtils\getWebspaceDir().

Here is the call graph for this function:

getExternalMetadata()

ilObjMediaObject::getExternalMetadata

(

)

Definition at line 1804 of file class.ilObjMediaObject.php.

                                         : void
    {
        // see https://oembed.com/
        $st_item = $this->getMediaItem("Standard");
        if ($st_item->getLocationType() == "Reference") {
            if (ilExternalMediaAnalyzer::isVimeo($st_item->getLocation())) {
                $st_item->setFormat("video/vimeo");
                $par = ilExternalMediaAnalyzer::extractVimeoParameters($st_item->getLocation());
                $meta = ilExternalMediaAnalyzer::getVimeoMetadata($par["id"]);
                $this->setTitle($meta["title"] ?? "");
                $description = str_replace("\n", "", $meta["description"] ?? "");
                $description = str_replace(["<br>", "<br />"], ["\n", "\n"], $description);
                $description = strip_tags($description);
                $this->setDescription($description);
                $st_item->setDuration((int) ($meta["duration"] ?? 0));
                $url = parse_url($meta["thumbnail_url"] ?? "");
                $file = basename($url["path"]);
                $ext = pathinfo($file, PATHINFO_EXTENSION);
                if ($ext == "") {
                    $ext = "jpg";
                }
                $this->manager->addPreviewFromUrl(
                    $this->getId(),
                    $meta["thumbnail_url"],
                    "/mob_vpreview." . $ext
                );
            }
            if (ilExternalMediaAnalyzer::isYoutube($st_item->getLocation())) {
                $st_item->setFormat("video/youtube");
                $par = ilExternalMediaAnalyzer::extractYoutubeParameters($st_item->getLocation());
                try {
                    $meta = ilExternalMediaAnalyzer::getYoutubeMetadata($par["v"]);
                    $this->setTitle($meta["title"] ?? "");
                    $description = str_replace("\n", "", $meta["description"] ?? "");
                } catch (Exception $e) {
                    $this->setTitle($st_item->getLocation());
                    $description = "";
                }
                $description = str_replace(["<br>", "<br />"], ["\n", "\n"], $description);
                $description = strip_tags($description);
                $this->setDescription($description);
                $st_item->setDuration((int) ($meta["duration"] ?? 0));
                $thumbnail_url = $meta["thumbnail_url"] ?? "";
                $url = parse_url($thumbnail_url);
                if ($thumbnail_url !== "") {
                    $mob_logger = ilLoggerFactory::getLogger('mob');
                    $file = basename($url["path"]);
                    $this->manager->addPreviewFromUrl(
                        $this->getId(),
                        $meta["thumbnail_url"],
                        "/mob_vpreview." .
                        pathinfo($file, PATHINFO_EXTENSION)
                    );
                }
            }
        }
    }

References Vendor\Package\$e, $url, ilExternalMediaAnalyzer\extractVimeoParameters(), ILIAS\Survey\Mode\getId(), ilLoggerFactory\getLogger(), ilExternalMediaAnalyzer\getVimeoMetadata(), ilExternalMediaAnalyzer\getYoutubeMetadata(), and ilExternalMediaAnalyzer\isVimeo().

Referenced by ilObjMediaCast\addMobToCast().

Here is the call graph for this function:

Here is the caller graph for this function:

getFilesOfDirectory()

ilObjMediaObject::getFilesOfDirectory

(

string

$dir_path = ""

)

Definition at line 442 of file class.ilObjMediaObject.php.

     : array {
        return $this->manager->getFilesOfPath(
            $this->getId(),
            $dir_path
        );
    }

Referenced by ILIAS\COPage\PC\InteractiveImage\IIMManager\getOverlays().

Here is the caller graph for this function:

getFullscreenSrc()

ilObjMediaObject::getFullscreenSrc

(

)

Definition at line 1867 of file class.ilObjMediaObject.php.

                                      : string
    {
        return $this->getLocationSrc("Fullscreen");
    }

getLinkedMediaObjects()

ilObjMediaObject::getLinkedMediaObjects

(

array

$a_ignore = []

)

Get all media objects linked in map areas of this media object.

Parameters

int[]

$a_ignore

array of IDs that should be ignored

Definition at line 1581 of file class.ilObjMediaObject.php.

     : array {
        $linked = array();
 
        // get linked media objects (map areas)
        $med_items = $this->getMediaItems();
 
        foreach ($med_items as $med_item) {
            $int_links = ilMapArea::_getIntLinks($med_item->getId());
            foreach ($int_links as $k => $int_link) {
                if ($int_link["Type"] == "MediaObject") {
                    $l_id = ilInternalLink::_extractObjIdOfTarget($int_link["Target"]);
                    if (ilObject::_exists($l_id)) {
                        if (!in_array($l_id, $linked) &&
                            !in_array($l_id, $a_ignore)) {
                            $linked[] = $l_id;
                        }
                    }
                }
            }
        }
        //var_dump($linked);
        return $linked;
    }

getLocationSrc()

ilObjMediaObject::getLocationSrc ( string  $purpose )

protected

Definition at line 1872 of file class.ilObjMediaObject.php.

                                                      : string
    {
        return (string) $this->getMediaItem($purpose)?->getLocationSrc();
    }

getMediaItem()

ilObjMediaObject::getMediaItem

(

string

$a_purpose

)

get item for media purpose

Definition at line 200 of file class.ilObjMediaObject.php.

     : ?ilMediaItem {
        foreach ($this->media_items as $media_item) {
            if ($media_item->getPurpose() == $a_purpose) {
                return $media_item;
            }
        }
        return null;
    }

Referenced by ilObjMediaCastGUI\determinePlaytimeObject(), ilMediaObjectsPlayerWrapperGUI\getComponent(), ilObjMediaCastGUI\getMediaItem(), ilObjMediaCastGUI\showCastItemObject(), and ilObjMediaCastGUI\updateCastItemObject().

Here is the caller graph for this function:

getMediaItems()

& ilObjMediaObject::getMediaItems

(

)

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

                                    : array
    {
        return $this->media_items;
    }

Referenced by ilObjMediaCastGUI\getMediaItems().

Here is the caller graph for this function:

getMimeType()

static ilObjMediaObject::getMimeType ( string  $a_file, bool  $a_external = false  )

static

get mime type for file

Definition at line 1203 of file class.ilObjMediaObject.php.

     : string {
        $mime = MimeType::lookupMimeType($a_file, MimeType::APPLICATION__OCTET_STREAM, $a_external);
        return $mime;
    }

Referenced by ilKprimChoiceWizardInputGUI\checkUploads(), ilNewsTimelineItemGUI\renderMedia(), ilNewsTimelineItemGUI\renderMediaModal(), ilObjMediaObjectGUI\savePropertiesObject(), ilMediaCreationGUI\saveUrl(), assMultipleChoice\setImageFile(), ilPCInteractiveImageGUI\update(), and ilObjMediaCastGUI\updateMediaItem().

Here is the caller graph for this function:

getMultiSrtFiles()

ilObjMediaObject::getMultiSrtFiles

(

)

Get all srt files of srt multi upload.

Definition at line 1769 of file class.ilObjMediaObject.php.

                                      : array
    {
        $items = array();
 
        $lang_codes = $this->domain->metadata()->getLOMLanguageCodes();
 
        $dir = $this->getMultiSrtUploadDir();
        $files = ilFileUtils::getDir($dir);
        foreach ($files as $k => $i) {
            // check directory
            if ($i["type"] == "file" && !in_array($k, array(".", ".."))) {
                if (pathinfo($k, PATHINFO_EXTENSION) == "vtt") {
                    $lang = "";
                    if (substr($k, strlen($k) - 7, 1) == "_") {
                        $lang = substr($k, strlen($k) - 6, 2);
                        if (!in_array($lang, $lang_codes)) {
                            $lang = "";
                        }
                    }
                    $items[] = array("filename" => $k, "lang" => $lang);
                }
            }
        }
        return $items;
    }

References ilFileUtils\getDir().

Here is the call graph for this function:

getMultiSrtUploadDir()

ilObjMediaObject::getMultiSrtUploadDir

(

)

Get directory for multi srt upload.

Definition at line 1733 of file class.ilObjMediaObject.php.

                                          : string
    {
        return ilObjMediaObject::_getDirectory($this->getId()) . "/srt/tmp";
    }

References _getDirectory(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getOriginID()

ilObjMediaObject::getOriginID

(

)

Definition at line 281 of file class.ilObjMediaObject.php.

                                 : string
    {
        return $this->origin_id;
    }

getParentObjectIdForUsage()

static ilObjMediaObject::getParentObjectIdForUsage ( array  $a_usage, bool  $a_include_all_access_obj_ids = false  )

static

Get's the repository object ID of a parent object, if possible see ilWebAccessChecker.

Definition at line 1010 of file class.ilObjMediaObject.php.

     : ?int {
        $cont_type = "";
        if (is_int(strpos($a_usage["type"], ":"))) {
            $us_arr = explode(":", $a_usage["type"]);
            $type = $us_arr[1];
            $cont_type = $us_arr[0];
        } else {
            $type = $a_usage["type"];
        }
 
        $id = $a_usage["id"];
        $obj_id = null;
 
        switch ($type) {
            // RTE / tiny mce
            case "html":
 
                switch ($cont_type) {
                    case "qpl":
                        // Question Pool *Question* Text (Test)
                        global $DIC;
                        $qinfo = $DIC->testQuestion()->getGeneralQuestionProperties($id);
                        if ($qinfo->getOriginalId() > 0) {
                            $obj_id = ilObjTest::_lookupTestObjIdForQuestionId($id);    // usage in test
                        } else {
                            $obj_id = (int) ($qinfo["obj_fi"] ?? 0);            // usage in pool
                        }
                        break;
 
                    case "spl":
                        // Question Pool *Question* Text (Survey)
                        $quest = SurveyQuestion::_instanciateQuestion($id);
                        if ($quest) {
                            $parent_id = $quest->getObjId();
 
                            // pool question copy - find survey, do not use pool itself
                            if ($quest->getOriginalId() &&
                                ilObject::_lookupType($parent_id) == "spl") {
                                $obj_id = (int) SurveyQuestion::_lookupSurveyObjId($id);
                            }
                            // original question (in pool or survey)
                            else {
                                $obj_id = (int) $parent_id;
                            }
 
                            unset($quest);
                        }
                        break;
 
                    case "exca":
                        // Exercise assignment
                        $returned_pk = $a_usage['id'];
                        // #15995 - we are just checking against exercise object
                        $obj_id = ilExSubmission::lookupExerciseIdForReturnedId($returned_pk);
                        break;
 
                    case "frm":
                        // Forum
                        $post_pk = $a_usage['id'];
                        $oPost = new ilForumPost($post_pk);
                        $frm_pk = $oPost->getForumId();
                        $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
                        break;
 
 
                    case "frm~d":
                        $draft_id = $a_usage['id'];
                        $oDraft = ilForumPostDraft::newInstanceByDraftId($draft_id);
 
                        $frm_pk = $oDraft->getForumId();
                        $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
                        break;
                    case "frm~h":
                        $history_id = $a_usage['id'];
                        $oHistoryDraft = new ilForumDraftsHistory($history_id);
                        $oDraft = ilForumPostDraft::newInstanceByDraftId($oHistoryDraft->getDraftId());
 
                        $frm_pk = $oDraft->getForumId();
                        $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
                        break;
                        // temporary items (per user)
                    case "frm~":
                    case "exca~":
                        $obj_id = (int) $a_usage['id'];
                        break;
 
                        // "old" category pages
                    case "cat":
                        // InfoScreen Text
                    case "tst":
                    case "svy":
                        // data collection
                    case "dcl":
                        $obj_id = (int) $id;
                        break;
                }
                break;
 
                // page editor
            case "pg":
 
                switch ($cont_type) {
                    // question feedback // parent obj id is q id
                    case "qfbg":
                    case "qpl":
 
                        if ($cont_type == "qfbg") {
                            $id = ilPageObject::lookupParentId($id, 'qfbg');
                        }
 
                        // Question Pool Question Pages
                        global $DIC;
                        $qinfo = $DIC->testQuestion()->getGeneralQuestionProperties($id);
                        if ($qinfo->getOriginalId() > 0) {
                            $obj_id = ilObjTest::_lookupTestObjIdForQuestionId($id);    // usage in test
                        } else {
                            $obj_id = $qinfo["obj_fi"];         // usage in pool
                        }
                        if ($obj_id == 0) {     // this is the case, if question is in learning module -> get lm id
                            $pinfo = ilPCQuestion::_getPageForQuestionId($id, "lm");
                            if ($pinfo && $pinfo["parent_type"] == "lm") {
                                $obj_id = ilLMObject::_lookupContObjID($pinfo["page_id"]);
                            }
                        }
                        break;
 
                    case "lm":
                        // learning modules
                        $obj_id = ilLMObject::_lookupContObjID($id);
                        break;
 
                    case "term":
                        $term_id = $id;
                        $obj_id = ilGlossaryTerm::_lookGlossaryID($term_id);
                        break;
 
                    case "wpg":
                        // wiki page
                        $obj_id = (int) ilWikiPage::lookupObjIdByPage($id);
                        break;
 
                    case "sahs":
                        // sahs page
                        // can this implementation be used for other content types, too?
                        $obj_id = ilPageObject::lookupParentId($id, 'sahs');
                        break;
 
                    case "prtf":
                        // portfolio
                        $obj_id = ilPortfolioPage::findPortfolioForPage($id);
                        break;
 
                    case "prtt":
                        // portfolio template
                        $obj_id = ilPortfolioTemplatePage::findPortfolioForPage($id);
                        break;
 
 
                    case "impr":
                        // imprint page - always id 1
                        // fallthrough
 
                    case "copa":
                    case "cstr":
                        $obj_id = $id;
                        break;
 
                    default:
                        $obj_id = ilPageObject::lookupParentId($id, $cont_type);
                        break;
                }
                break;
 
                // Media Pool
            case "mep":
                $obj_id = $id;
                break;
 
                // News Context Object (e.g. MediaCast)
            case "news":
                $obj_id = ilNewsItem::_lookupContextObjId($id);
                break;
        }
 
        return $obj_id;
    }

Referenced by ILIAS\MediaObjects\OverviewGUI\Table\Retrieval\addExternalData(), ilMobStakeholder\canBeAccessedByCurrentUser(), ilObjMediaObjectAccess\checkAccessMob(), and ilMediaObjectUsagesTableGUI\fillRow().

Here is the caller graph for this function:

getSrtFiles()

ilObjMediaObject::getSrtFiles

(

bool

$vtt_only = false

)

Definition at line 1544 of file class.ilObjMediaObject.php.

                                                       : array
    {
        return $this->manager->getSrtFiles($this->getId(), $vtt_only);
    }

References ILIAS\Survey\Mode\getId().

Referenced by ilMobSubtitleTableGUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

getStandardSrc()

ilObjMediaObject::getStandardSrc

(

)

Definition at line 1862 of file class.ilObjMediaObject.php.

                                    : string
    {
        return $this->getLocationSrc("Standard");
    }

Referenced by ilObjMediaCastGUI\showCastItemObject().

Here is the caller graph for this function:

getUsages()

ilObjMediaObject::getUsages

(

bool

$a_include_history = true

)

get all usages of current media object

Definition at line 908 of file class.ilObjMediaObject.php.

     : array {
        return self::lookupUsages($this->getId(), $a_include_history);
    }

getVideoPreviewPic()

ilObjMediaObject::getVideoPreviewPic

(

bool

$a_filename_only = false

)

Definition at line 1684 of file class.ilObjMediaObject.php.

     : string {
 
        if (!$a_filename_only) {
            $src = $this->thumbs->getPreviewSrc($this->getId());
            if ($src !== "") {
                return $src;
            }
        }
 
        $dir = ilObjMediaObject::_getDirectory($this->getId());
        $ppics = array("mob_vpreview.jpg",
            "mob_vpreview.jpeg",
            "mob_vpreview.png");
        $med = $this->getMediaItem("Standard");
        if ($med && $med->getFormat() === "image/svg+xml" && $med->getLocationType() === "LocalFile") {
            $ppics[] = $med->getLocation();
        }
        foreach ($ppics as $p) {
            if (is_file($dir . "/" . $p)) {
                if ($a_filename_only) {
                    return $p;
                } else {
                    return $dir . "/" . $p;
                }
            }
        }
        return "";
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getXML()

ilObjMediaObject::getXML	(	int	$a_mode = IL_MODE_FULL,
		int	$a_inst = 0,
		bool	$a_sign_locals = false,
		bool	$offline = false
	)

get MediaObject XLM Tag

Parameters

int	$a_mode	IL_MODE_ALIAS | IL_MODE_OUTPUT | IL_MODE_FULL
int	$a_inst
bool	$a_sign_locals

Returns

string

Exceptions

ilWACException

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

     : string {
        $ilUser = $this->user;
        $xml = "";
        switch ($a_mode) {
            case IL_MODE_ALIAS:
                $xml = "<MediaObject>";
                $xml .= "<MediaAlias OriginId=\"il__mob_" . $this->getId() . "\"/>";
                $media_items = $this->getMediaItems();
                for ($i = 0; $i < count($media_items); $i++) {
                    $item = $media_items[$i];
                    $xml .= "<MediaAliasItem Purpose=\"" . $item->getPurpose() . "\">";
 
                    // Layout
                    $width = ($item->getWidth() != "")
                        ? "Width=\"" . $item->getWidth() . "\""
                        : "";
                    $height = ($item->getHeight() != "")
                        ? "Height=\"" . $item->getHeight() . "\""
                        : "";
                    $halign = ($item->getHAlign() != "")
                        ? "HorizontalAlign=\"" . $item->getHAlign() . "\""
                        : "";
                    $xml .= "<Layout $width $height $halign />";
 
                    // Caption
                    if ($item->getCaption() != "") {
                        $xml .= "<Caption Align=\"bottom\">" .
                            $this->escapeProperty($item->getCaption()) . "</Caption>";
                    }
 
                    // Text Representation
                    if ($item->getTextRepresentation() != "") {
                        $xml .= "<TextRepresentation>" .
                            $this->escapeProperty($item->getTextRepresentation()) . "</TextRepresentation>";
                    }
 
                    // Parameter
                    $parameters = $item->getParameters();
                    foreach ($parameters as $name => $value) {
                        $xml .= "<Parameter Name=\"$name\" Value=\"" . $this->escapeProperty($value) . "\"/>";
                    }
                    $xml .= $item->getMapAreasXML();
                    $xml .= "</MediaAliasItem>";
                }
                break;
 
                // for output we need technical sections of meta data
            case IL_MODE_OUTPUT:
 
                // get first technical section
                //                              $meta = $this->getMetaData();
                $xml = "<MediaObject Id=\"il__mob_" . $this->getId() . "\">";
 
                $media_items = $this->getMediaItems();
                for ($i = 0; $i < count($media_items); $i++) {
                    $item = $media_items[$i];
 
                    $xml .= "<MediaItem Purpose=\"" . $item->getPurpose() . "\">";
                    if ($a_sign_locals && $item->getLocationType() == "LocalFile") {
                        // pre irss file
                        if (is_file($this->getDataDirectory() . "/" . $item->getLocation())) {
                            $location = ilWACSignedPath::signFile($this->getDataDirectory() . "/" . $item->getLocation());
                            $location = substr($location, strrpos($location, "/") + 1);
                        } else {
                            if ($offline) {
                                $location = $item->getLocation();
                            } else {
                                $location = $this->manager->getLocalSrc(
                                    $this->getId(),
                                    $item->getLocation()
                                );
                            }
                        }
                    } else {
                        $location = trim($item->getLocation());
                        // irss
                        if ($item->getLocationType() === "LocalFile" &&
                        !is_file($this->getDataDirectory() . "/" . $item->getLocation())) {
                            $location = $this->manager->getLocalSrc(
                                $this->getId(),
                                $item->getLocation()
                            );
                        }
                        if ($item->getLocationType() != "LocalFile") {  //#25941
                            $location = ilUtil::secureUrl($location); //#23518
                        }
                    }
 
                    $xml .= "<Location Type=\"" . $item->getLocationType() . "\">" .
                        $this->handleAmps($location) . "</Location>";
 
                    // Format
                    $xml .= "<Format>" . $item->getFormat() . "</Format>";
 
                    // Layout
                    $width = ($item->getWidth() != "")
                        ? "Width=\"" . $item->getWidth() . "\""
                        : "";
                    $height = ($item->getHeight() != "")
                        ? "Height=\"" . $item->getHeight() . "\""
                        : "";
                    $halign = ($item->getHAlign() != "")
                        ? "HorizontalAlign=\"" . $item->getHAlign() . "\""
                        : "";
                    $xml .= "<Layout $width $height $halign />";
 
                    // Caption
                    if ($item->getCaption() != "") {
                        $xml .= "<Caption Align=\"bottom\">" .
                            $this->escapeProperty($item->getCaption()) . "</Caption>";
                    }
 
                    // Text Representation
                    if ($item->getTextRepresentation() != "") {
                        $xml .= "<TextRepresentation>" .
                            $this->escapeProperty($item->getTextRepresentation()) . "</TextRepresentation>";
                    }
 
                    // Title
                    if ($this->getTitle() != "") {
                        $xml .= "<Title>" .
                            $this->escapeProperty($this->getTitle()) . "</Title>";
                    }
 
                    // Parameter
                    $parameters = $item->getParameters();
                    if ($item->getFormat() === "video/vimeo") {
                        $parameters = ilExternalMediaAnalyzer::extractVimeoParameters($item->getLocation());
                    }
                    foreach ($parameters as $name => $value) {
                        $xml .= "<Parameter Name=\"$name\" Value=\"" . $this->escapeProperty($value) . "\"/>";
                    }
                    $xml .= $item->getMapAreasXML();
 
                    // Subtitles
                    if ($item->getPurpose() == "Standard") {
                        $this->manager->generateMissingVTT($this->getId());
                        $srts = $this->getSrtFiles(true);
                        foreach ($srts as $srt) {
                            $def = "";
                            $meta_lang = "";
                            if ($ilUser->getLanguage() != $meta_lang &&
                                $ilUser->getLanguage() == $srt["language"]) {
                                $def = ' Default="true" ';
                            }
                            $src = $offline
                                ? "mobs/mm_" . $this->getId() . $srt["full_path"]
                                : $srt["src"];
                            $xml .= "<Subtitle File=\"" . $src .
                                "\" Language=\"" . $srt["language"] . "\" " . $def . "/>";
                        }
                    }
                    if ($this->getVideoPreviewPic(false)) {
                        $xml .= "<PreviewPic File=\"" . $this->handleAmps($this->getVideoPreviewPic(false)) .
                            "\" />";
                    }
                    if ($item->getLocationType() == "LocalFile") {
                        $lpos = strrpos($location, "/");
                        $base_url = substr($location, 0, $lpos);
                        $xml .= "<Url Base=\"" . $base_url .
                            "\" />";
                    }
                    $xml .= "</MediaItem>";
                }
                break;
 
                // full xml for export
            case IL_MODE_FULL:
                $xml = "<MediaObject>";
 
                // Title and Identifier
                $xml .= "<Identifier Entry=\"il_" . IL_INST_ID . "_mob_" . $this->getId() . "\"/>";
                if ($this->getTitle() != "") {
                    $xml .= "<Title>" .
                        $this->escapeProperty($this->getTitle()) . "</Title>";
                }
 
                $media_items = $this->getMediaItems();
                for ($i = 0; $i < count($media_items); $i++) {
                    $item = $media_items[$i];
 
                    // highlight mode
                    $xml .= "<MediaItem Purpose=\"" . $item->getPurpose() . "\">";
 
                    // Location
                    $xml .= "<Location Type=\"" . $item->getLocationType() . "\">" .
                        $this->handleAmps($item->getLocation()) . "</Location>";
 
                    // Format
                    $xml .= "<Format>" . $item->getFormat() . "</Format>";
 
                    // Layout
                    $width = ($item->getWidth() != "")
                        ? "Width=\"" . $item->getWidth() . "\""
                        : "";
                    $height = ($item->getHeight() != "")
                        ? "Height=\"" . $item->getHeight() . "\""
                        : "";
                    $halign = ($item->getHAlign() != "")
                        ? "HorizontalAlign=\"" . $item->getHAlign() . "\""
                        : "";
                    $xml .= "<Layout $width $height $halign />";
 
                    // Caption
                    if ($item->getCaption() != "") {
                        $xml .= "<Caption Align=\"bottom\">" .
                            str_replace("&", "&amp;", $item->getCaption()) . "</Caption>";
                    }
 
                    // Text Representation
                    if ($item->getTextRepresentation() != "") {
                        $xml .= "<TextRepresentation>" .
                            str_replace("&", "&amp;", $item->getTextRepresentation()) . "</TextRepresentation>";
                    }
 
                    // Parameter
                    $parameters = $item->getParameters();
                    foreach ($parameters as $name => $value) {
                        $xml .= "<Parameter Name=\"$name\" Value=\"$value\"/>";
                    }
                    $xml .= $item->getMapAreasXML(true, $a_inst);
                    $xml .= "</MediaItem>";
                }
                break;
        }
        $xml .= "</MediaObject>";
        return $xml;
    }

References $location, ilExternalMediaAnalyzer\extractVimeoParameters(), ILIAS\Survey\Mode\getId(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), IL_INST_ID, IL_MODE_ALIAS, IL_MODE_FULL, IL_MODE_OUTPUT, ilUtil\secureUrl(), and ilWACSignedPath\signFile().

Here is the call graph for this function:

handleAmps()

ilObjMediaObject::handleAmps

(

string

$a_str

)

Replace "&" (if not an "&amp;") with "&amp;".

Definition at line 706 of file class.ilObjMediaObject.php.

     : string {
        $a_str = str_replace("&", "&", $a_str);
        $a_str = str_replace("&", "&", $a_str);
        return $a_str;
    }

handleQuotaUpdate()

static ilObjMediaObject::handleQuotaUpdate ( ilObjMediaObject  $a_mob )

staticprotected

Deprecated:

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

     : void {
    }

hasFullscreenItem()

ilObjMediaObject::hasFullscreenItem

(

)

Definition at line 236 of file class.ilObjMediaObject.php.

                                       : bool
    {
        return $this->hasPurposeItem("Fullscreen");
    }

hasPurposeItem()

ilObjMediaObject::hasPurposeItem

(

string

$purpose

)

returns whether object has media item with specific purpose

Definition at line 244 of file class.ilObjMediaObject.php.

                                                   : bool
    {
        if (is_object($this->getMediaItem($purpose))) {
            return true;
        } else {
            return false;
        }
    }

isAlias()

ilObjMediaObject::isAlias

(

)

Definition at line 268 of file class.ilObjMediaObject.php.

                             : bool
    {
        return $this->is_alias;
    }

isTypeAllowed()

static ilObjMediaObject::isTypeAllowed ( string  $a_type )

static

Definition at line 1607 of file class.ilObjMediaObject.php.

     : bool {
        global $DIC;
        return in_array($a_type, iterator_to_array(
            $DIC->mediaObjects()->internal()->domain()->mediaType()->getAllowedSuffixes()
        ), true);
    }

Referenced by ilPageObjectGUI\displayMedia(), ilLMPresentationGUI\ilMedia(), ilGlossaryPresentationGUI\media(), ilObjMediaPoolGUI\showMedia(), ilPageObjectGUI\showMediaFullscreen(), and ilPageObjectGUI\showPage().

Here is the caller graph for this function:

lookupUsages()

static ilObjMediaObject::lookupUsages ( int  $a_id, bool  $a_include_history = true  )

static

Lookup usages of media object.

Todo:

: This should be all in one context -> mob id table

Definition at line 919 of file class.ilObjMediaObject.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $hist_str = "";
        if ($a_include_history) {
            $hist_str = ", usage_hist_nr";
        }
 
        // get usages in pages
        $q = "SELECT DISTINCT usage_type, usage_id, usage_lang" . $hist_str . " FROM mob_usage WHERE id = " .
            $ilDB->quote($a_id, "integer");
 
        if (!$a_include_history) {
            $q .= " AND usage_hist_nr = " . $ilDB->quote(0, "integer");
        }
 
        $us_set = $ilDB->query($q);
        $ret = array();
        while ($us_rec = $ilDB->fetchAssoc($us_set)) {
            $ut = "";
            $ct = 0;
            if (is_int(strpos($us_rec["usage_type"], ":"))) {
                $us_arr = explode(":", $us_rec["usage_type"]);
                $ut = $us_arr[1];
                $ct = $us_arr[0];
            }
 
            // check whether page exists
            $skip = false;
            if ($ut == "pg") {
                if (!ilPageObject::_exists($ct, $us_rec["usage_id"])) {
                    $skip = true;
                }
            }
 
            if (!$skip) {
                $ret[] = array(
                    "type" => $us_rec["usage_type"],
                    "id" => $us_rec["usage_id"],
                    "lang" => $us_rec["usage_lang"],
                    "hist_nr" => ($us_rec["usage_hist_nr"] ?? 0)
                );
            }
        }
 
        // get usages in media pools
        $q = "SELECT DISTINCT mep_id FROM mep_tree JOIN mep_item ON (child = obj_id) WHERE mep_item.foreign_id = " .
            $ilDB->quote($a_id, "integer") . " AND mep_item.type = " . $ilDB->quote("mob", "text");
        $us_set = $ilDB->query($q);
        while ($us_rec = $ilDB->fetchAssoc($us_set)) {
            $ret[] = array("type" => "mep",
                "id" => $us_rec["mep_id"]);
        }
 
        // get usages in news items (media casts)
        $news_usages = ilNewsItem::_lookupMediaObjectUsages($a_id);
        foreach ($news_usages as $nu) {
            $ret[] = $nu;
        }
 
 
        // get usages in map areas
        $q = "SELECT DISTINCT mob_id FROM media_item it, map_area area " .
            " WHERE area.item_id = it.id " .
            " AND area.link_type = " . $ilDB->quote("int", "text") . " " .
            " AND area.target = " . $ilDB->quote("il__mob_" . $a_id, "text");
        $us_set = $ilDB->query($q);
        while ($us_rec = $ilDB->fetchAssoc($us_set)) {
            $ret[] = array("type" => "map",
                "id" => $us_rec["mob_id"]);
        }
 
        // get usages in personal clipboards
        $users = ilObjUser::_getUsersForClipboadObject("mob", $a_id);
        foreach ($users as $user) {
            $ret[] = array("type" => "clip",
                "id" => $user);
        }
 
        return $ret;
    }

Referenced by ILIAS\MediaObjects\OverviewGUI\Table\Retrieval\addExternalData(), ilMobStakeholder\canBeAccessedByCurrentUser(), and ilLMObject\updateInternalLinks().

Here is the caller graph for this function:

makeThumbnail()

ilObjMediaObject::makeThumbnail	(	string	$source,
		string	$thumbname
	)

Make thumbnail.

Definition at line 1552 of file class.ilObjMediaObject.php.

     : void {
        $format = self::getMimeType($source, true);
        $this->thumbs->createPreview(
            $this->getId(),
            $source,
            true,
            $format,
            1,
            $thumbname
        );
    }

modifyExportIdentifier()

ilObjMediaObject::modifyExportIdentifier	(	string	$a_tag,
		string	$a_param,
		string	$a_value
	)

Definition at line 740 of file class.ilObjMediaObject.php.

     : string {
        if ($a_tag == "Identifier" && $a_param == "Entry") {
            $a_value = ilUtil::insertInstIntoID($a_value);
        }
 
        return $a_value;
    }

References ilUtil\insertInstIntoID().

Here is the call graph for this function:

read()

ilObjMediaObject::read

(

)

Exceptions

ilObjectNotFoundException
ilObjectTypeMismatchException

Reimplemented from ilObject.

Definition at line 257 of file class.ilObjMediaObject.php.

                          : void
    {
        parent::read();
        ilMediaItem::_getMediaItemsOfMOb($this);
    }

References ilMediaItem\_getMediaItemsOfMOb().

Here is the call graph for this function:

removeAdditionalFile()

ilObjMediaObject::removeAdditionalFile

(

string

$a_file

)

Definition at line 1567 of file class.ilObjMediaObject.php.

     : void {
        $this->manager->removeLocation(
            $this->getId(),
            $a_file
        );
    }

removeAllMediaItems()

ilObjMediaObject::removeAllMediaItems

(

)

Definition at line 231 of file class.ilObjMediaObject.php.

                                         : void
    {
        $this->media_items = array();
    }

removeMediaItem()

ilObjMediaObject::removeMediaItem

(

string

$a_purpose

)

Definition at line 211 of file class.ilObjMediaObject.php.

     : void {
        foreach ($this->media_items as $key => $media_item) {
            if ($media_item->getPurpose() == $a_purpose) {
                unset($this->media_items[$key]);
            }
        }
        // update numbers and keys
        $i = 1;
        $media_items = array();
        foreach ($this->media_items as $media_item) {
            $media_items [$i] = $media_item;
            $media_item->setMobId($this->getId());
            $media_item->setNr($i);
            $i++;
        }
        $this->media_items = $media_items;
    }

Referenced by ilObjMediaCastGUI\updateCastItemObject().

Here is the caller graph for this function:

renameExecutables()

static ilObjMediaObject::renameExecutables ( string  $a_dir )

static

Definition at line 1795 of file class.ilObjMediaObject.php.

     : void {
        ilFileUtils::renameExecutables($a_dir);
        if (!self::isTypeAllowed("html")) {
            ilFileUtils::rRenameSuffix($a_dir, "html", "sec");        // see #20187
        }
    }

References ilFileUtils\rRenameSuffix().

Here is the call graph for this function:

replaceMediaItemFromUpload()

ilObjMediaObject::replaceMediaItemFromUpload	(	string	$purpose,
		UploadResult	$result,
		string	$upload_hash = ""
	)

Definition at line 1471 of file class.ilObjMediaObject.php.

     : \ilMediaItem {
        $media_item = $this->getMediaItem($purpose);
        $this->manager->removeLocation($this->getId(), $media_item->getLocation());
        $this->manager->addFileFromUpload($this->getId(), $result);
 
        // get mime type
        $format = self::getMimeType($result->getName(), true);
 
        // set real meta and object data
        $media_item->setFormat($format);
        $media_item->setLocation($result->getName());
        $media_item->setLocationType("LocalFile");
        if ($upload_hash !== "") {
            $media_item->setUploadHash($upload_hash);
        }
        if ($purpose === "Standard") {
            $this->generatePreviewPic(320, 240);
        }
        return $media_item;
    }

setAlias()

ilObjMediaObject::setAlias

(

bool

$a_is_alias

)

Definition at line 263 of file class.ilObjMediaObject.php.

                                              : void
    {
        $this->is_alias = $a_is_alias;
    }

setContainsIntLink()

ilObjMediaObject::setContainsIntLink

(

bool

$a_contains_link

)

content parser set this flag to true, if the media object contains internal links (this method should only be called by the import parser)

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

     : void {
        $this->contains_int_link = $a_contains_link;
    }

setOriginID()

ilObjMediaObject::setOriginID

(

string

$a_id

)

Deprecated:

(seems to be obsolete)

Definition at line 276 of file class.ilObjMediaObject.php.

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

update()

ilObjMediaObject::update

(

bool

$a_upload = false

)

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

                                                  : bool
    {
        parent::update();
 
        if (!$a_upload) {
            $this->updateMetaData();
        }
 
        // iterate all items
        $media_items = $this->getMediaItems();
        ilMediaItem::deleteAllItemsOfMob($this->getId());
 
        $j = 1;
        foreach ($media_items as $key => $val) {
            $item = $val;
            if (is_object($item)) {
                $item->setMobId($this->getId());
                $item->setNr($j);
                if ($item->getLocationType() == "Reference") {
                    $item->extractUrlParameters();
                }
                $item->create();
                $j++;
            }
        }
 
        $this->manager->updateLastChange($this->getId());
 
        self::handleQuotaUpdate($this);
        $ilAppEventHandler = $this->app_event_handler;
        $ilAppEventHandler->raise(
            'components/ILIAS/MediaObjects',
            'update',
            array('object' => $this,
                    'obj_type' => 'mob',
                    'obj_id' => $this->getId())
        );
 
        return true;
    }

References ilMediaItem\deleteAllItemsOfMob(), and ILIAS\Survey\Mode\getId().

Referenced by ilObjMediaCastGUI\updateCastItemObject().

Here is the call graph for this function:

Here is the caller graph for this function:

uploadAdditionalFile()

ilObjMediaObject::uploadAdditionalFile	(	string	$a_name,
		string	$tmp_name,
		string	$a_subdir = "",
		string	$a_mode = "move_uploaded"
	)

Create new media object and update page in db and return new media object.

Definition at line 1499 of file class.ilObjMediaObject.php.

     : void {
        $a_subdir = str_replace("..", "", $a_subdir);
        if ($a_mode == "rename") {
            $this->manager->addFileFromLocal(
                $this->getId(),
                $tmp_name,
                $a_subdir . "/" . $a_name
            );
        } else {
            $this->manager->addFileFromLegacyUpload(
                $this->getId(),
                $tmp_name,
                $a_subdir . "/" . $a_name
            );
        }
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

uploadMultipleSubtitleFile()

ilObjMediaObject::uploadMultipleSubtitleFile

(

array

$a_file

)

Upload multi srt file.

Definition at line 1742 of file class.ilObjMediaObject.php.

     : void {
        $lng = $this->lng;
 
        if (!is_file($a_file["tmp_name"])) {
            throw new ilMediaObjectsException($lng->txt("mob_file_could_not_be_uploaded"));
        }
 
        $dir = $this->getMultiSrtUploadDir();
        ilFileUtils::delDir($dir, true);
        ilFileUtils::makeDirParents($dir);
        ilFileUtils::moveUploadedFile($a_file["tmp_name"], "multi_vtt.zip", $dir . "/" . "multi_vtt.zip");
        $this->domain->resources()->zip()->unzipFile($dir . "/multi_vtt.zip");
    }

References $lng.

uploadSrtFile()

ilObjMediaObject::uploadSrtFile	(	string	$a_tmp_name,
		string	$a_language,
		string	$a_mode = "move_uploaded"
	)

Definition at line 1532 of file class.ilObjMediaObject.php.

     : bool {
        if (is_file($a_tmp_name) && $a_language != "") {
            $this->uploadAdditionalFile("subtitle_" . $a_language . ".vtt", $a_tmp_name, "srt", $a_mode);
            return true;
        }
        return false;
    }

uploadVideoPreviewPic()

ilObjMediaObject::uploadVideoPreviewPic

(

array

$a_prevpic

)

Definition at line 1645 of file class.ilObjMediaObject.php.

     : void {
        // remove old one
        if ($this->getVideoPreviewPic(true) != "") {
            $this->removeAdditionalFile($this->getVideoPreviewPic(true));
        }
 
        $pi = pathinfo($a_prevpic["name"]);
        $ext = $pi["extension"];
        if (in_array($ext, array("jpg", "jpeg", "png"))) {
            $this->uploadAdditionalFile("mob_vpreview." . $ext, $a_prevpic["tmp_name"]);
        }
    }

Field Documentation

$contains_int_link

bool ilObjMediaObject::$contains_int_link

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

$domain

InternalDomainService ilObjMediaObject::$domain

protected

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

$image_converter

LegacyImages ilObjMediaObject::$image_converter

private

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

$is_alias

bool ilObjMediaObject::$is_alias

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

$manager

MediaObjectManager ilObjMediaObject::$manager

protected

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

$media_items

array ilObjMediaObject::$media_items

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

$origin_id

string ilObjMediaObject::$origin_id

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

$thumbs

ThumbsManager ilObjMediaObject::$thumbs

protected

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

$user

ilObjUser ilObjMediaObject::$user

protected

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

DEFAULT_PREVIEW_SIZE

const ilObjMediaObject::DEFAULT_PREVIEW_SIZE = 400

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

DEFAULT_THUMB_SIZE

const ilObjMediaObject::DEFAULT_THUMB_SIZE = 80

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

Referenced by ILIAS\MediaObjects\Thumbs\ThumbsManager\createThumb().

---

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

• components/ILIAS/MediaObjects/MediaObject/class.ilObjMediaObject.php