Inheritance diagram for ilObjMediaObject:

Collaboration diagram for ilObjMediaObject:

Public Member Functions
	__construct ($a_id=0)
	Constructor public. More...

	setRefId ($a_id)

	getRefId ()

	putInTree ($a_parent_ref)

	createReference ()

	setTitle ($a_title)

	getTitle ()

	delete ()
	delete media object More...

	getDescription ()
	get description of media object More...

	setDescription ($a_description)
	set description of media object More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	addMediaItem ($a_item)
	add media item to media object More...

&	getMediaItems ()
	get all media items More...

&	getMediaItem ($a_purpose)
	get item for media purpose More...

	removeMediaItem ($a_purpose)

	removeAllMediaItems ()
	remove all media items More...

	getMediaItemNr ($a_purpose)

	hasFullscreenItem ()

	hasPurposeItem ($purpose)
	returns wether object has media item with specific purpose More...

	read ()
	read media object data from db More...

	setId ($a_id)
	set id More...

	getId ()

	setAlias ($a_is_alias)
	set wether page object is an alias More...

	isAlias ()

	setOriginID ($a_id)

	getOriginID ()

	getImportId ()
	get import id More...

	setImportId ($a_id)

	create ($a_create_meta_data=false, $a_save_media_items=true)
	create media object in db More...

	update ($a_upload=false)
	update media object in db More...

	createDirectory ()
	Create file directory of media object. More...

	getFilesOfDirectory ($a_subdir="")
	Get files of directory. More...

	getXML ($a_mode=IL_MODE_FULL, $a_inst=0, $a_sign_locals=false)
	get MediaObject XLM Tag More...

	handleAmps ($a_str)
	Replace "&" (if not an "&") with "&". More...

	exportXML (&$a_xml_writer, $a_inst=0)
	export XML More...

	exportFiles ($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...

	exportMediaFullscreen ($a_target_dir, $pg_obj)

	modifyExportIdentifier ($a_tag, $a_param, $a_value)

	setContainsIntLink ($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 ($a_include_history=true)
	get all usages of current media object More...

	getDataDirectory ()

	uploadAdditionalFile ($a_name, $tmp_name, $a_subdir="", $a_mode="move_uploaded")
	Create new media object and update page in db and return new media object. More...

	uploadSrtFile ($a_tmp_name, $a_language, $a_mode="move_uploaded")
	Upload srt file. More...

	getSrtFiles ()
	Get srt files. More...

	makeThumbnail ( $a_file, $a_thumbname, $a_format="png", $a_size="80")
	Make thumbnail. More...

	removeAdditionalFile ($a_file)
	Remove additional file. More...

	getLinkedMediaObjects ($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 ($a_prevpic)
	Upload video preview picture. More...

	generatePreviewPic ($a_width, $a_height)
	Upload video preview picture. More...

	getVideoPreviewPic ($a_filename_only=false)
	Get video preview pic. More...

	getMultiSrtUploadDir ()
	Get directory for multi srt upload. More...

	uploadMultipleSubtitleFile ($a_file)
	Upload multi srt file. More...

	clearMultiSrtDirectory ()
	Clear multi feedback directory. More...

	getMultiSrtFiles ()
	Get all srt files of srt multi upload. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	read object data from db into object More...

	getId ()
	get object id public More...

	setId ($a_id)
	set object id public More...

	setRefId ($a_id)
	set reference id public More...

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

	setType ($a_type)
	set object type public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date public More...

	getLastUpdateDate ()
	get last update date public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object 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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks wether a lm content object with specified id exists or not More...

static	_getDirectory ($a_mob_id)
	get directory for files of media object (static) More...

static	_getURL ($a_mob_id)
	get directory for files of media object (static) More...

static	_getThumbnailDirectory ($a_mob_id, $a_mode="filesystem")
	get directory for files of media object (static) More...

static	_lookupStandardItemPath ( $a_mob_id, $a_url_encode=false, $a_web=true)
	Get path for standard item. More...

static	_lookupItemPath ( $a_mob_id, $a_url_encode=false, $a_web=true, $a_purpose="")
	Get path for item with specific purpose. More...

static	_createThumbnailDirectory ($a_obj_id)
	Create thumbnail directory. More...

static	_deleteAllUsages ($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
	static More...

static	_getMobsOfObject ($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
	get mobs of object More...

static	_saveUsage ($a_mob_id, $a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
	Save usage of mob within another container (e.g. More...

static	_removeUsage ($a_mob_id, $a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
	Remove usage of mob in another container. More...

static	lookupUsages ($a_id, $a_include_history=true)
	Lookup usages of media object. More...

static	getParentObjectIdForUsage ($a_usage, $a_include_all_access_obj_ids=false)
	Get's the repository object ID of a parent object, if possible. More...

static	_resizeImage ($a_file, $a_width, $a_height, $a_constrain_prop=false)
	resize image and return new image file ("_width_height" string appended) More...

static	getMimeType ($a_file, $a_external=null)
	get mime type for file More...

static	_determineWidthHeight ( $a_format, $a_type, $a_file, $a_reference, $a_constrain_proportions, $a_use_original, $a_user_width, $a_user_height)
	Determine width and height. More...

static	_getSimpleMimeTypes ()
	Get simple mime types that deactivate parameter property files tab in ILIAS. More...

static	_useAutoStartParameterOnly ($a_loc, $a_format)
	Check whether only autostart parameter should be supported (instead of parameters input field. More...

static	_saveTempFileAsMediaObject ($name, $tmp_name, $upload=true)
	Create new media object and update page in db and return new media object. More...

static	getThumbnailPath ($a_mob_id, $a_thumbname)
	Get thumbnail path. More...

static	getRestrictedFileTypes ()
	Get restricted file types (this is for the input form, this list will be empty, if "allowed list" is empty) More...

static	getForbiddenFileTypes ()
	Get forbidden file types. More...

static	getAllowedFileTypes ()
	Get allowed file types. More...

static	isTypeAllowed ($a_type)
	Is type allowed. More...

static	fixFilename ($a_name)
	Fix filename of uploaded file. More...

static	renameExecutables ($a_dir)
	Rename executables. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
	$is_alias

	$origin_id

	$id

	$media_items

	$contains_int_link

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Protected Member Functions
	escapeProperty ($a_value)
	Escape property (e.g. More...

Static Protected Member Functions
static	handleQuotaUpdate (ilObjMediaObject $a_mob)

Protected Attributes
	$user

	$app_event_handler

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Class ilObjMediaObject.

Todo: this class must be integrated with group/folder handling

ILIAS Media Object

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjMediaObject::__construct ( $a_id = 0 )

Constructor public.

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

References $DIC, array, and user().

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

Here is the call graph for this function:

Member Function Documentation

◆ _createThumbnailDirectory()

static ilObjMediaObject::_createThumbnailDirectory ( $a_obj_id )

static

Create thumbnail directory.

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

References ilUtil\createDirectory(), and ilUtil\getWebspaceDir().

Referenced by ilMediaItem\getThumbnailTarget(), and ilMediaObjectDataSet\importRecord().

     {
         ilUtil::createDirectory(ilUtil::getWebspaceDir() . "/thumbs");
         ilUtil::createDirectory(ilUtil::getWebspaceDir() . "/thumbs/mm_" . $a_obj_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _deleteAllUsages()

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

static

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

References $a_type, $DIC, $ilDB, $row, and array.

Referenced by ilPCMediaObject\beforePageDelete(), ilPageObject\delete(), and ilPCMediaObject\saveMobUsage().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $and_hist = "";
         if ($a_usage_hist_nr !== false) {
             $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));
         }
     }

Here is the caller graph for this function:

◆ _determineWidthHeight()

static ilObjMediaObject::_determineWidthHeight	(	$a_format,
		$a_type,
		$a_file,
		$a_reference,
		$a_constrain_proportions,
		$a_use_original,
		$a_user_width,
		$a_user_height
	)

static

Determine width and height.

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

References $a_type, $DIC, $h, $info, ilObject\$lng, $r, $size, $w, array, ilUtil\deducibleSize(), and ilMediaImageUtil\getImageSize().

Referenced by ilObjMediaPoolGUI\createMediaFromUploadDir(), ilDclMobRecordFieldModel\parseValue(), ilObjMediaObjectGUI\savePropertiesObject(), and ilObjMediaObjectGUI\setObjectPerCreationForm().

       {
         global $DIC;
 
         $lng = $DIC->language();
         
         // 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)) {
             include_once("./Services/MediaObjects/classes/class.ilMediaImageUtil.php");
             if ($a_type == "File") {
                 $size = ilMediaImageUtil::getImageSize($a_file);
             } else {
                 $size = ilMediaImageUtil::getImageSize($a_reference);
             }
         }
 
         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 = (int) $a_user_width;
             $h = (int) $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) ($size[0]/$r);
                         $height = (int) ($size[1]/$r);
                     }
                 }
             }
             //echo "<br>D-$width-$height-";
         }
         //echo "<br>E-$width-$height-";
 
         if ($width == 0 && $a_user_width === "") {
             $width = "";
         }
         if ($height == 0 && $a_user_height === "") {
             $height = "";
         }
 
         return array("width" => $width, "height" => $height, "info" => $info);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _exists()

static ilObjMediaObject::_exists	(	$a_id,
		$a_reference = `false`,
		$a_type = `null`
	)

static

checks wether a lm content object with specified id exists or not

Parameters

int $id id

Returns: boolean true, if lm content object exists

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

References $DIC, $ilDB, ilInternalLink\_extractObjIdOfTarget(), and ilObject\_lookupType().

Referenced by ilInternalLink\_exists(), ilRTE\_getMediaObjects(), assQuestion\addQTIMaterial(), ilObjTest\addQTIMaterial(), ilObjForumGUI\addThreadObject(), assQuestion\delete(), ilForumDraftsHistory\deleteMobs(), ilForumPostDraft\deleteMobsOfDraft(), ilObjForumGUI\deleteMobsOfDraft(), ilForum\deletePost(), ilObjTest\deleteTest(), ilQuestionpoolExport\exportXHTMLMediaObjects(), ilTestExport\exportXHTMLMediaObjects(), ilObjQuestionPool\exportXMLMediaObjects(), ilObjTest\exportXMLMediaObjects(), ilObjForumGUI\getForumObjects(), ilObjForumGUI\publishDraftObject(), ilForumXMLWriter\start(), and ilExSubmissionTextGUI\updateAssignmentTextObject().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         include_once("./Services/Link/classes/class.ilInternalLink.php");
         if (is_int(strpos($a_id, "_"))) {
             $a_id = ilInternalLink::_extractObjIdOfTarget($a_id);
         }
         
         if (parent::_exists($a_id, false) && ilObject::_lookupType($a_id) == "mob") {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getDirectory()

static ilObjMediaObject::_getDirectory ( $a_mob_id )

static

get directory for files of media object (static)

Parameters

int $a_mob_id media object id

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

References ilUtil\getWebspaceDir().

Referenced by ilObjMediaObjectGUI\_getMediaInfoHTML(), ilObjMediaCastAccess\_lookupDiskUsage(), _saveTempFileAsMediaObject(), ilObjMediaCastGUI\convertFileObject(), ilPCInteractiveImageGUI\create(), createDirectory(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilSCORM13Package\dbImportSco(), delete(), ilNewsItem\deliverMobFile(), ilObjMediaCastGUI\determinePlaytimeObject(), duplicate(), ilObjMediaObjectGUI\executeCommand(), ilObjMediaCastGUI\extractPreviewImageObject(), ilPDNewsTableGUI\fillRow(), generatePreviewPic(), ilMediaItem\getDirectory(), getFilesOfDirectory(), ilBlogPostingGUI\getFirstMediaObjectAsTag(), ilObjMediaObjectGUI\getFullscreenSizeObject(), ilDclMobRecordRepresentation\getHTML(), getMultiSrtUploadDir(), ilMediaItem\getOriginalSize(), ilPortfolioTemplatePage\getPageDiskSize(), getSrtFiles(), ilObjMediaObjectGUI\getStandardSizeObject(), getVideoPreviewPic(), ilMediaObjectDataSet\getXmlRecord(), ilMediaObjectDataSet\importRecord(), makeThumbnail(), ilPCMediaObject\modifyPageContentPostXsl(), ilDclMobRecordFieldModel\parseValue(), removeAdditionalFile(), ilObjMediaObjectGUI\resizeImagesObject(), ilObjMediaObjectGUI\savePropertiesObject(), ilObjMediaObjectGUI\setObjectPerCreationForm(), ilPCInteractiveImageGUI\update(), ilObjMediaCastGUI\updateMediaItem(), and uploadAdditionalFile().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getMobsOfObject()

static ilObjMediaObject::_getMobsOfObject	(	$a_type,
		$a_id,
		$a_usage_hist_nr = `0`,
		$a_lang = `"-"`
	)

static

get mobs of object

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

References $a_type, $DIC, $ilDB, $mobs, ilObject\_lookupType(), and array.

Referenced by ilRTE\_cleanupMediaObjectUsage(), SurveyQuestion\addMaterialTag(), ilObjSurvey\addMaterialTag(), ilForumDraftsHistory\addMobsToDraftsHistory(), assQuestion\addQTIMaterial(), ilObjTest\addQTIMaterial(), ilPCMediaObject\afterPageUpdate(), ilObjForumGUI\autosaveDraftAsyncObject(), ilObjForumGUI\autosaveThreadDraftAsyncObject(), ilPCMediaObject\beforePageDelete(), ilCOPageHTMLExport\collectPageElements(), SurveyQuestion\copyXHTMLMediaObjectsOfQuestion(), assQuestion\copyXHTMLMediaObjectsOfQuestion(), SurveyQuestion\delete(), assQuestion\delete(), ilPageObject\delete(), ilForumDraftsHistory\deleteMobs(), ilForumPostDraft\deleteMobsOfDraft(), ilObjForumGUI\deleteMobsOfDraft(), ilForum\deletePost(), ilObjSurvey\deleteSurveyRecord(), ilObjTest\deleteTest(), ilObjForumGUI\editDraftObject(), ilObjGlossary\exportHTMLGlossaryTerms(), ilObjContentObject\exportHTMLGlossaryTerms(), ilObjContentObject\exportHTMLPages(), ilSurveyExport\exportXHTMLMediaObjects(), ilQuestionpoolExport\exportXHTMLMediaObjects(), ilTestExport\exportXHTMLMediaObjects(), ilObjForumGUI\getForumObjects(), ilPageObject\getLastUpdateOfIncludedElements(), ilMepMultiSrt\getMobIds(), ilLMMultiSrt\getMobIds(), ilSoapUtils\getMobsOfObject(), ilCOPageExporter\getXmlExportHeadDependencies(), ilPCMediaObject\modifyPageContentPostXsl(), ilForumUtil\moveMediaObjects(), ilObjForumGUI\publishDraftObject(), ilObjForumGUI\publishThreadDraftObject(), ilPageObject\resolveMediaAliases(), ilForumXMLWriter\start(), assQuestion\syncXHTMLMediaObjectsOfQuestion(), assOrderingHorizontal\toJSON(), assTextSubset\toJSON(), assLongMenu\toJSON(), assImagemapQuestion\toJSON(), assKprimChoice\toJSON(), assSingleChoice\toJSON(), assMultipleChoice\toJSON(), assErrorText\toJSON(), assOrderingQuestion\toJSON(), assMatchingQuestion\toJSON(), and assClozeTest\toJSON().

     {
         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) {
             $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)) {
             if (ilObject::_lookupType($mob_rec["id"]) == "mob") {
                 $mobs[$mob_rec["id"]] = $mob_rec["id"];
             }
         }
 
         return $mobs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getSimpleMimeTypes()

static ilObjMediaObject::_getSimpleMimeTypes ( )

static

Get simple mime types that deactivate parameter property files tab in ILIAS.

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

References array.

Referenced by ilObjMediaObjectGUI\getTabs(), ilPCMediaObjectGUI\initAliasForm(), ilObjMediaObjectGUI\initForm(), and ilObjMediaObjectGUI\savePropertiesObject().

     {
         return array("image/x-ms-bmp", "image/gif", "image/jpeg", "image/x-portable-bitmap",
             "image/png", "image/psd", "image/tiff", "application/pdf");
     }

Here is the caller graph for this function:

◆ _getThumbnailDirectory()

static ilObjMediaObject::_getThumbnailDirectory	(	$a_mob_id,
		$a_mode = `"filesystem"`
	)

static

get directory for files of media object (static)

Parameters

int $a_mob_id media object id

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

References ilUtil\getWebspaceDir().

Referenced by delete(), duplicate(), ilMediaItem\getThumbnailDirectory(), getThumbnailPath(), and makeThumbnail().

     {
         return ilUtil::getWebspaceDir($a_mode) . "/thumbs/mm_" . $a_mob_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getURL()

static ilObjMediaObject::_getURL ( $a_mob_id )

static

get directory for files of media object (static)

Parameters

int $a_mob_id media object id

Returns: string

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

References ilUtil\getHtmlPath(), and ilUtil\getWebspaceDir().

Referenced by ilMediaCastTableGUI\fillRow(), ilDclMobRecordRepresentation\getHTML(), ilNewsTimelineItemGUI\render(), ilObjMediaCastGUI\showGallery(), and ilNewsForContextBlockGUI\showNews().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupItemPath()

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

static

Get path for item with specific purpose.

Parameters

int $a_mob_id media object id

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

References $location, $path, and ilMediaItem\_lookupLocationForMobId().

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

       {
         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 . "/data/" . CLIENT_ID . "/mobs/mm_" . $a_mob_id . "/" . $location;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupStandardItemPath()

static ilObjMediaObject::_lookupStandardItemPath	(	$a_mob_id,
		$a_url_encode = `false`,
		$a_web = `true`
	)

static

Get path for standard item.

Parameters

int $a_mob_id media object id

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

References _lookupItemPath().

Referenced by ilSCORM2004ScoGUI\getExportResources().

       {
         return ilObjMediaObject::_lookupItemPath($a_mob_id, $a_url_encode, $a_web, "Standard");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _removeUsage()

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

static

Remove usage of mob in another container.

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

References $a_type, $DIC, and $ilDB.

Referenced by ilRTE\_cleanupMediaObjectUsage(), ilForumDraftsHistory\addMobsToDraftsHistory(), ilObjForumGUI\addThreadObject(), ilObjForumGUI\autosaveDraftAsyncObject(), ilObjForumGUI\autosaveThreadDraftAsyncObject(), SurveyQuestion\delete(), assQuestion\delete(), ilForumDraftsHistory\deleteMobs(), ilForumPostDraft\deleteMobsOfDraft(), ilObjForumGUI\deleteMobsOfDraft(), ilForum\deletePost(), ilObjSurvey\deleteSurveyRecord(), ilObjTest\deleteTest(), ilObjForumGUI\editDraftObject(), ilObjForumGUI\getForumObjects(), ilForumUtil\moveMediaObjects(), ilObjForumGUI\publishDraftObject(), ilObjForumGUI\publishThreadDraftObject(), and ilExSubmissionTextGUI\updateAssignmentTextObject().

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

Here is the caller graph for this function:

◆ _resizeImage()

static ilObjMediaObject::_resizeImage	(	$a_file,
		$a_width,
		$a_height,
		$a_constrain_prop = `false`
	)

static

resize image and return new image file ("_width_height" string appended)

Parameters

string	$a_file	full file name
int	$a_width	width
int	$a_height	height

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

References $location, and ilUtil\resizeImage().

Referenced by ilDclMobRecordFieldModel\parseValue(), ilObjMediaObjectGUI\resizeImagesObject(), ilObjMediaObjectGUI\savePropertiesObject(), and ilObjMediaObjectGUI\setObjectPerCreationForm().

     {
         $file_path = pathinfo($a_file);
         $location = substr($file_path["basename"], 0, strlen($file_path["basename"]) -
             strlen($file_path["extension"]) - 1) . "_" .
             $a_width . "_" .
             $a_height . "." . $file_path["extension"];
         $target_file = $file_path["dirname"] . "/" .
             $location;
         ilUtil::resizeImage(
             $a_file,
             $target_file,
             (int) $a_width,
             (int) $a_height,
             $a_constrain_prop
         );
 
         return $location;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _saveTempFileAsMediaObject()

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

static

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

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

References $file, $format, $location, $name, $size, _getDirectory(), ilUtil\deducibleSize(), ilMediaImageUtil\getImageSize(), getMimeType(), and ilMediaSvgSanitizer\sanitizeDir().

     {
         // 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());
 
         $media_item = new ilMediaItem();
         $media_object->addMediaItem($media_item);
         $media_item->setPurpose("Standard");
 
         $file = $mob_dir . "/" . $name;
         if ($upload) {
             ilUtil::moveUploadedFile($tmp_name, $name, $file);
         } else {
             copy($tmp_name, $file);
         }
         // get mime type
         $format = ilObjMediaObject::getMimeType($file);
         $location = $name;
         // set real meta and object data
         $media_item->setFormat($format);
         $media_item->setLocation($location);
         $media_item->setLocationType("LocalFile");
         $media_object->setTitle($name);
         $media_object->setDescription($format);
 
         if (ilUtil::deducibleSize($format)) {
             include_once("./Services/MediaObjects/classes/class.ilMediaImageUtil.php");
             $size = ilMediaImageUtil::getImageSize($file);
             $media_item->setWidth($size[0]);
             $media_item->setHeight($size[1]);
         }
         $media_item->setHAlign("Left");
 
         self::renameExecutables($mob_dir);
         include_once("./Services/MediaObjects/classes/class.ilMediaSvgSanitizer.php");
         ilMediaSvgSanitizer::sanitizeDir($mob_dir);     // see #20339
 
         $media_object->update();
 
         return $media_object;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _saveUsage()

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

static

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

page)

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

References $a_type, $DIC, $ilDB, and array.

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $ilDB->replace(
             "mob_usage",
             array(
                 "id" => array("integer", (int) $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", (int) $a_usage_hist_nr)
                 ),
             array()
         );
 
         self::handleQuotaUpdate(new self($a_mob_id));
     }

Here is the caller graph for this function:

◆ _useAutoStartParameterOnly()

static ilObjMediaObject::_useAutoStartParameterOnly	(	$a_loc,
		$a_format
	)

static

Check whether only autostart parameter should be supported (instead of parameters input field.

This should be the same behaviour as mp3/flv in page.xsl

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

References array.

Referenced by ilPCMediaObjectGUI\getAliasValues(), ilObjMediaObjectGUI\getValues(), ilPCMediaObjectGUI\initAliasForm(), ilObjMediaObjectGUI\initForm(), ilPCMediaObjectGUI\saveAliasProperties(), and ilObjMediaObjectGUI\savePropertiesObject().

     {
         $lpath = pathinfo($a_loc);
         if ($lpath["extension"] == "mp3" && $a_format == "audio/mpeg") {
             return true;
         }
         if ($lpath["extension"] == "flv") {
             return true;
         }
         if (in_array($a_format, array("video/mp4", "video/webm"))) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ addMediaItem()

ilObjMediaObject::addMediaItem ( $a_item )

add media item to media object

Parameters

object $a_item media item object

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

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

◆ clearMultiSrtDirectory()

ilObjMediaObject::clearMultiSrtDirectory ( )

Clear multi feedback directory.

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

References ilUtil\delDir(), and getMultiSrtUploadDir().

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

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 1017 of file class.ilObjMediaObject.php.

References $contains_int_link.

     {
         return $this->contains_int_link;
     }

◆ create()

ilObjMediaObject::create	(	$a_create_meta_data = `false`,
		$a_save_media_items = `true`
	)

create media object in db

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

References $app_event_handler, $i, $media_items, array, createMetaData(), getId(), and getMediaItems().

     {
         parent::create();
 
         if (!$a_create_meta_data) {
             $this->createMetaData();
         }
 
         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(
             'Services/MediaObjects',
             'create',
             array('object' => $this,
             'obj_type' => 'mob',
             'obj_id' => $this->getId())
         );
     }

Here is the call graph for this function:

◆ createDirectory()

ilObjMediaObject::createDirectory ( )

Create file directory of media object.

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

References _getDirectory(), ilUtil\createDirectory(), and getId().

     {
         ilUtil::createDirectory(ilObjMediaObject::_getDirectory($this->getId()));
     }

Here is the call graph for this function:

◆ createMetaData()

ilObjMediaObject::createMetaData ( )

create meta data entry

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

References $ilUser, $user, getDescription(), getId(), getTitle(), and ilObject\getType().

Referenced by create().

     {
         include_once 'Services/MetaData/classes/class.ilMDCreator.php';
 
         $ilUser = $this->user;
 
         $md_creator = new ilMDCreator(0, $this->getId(), $this->getType());
         $md_creator->setTitle($this->getTitle());
         $md_creator->setTitleLanguage($ilUser->getPref('language'));
         $md_creator->setDescription($this->getDescription());
         $md_creator->setDescriptionLanguage($ilUser->getPref('language'));
         $md_creator->setKeywordLanguage($ilUser->getPref('language'));
         $md_creator->setLanguage($ilUser->getPref('language'));
         $md_creator->create();
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createReference()

ilObjMediaObject::createReference ( )

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

     {
         $this->ilias->raiseError("Operation ilObjMedia::createReference() not allowed.", $this->ilias->error_obj->FATAL);
     }

◆ delete()

ilObjMediaObject::delete ( )

delete media object

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

References _getDirectory(), _getThumbnailDirectory(), ilUtil\delDir(), ilMediaItem\deleteAllItemsOfMob(), deleteMetaData(), getId(), ilLoggerFactory\getLogger(), and getUsages().

     {
         $mob_logger = ilLoggerFactory::getLogger('mob');
         $mob_logger->debug("ilObjMediaObject: Delete called for media object ID '" . $this->getId() . "'.");
 
         if (!($this->getId() > 0)) {
             return;
         }
 
         $usages = $this->getUsages();
 
         $mob_logger->debug("ilObjMediaObject: ... Found " . count($usages) . " usages.");
 
         if (count($usages) == 0) {
             // remove directory
             ilUtil::delDir(ilObjMediaObject::_getDirectory($this->getId()));
 
             // remove thumbnail directory
             ilUtil::delDir(ilObjMediaObject::_getThumbnailDirectory($this->getId()));
 
             // 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.");
         }
     }

Here is the call graph for this function:

◆ deleteMetaData()

ilObjMediaObject::deleteMetaData ( )

delete meta data entry

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

References getId(), and ilObject\getType().

Referenced by delete().

     {
         // Delete meta data
         include_once('Services/MetaData/classes/class.ilMD.php');
         $md = new ilMD(0, $this->getId(), $this->getType());
         $md->deleteAll();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duplicate()

ilObjMediaObject::duplicate ( )

Duplicate media object, return new media object.

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

References $key, _getDirectory(), _getThumbnailDirectory(), getDescription(), getId(), getMediaItems(), getTitle(), and ilUtil\rCopy().

Referenced by ilDclMobRecordFieldModel\afterClone().

     {
         $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);
 
         // files
         $new_obj->createDirectory();
         self::_createThumbnailDirectory($new_obj->getId());
         ilUtil::rCopy(
             ilObjMediaObject::_getDirectory($this->getId()),
             ilObjMediaObject::_getDirectory($new_obj->getId())
         );
         ilUtil::rCopy(
             ilObjMediaObject::_getThumbnailDirectory($this->getId()),
             ilObjMediaObject::_getThumbnailDirectory($new_obj->getId())
         );
         
         // meta data
         include_once("Services/MetaData/classes/class.ilMD.php");
         $md = new ilMD(0, $this->getId(), "mob");
         $new_md = $md->cloneMD(0, $new_obj->getId(), "mob");
 
         return $new_obj;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ escapeProperty()

ilObjMediaObject::escapeProperty ( $a_value )

protected

Escape property (e.g.

title, caption) to XSLT -> HTML output

Parameters

string $a_value

Returns: string

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

Referenced by getXML().

     {
         return htmlspecialchars($a_value);
     }

Here is the caller graph for this function:

◆ exportFiles()

ilObjMediaObject::exportFiles ( $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

Parameters

string $a_target_dir target directory

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

References getId(), ilUtil\getWebspaceDir(), ilUtil\makeDir(), and ilUtil\rCopy().

     {
         $subdir = "il_" . IL_INST_ID . "_mob_" . $this->getId();
         ilUtil::makeDir($a_target_dir . "/objects/" . $subdir);
 
         $mobdir = ilUtil::getWebspaceDir() . "/mobs/mm_" . $this->getId();
         ilUtil::rCopy($mobdir, $a_target_dir . "/objects/" . $subdir);
         //echo "from:$mobdir:to:".$a_target_dir."/objects/".$subdir.":<br>";
     }

Here is the call graph for this function:

◆ exportMediaFullscreen()

ilObjMediaObject::exportMediaFullscreen	(	$a_target_dir,
		$pg_obj
	)

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

References $_GET, $output, $params, $tpl, $xml, ilMediaItem\_getMapAreasIntLinks(), array, ilPlayerUtil\getFlashVideoPlayerDirectory(), getId(), getXML(), IL_MODE_OUTPUT, ilUtil\makeDir(), xslt_create(), and xslt_free().

     {
         $subdir = "il_" . IL_INST_ID . "_mob_" . $this->getId();
         $a_target_dir = $a_target_dir . "/objects/" . $subdir;
         ilUtil::makeDir($a_target_dir);
         $tpl = new ilTemplate("tpl.fullscreen.html", true, true, "Modules/LearningModule");
         $tpl->setCurrentBlock("ilMedia");
 
         //$int_links = $page_object->getInternalLinks();
         $med_links = ilMediaItem::_getMapAreasIntLinks($this->getId());
 
         // @todo
         //$link_xml = $this->getLinkXML($med_links, $this->getLayoutLinkTargets());
 
         require_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
         //$media_obj = new ilObjMediaObject($_GET["mob_id"]);
         require_once("./Services/COPage/classes/class.ilPageObject.php");
 
         $xml = "<dummy>";
         // todo: we get always the first alias now (problem if mob is used multiple
         // times in page)
         $xml.= $pg_obj->getMediaAliasElement($this->getId());
         $xml.= $this->getXML(IL_MODE_OUTPUT);
         //$xml.= $link_xml;
         $xml.="</dummy>";
         
         //die(htmlspecialchars($xml));
 
         $xsl = file_get_contents("./Services/COPage/xsl/page.xsl");
         $args = array( '/_xml' => $xml, '/_xsl' => $xsl );
         $xh = xslt_create();
 
         //echo "<b>XML:</b>".htmlentities($xml);
         // determine target frames for internal links
         $wb_path = "";
         $enlarge_path = "";
         $params = array('mode' => "fullscreen", 'enlarge_path' => $enlarge_path,
             'link_params' => "ref_id=" . $_GET["ref_id"],'fullscreen_link' => "",
             'ref_id' => $_GET["ref_id"], 'webspace_path' => $wb_path);
         $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", null, $args, $params);
         //echo xslt_error($xh);
         xslt_free($xh);
 
         // unmask user html
         include_once("./Services/MediaObjects/classes/class.ilPlayerUtil.php");
         $tpl->setVariable("LOCATION_CONTENT_STYLESHEET", "../../css/style.css");
         $tpl->setVariable("LOCATION_STYLESHEET", "../../css/system.css");
         $tpl->setVariable("MEDIA_CONTENT", $output);
         $output = $tpl->get();
         //$output = preg_replace("/\/mobs\/mm_(\d+)\/([^\"]+)/i","$2",$output);
         $output = preg_replace("/mobs\/mm_(\d+)\/([^\"]+)/i", "$2", $output);
         $output = preg_replace("/\.\/Services\/MediaObjects\/flash_mp3_player/i", "../../players", $output);
         $output = preg_replace("/\.\/" . str_replace("/", "\/", ilPlayerUtil::getFlashVideoPlayerDirectory()) . "/i", "../../players", $output);
         $output = preg_replace("/file=..\/..\/..\//i", "file=../objects/" . $subdir . "/", $output);
         //die(htmlspecialchars($output));
         fwrite(fopen($a_target_dir . '/fullscreen.html', 'w'), $output);
     }

Here is the call graph for this function:

◆ exportXML()

ilObjMediaObject::exportXML	(	&	$a_xml_writer,
			$a_inst = `0`
	)

export XML

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

References getXML(), and IL_MODE_FULL.

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

Here is the call graph for this function:

◆ fixFilename()

static ilObjMediaObject::fixFilename ( $a_name )

static

Fix filename of uploaded file.

Parameters

string $a_name upload file name

Returns: string fixed file name

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

References array, and ilUtil\getASCIIFilename().

Referenced by ilObjMediaObjectGUI\savePropertiesObject(), ilObjMediaObjectGUI\setObjectPerCreationForm(), and ilObjMediaObjectGUI\uploadFileObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generatePreviewPic()

ilObjMediaObject::generatePreviewPic	(	$a_width,
		$a_height
	)

Upload video preview picture.

Parameters

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

References $file, _getDirectory(), ilUtil\convertImage(), ilUtil\escapeShellArg(), ilUtil\execConvert(), getId(), getMediaItem(), and ilUtil\isConvertVersionAtLeast().

Referenced by ilObjMediaCastGUI\saveCastItemObject().

     {
         $item = $this->getMediaItem("Standard");
 
         if ($item->getLocationType() == "LocalFile" &&
             is_int(strpos($item->getFormat(), "image/"))) {
             $dir = ilObjMediaObject::_getDirectory($this->getId());
             $file = $dir . "/" .
                 $item->getLocation();
             if (is_file($file)) {
                 if (ilUtil::isConvertVersionAtLeast("6.3.8-3")) {
                     ilUtil::execConvert(ilUtil::escapeShellArg($file) . "[0] -geometry " . $a_width . "x" . $a_height . "^ -gravity center -extent " . $a_width . "x" . $a_height . " PNG:" . $dir . "/mob_vpreview.png");
                 } else {
                     ilUtil::convertImage($file, $dir . "/mob_vpreview.png", "PNG", $a_width . "x" . $a_height);
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllowedFileTypes()

static ilObjMediaObject::getAllowedFileTypes ( )

static

Get allowed file types.

Returns: array

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

References array.

     {
         $mset = new ilSetting("mobs");
         if (trim($mset->get("restricted_file_types")) == "") {
             return array();
         }
         return array_map(
             function ($v) {
                 return strtolower(trim($v));
             },
             explode(",", $mset->get("restricted_file_types"))
         );
     }

◆ getDataDirectory()

ilObjMediaObject::getDataDirectory ( )

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

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

Referenced by getXML(), and handleQuotaUpdate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription()

ilObjMediaObject::getDescription ( )

get description of media object

Returns: string description

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

Referenced by createMetaData(), duplicate(), and updateMetaData().

     {
         return parent::getDescription();
     }

Here is the caller graph for this function:

◆ getFilesOfDirectory()

ilObjMediaObject::getFilesOfDirectory ( $a_subdir = "" )

Get files of directory.

Parameters

string $a_subdir subdirectry

Returns: array array of files

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

References $files, _getDirectory(), array, ilUtil\getDir(), and getId().

     {
         $a_subdir = str_replace("..", "", $a_subdir);
         $dir = ilObjMediaObject::_getDirectory($this->getId());
         if ($a_subdir != "") {
             $dir.= "/" . $a_subdir;
         }
         
         $files = array();
         if (is_dir($dir)) {
             $entries = ilUtil::getDir($dir);
             foreach ($entries as $e) {
                 if (is_file($dir . "/" . $e["entry"]) && $e["entry"] != "." && $e["entry"] != "..") {
                     $files[] = $e["entry"];
                 }
             }
         }
  
         return $files;
     }

Here is the call graph for this function:

◆ getForbiddenFileTypes()

static ilObjMediaObject::getForbiddenFileTypes ( )

static

Get forbidden file types.

Returns: array

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

References array.

Referenced by ilObjMediaObjectGUI\executeCommand(), and ilObjMediaObjectGUI\initForm().

     {
         $mset = new ilSetting("mobs");
         if (trim($mset->get("black_list_file_types")) == "") {
             return array();
         }
         return array_map(
             function ($v) {
                 return strtolower(trim($v));
             },
             explode(",", $mset->get("black_list_file_types"))
         );
     }

Here is the caller graph for this function:

◆ getId()

ilObjMediaObject::getId ( )

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

References $id.

Referenced by ilDclMobRecordFieldModel\afterClone(), create(), createDirectory(), createMetaData(), delete(), deleteMetaData(), duplicate(), exportFiles(), exportMediaFullscreen(), generatePreviewPic(), getDataDirectory(), getFilesOfDirectory(), getMultiSrtUploadDir(), getSrtFiles(), getUsages(), getVideoPreviewPic(), getXML(), handleQuotaUpdate(), makeThumbnail(), MDUpdateListener(), removeAdditionalFile(), removeMediaItem(), update(), updateMetaData(), and uploadAdditionalFile().

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getImportId()

ilObjMediaObject::getImportId ( )

get import id

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

References ilObject\$import_id.

     {
         return $this->import_id;
     }

◆ getLinkedMediaObjects()

ilObjMediaObject::getLinkedMediaObjects ( $a_ignore = "" )

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

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

References ilObject\_exists(), ilInternalLink\_extractObjIdOfTarget(), ilMapArea\_getIntLinks(), array, and getMediaItems().

     {
         $linked = array();
         
         if (!is_array($a_ignore)) {
             $a_ignore = 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") {
                     include_once("./Services/Link/classes/class.ilInternalLink.php");
                     $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;
     }

Here is the call graph for this function:

◆ getMediaItem()

& ilObjMediaObject::getMediaItem ( $a_purpose )

get item for media purpose

Parameters

string $a_purpose

Returns: ilMediaItem

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

Referenced by ilObjMediaCastGUI\editCastItemObject(), generatePreviewPic(), ilObjMediaCastGUI\getMediaItem(), hasPurposeItem(), and ilNewsTimelineItemGUI\render().

     {
         foreach ($this->media_items as $media_item) {
             if ($media_item->getPurpose() == $a_purpose) {
                 return $media_item;
             }
         }
         return false;
     }

Here is the caller graph for this function:

◆ getMediaItemNr()

ilObjMediaObject::getMediaItemNr ( $a_purpose )

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

References $i.

     {
         for ($i=0; $i<count($this->media_items); $i++) {
             if ($this->media_items[$i]->getPurpose() == $a_purpose) {
                 return $i + 1;
             }
         }
         return false;
     }

◆ getMediaItems()

& ilObjMediaObject::getMediaItems ( )

get all media items

Returns: array array of media item objects

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

References $media_items.

Referenced by create(), duplicate(), getLinkedMediaObjects(), ilObjMediaCastGUI\getMediaItems(), getXML(), and update().

     {
         return $this->media_items;
     }

Here is the caller graph for this function:

◆ getMimeType()

static ilObjMediaObject::getMimeType	(	$a_file,
		$a_external = `null`
	)

static

get mime type for file

Parameters

string $a_file file name

Returns: string mime type static

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

References ilMimeTypeUtil\APPLICATION__OCTET_STREAM, and ilMimeTypeUtil\lookupMimeType().

Referenced by _saveTempFileAsMediaObject(), ilExAssignmentGUI\addFiles(), ilObjMediaObjectGUI\assignFullscreenObject(), ilObjMediaObjectGUI\assignStandardObject(), ilKprimChoiceWizardInputGUI\checkUploads(), ilPCInteractiveImageGUI\create(), ilFileUtils\createFile(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilSCORM13Package\dbImportSco(), ilPublicUserProfileGUI\deliverVCard(), ilSCORM13Player\getMimetype(), ilMediaPlayerGUI\getMp3PlayerHtml(), ilDclMobRecordFieldModel\parseValue(), ilObjMediaObjectGUI\savePropertiesObject(), assSingleChoice\setImageFile(), assMultipleChoice\setImageFile(), ilObjMediaObjectGUI\setObjectPerCreationForm(), ilPCInteractiveImageGUI\update(), ilObjMediaCastGUI\updateMediaItem(), ilFSStorageExercise5069\uploadFile(), and ilFSStorageExercise\uploadFile().

     {
         include_once("./Services/Utilities/classes/class.ilMimeTypeUtil.php");
         $mime = ilMimeTypeUtil::lookupMimeType($a_file, ilMimeTypeUtil::APPLICATION__OCTET_STREAM, $a_external);
         return $mime;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMultiSrtFiles()

ilObjMediaObject::getMultiSrtFiles ( )

Get all srt files of srt multi upload.

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

References $files, $i, $lang, ilMDLanguageItem\_getPossibleLanguageCodes(), array, ilUtil\getDir(), and getMultiSrtUploadDir().

     {
         $items = array();
 
         include_once("./Services/MetaData/classes/class.ilMDLanguageItem.php");
         $lang_codes = ilMDLanguageItem::_getPossibleLanguageCodes();
 
         $dir = $this->getMultiSrtUploadDir();
         $files = ilUtil::getDir($dir);
         foreach ($files as $k => $i) {
             // check directory
             if ($i["type"] == "file" && !in_array($k, array(".", ".."))) {
                 if (pathinfo($k, PATHINFO_EXTENSION) == "srt") {
                     $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;
     }

Here is the call graph for this function:

◆ getMultiSrtUploadDir()

ilObjMediaObject::getMultiSrtUploadDir ( )

Get directory for multi srt upload.

Parameters

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

References _getDirectory(), and getId().

Referenced by clearMultiSrtDirectory(), getMultiSrtFiles(), and uploadMultipleSubtitleFile().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOriginID()

ilObjMediaObject::getOriginID ( )

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

References $origin_id.

     {
         return $this->origin_id;
     }

◆ getParentObjectIdForUsage()

static ilObjMediaObject::getParentObjectIdForUsage	(	$a_usage,
		$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 1237 of file class.ilObjMediaObject.php.

References $id, ilObject\$type, ilPCQuestion\_getPageForQuestionId(), assQuestion\_getQuestionInfo(), SurveyQuestion\_instanciateQuestion(), ilGlossaryTerm\_lookGlossaryID(), ilNewsItem\_lookupContextObjId(), ilLMObject\_lookupContObjID(), ilForum\_lookupObjIdForForumId(), ilSCORM2004Node\_lookupSLMID(), SurveyQuestion\_lookupSurveyObjId(), ilGlossaryDefinition\_lookupTermId(), ilObjTest\_lookupTestObjIdForQuestionId(), ilObject\_lookupType(), ilPortfolioPage\findPortfolioForPage(), ilExSubmission\lookupExerciseIdForReturnedId(), ilWikiPage\lookupObjIdByPage(), ilPageObject\lookupParentId(), and ilForumPostDraft\newInstanceByDraftId().

Referenced by ilObjMediaObjectAccess\checkAccessMob(), ilMediaObjectUsagesTableGUI\fillRow(), and handleQuotaUpdate().

     {
         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 = false;
         
         switch ($type) {
             // RTE / tiny mce
             case "html":
                 
                 switch ($cont_type) {
                     case "qpl":
                         // Question Pool *Question* Text (Test)
                         include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
                         $qinfo = assQuestion::_getQuestionInfo($id);
                         if ($qinfo["original_id"] > 0) {
                             include_once("./Modules/Test/classes/class.ilObjTest.php");
                             $obj_id = ilObjTest::_lookupTestObjIdForQuestionId($id);    // usage in test
                         } else {
                             $obj_id = $qinfo["obj_fi"];         // usage in pool
                         }
                         break;
                         
                     case "spl":
                         // Question Pool *Question* Text (Survey)
                         include_once("./Modules/SurveyQuestionPool/classes/class.SurveyQuestion.php");
                         $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 = SurveyQuestion::_lookupSurveyObjId($id);
                             }
                             // original question (in pool or survey)
                             else {
                                 $obj_id = $parent_id;
                             }
                             
                             unset($quest);
                         }
                         break;
                         
                     case "exca":
                         // Exercise assignment
                         $returned_pk = $a_usage['id'];
                         // #15995 - we are just checking against exercise object
                         include_once 'Modules/Exercise/classes/class.ilExSubmission.php';
                         $obj_id = ilExSubmission::lookupExerciseIdForReturnedId($returned_pk);
                         break;
                     
                     case "frm":
                         // Forum
                         $post_pk = $a_usage['id'];
                         include_once 'Modules/Forum/classes/class.ilForumPost.php';
                         include_once 'Modules/Forum/classes/class.ilForum.php';
                         $oPost = new ilForumPost($post_pk);
                         $frm_pk =  $oPost->getForumId();
                         $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
                         break;
                     
                     
                     case "frm~d":
                         $draft_id = $a_usage['id'];
                         include_once 'Modules/Forum/classes/class.ilForumPostDraft.php';
                         include_once 'Modules/Forum/classes/class.ilForum.php';
                         $oDraft = ilForumPostDraft::newInstanceByDraftId($draft_id);
                         
                         $frm_pk =  $oDraft->getForumId();
                         $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
                         break;
                     case "frm~h":
                         $history_id = $a_usage['id'];
                         include_once 'Modules/Forum/classes/class.ilForumDraftsHistory.php';
                         include_once 'Modules/Forum/classes/class.ilForumPostDraft.php';
                         include_once 'Modules/Forum/classes/class.ilForum.php';
                         $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 = $a_usage['id'];
                         break;
                     
                     // "old" category pages
                     case "cat":
                     // InfoScreen Text
                     case "tst":
                     case "svy":
                     // data collection
                     case "dcl":
                         $obj_id = $id;
                         break;
                 }
                 break;
                 
             // page editor
             case "pg":
                 
                 switch ($cont_type) {
                     // question feedback // parent obj id is q id
                     case "qfbg":
                         include_once('./Services/COPage/classes/class.ilPageObject.php');
                         $id = ilPageObject::lookupParentId($id, 'qfbg');
                         // note: no break here, we only altered the $id to the question id
 
                         // no break
                     case "qpl":
                         // Question Pool Question Pages
                         include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
                         $qinfo = assQuestion::_getQuestionInfo($id);
                         if ($qinfo["original_id"] > 0) {
                             include_once("./Modules/Test/classes/class.ilObjTest.php");
                             $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
                             include_once("./Services/COPage/classes/class.ilPCQuestion.php");
                             $pinfo = ilPCQuestion::_getPageForQuestionId($id, "lm");
                             if ($pinfo && $pinfo["parent_type"] == "lm") {
                                 include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                                 $obj_id = ilLMObject::_lookupContObjID($pinfo["page_id"]);
                             }
                             $pinfo = ilPCQuestion::_getPageForQuestionId($id, "sahs");
                             if ($pinfo && $pinfo["parent_type"] == "sahs") {
                                 include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Node.php");
                                 $obj_id = ilSCORM2004Node::_lookupSLMID($pinfo["page_id"]);
                             }
                         }
                         break;
                         
                     case "lm":
                         // learning modules
                         include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                         $obj_id = ilLMObject::_lookupContObjID($id);
                         break;
                 
                     case "gdf":
                         // glossary definition
                         include_once("./Modules/Glossary/classes/class.ilGlossaryDefinition.php");
                         include_once("./Modules/Glossary/classes/class.ilGlossaryTerm.php");
                         $term_id = ilGlossaryDefinition::_lookupTermId($id);
                         $obj_id = ilGlossaryTerm::_lookGlossaryID($term_id);
                         break;
                     
                     case "wpg":
                         // wiki page
                         include_once 'Modules/Wiki/classes/class.ilWikiPage.php';
                         $obj_id = ilWikiPage::lookupObjIdByPage($id);
                         break;
                     
                     case "sahs":
                         // sahs page
                         // can this implementation be used for other content types, too?
                         include_once('./Services/COPage/classes/class.ilPageObject.php');
                         $obj_id = ilPageObject::lookupParentId($id, 'sahs');
                         break;
                     
                     case "prtf":
                         // portfolio
                         include_once "Modules/Portfolio/classes/class.ilPortfolioPage.php";
                         $obj_id = ilPortfolioPage::findPortfolioForPage($id);
                         break;
                     
                     case "prtt":
                         // portfolio template
                         include_once "Modules/Portfolio/classes/class.ilPortfolioTemplatePage.php";
                         $obj_id = ilPortfolioTemplatePage::findPortfolioForPage($id);
                         break;
                     
                     case "blp":
                         // blog
                         include_once('./Services/COPage/classes/class.ilPageObject.php');
                         $obj_id = ilPageObject::lookupParentId($id, 'blp');
                         break;
                     
                     case "impr":
                         // imprint page - always id 1
                         // fallthrough
                         
                     case "crs":
                     case "grp":
                     case "cat":
                     case "fold":
                     case "root":
                     case "cont":
                     case "cstr":
                         // repository pages
                         $obj_id = $id;
                         break;
                 }
                 break;
                 
             // Media Pool
             case "mep":
                 $obj_id = $id;
                 break;
 
             // News Context Object (e.g. MediaCast)
             case "news":
                 include_once("./Services/News/classes/class.ilNewsItem.php");
                 $obj_id = ilNewsItem::_lookupContextObjId($id);
                 break;
         }
         
         return $obj_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilObjMediaObject::getRefId ( )

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

     {
         return false;
     }

◆ getRestrictedFileTypes()

static ilObjMediaObject::getRestrictedFileTypes ( )

static

Get restricted file types (this is for the input form, this list will be empty, if "allowed list" is empty)

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

Referenced by ilObjMediaObjectGUI\executeCommand(), and ilObjMediaObjectGUI\initForm().

     {
         return array_filter(self::getAllowedFileTypes(), function ($v) {
             return !in_array($v, self::getForbiddenFileTypes());
         });
     }

Here is the caller graph for this function:

◆ getSrtFiles()

ilObjMediaObject::getSrtFiles ( )

Get srt files.

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

References $i, $name, _getDirectory(), array, ilUtil\getDir(), and getId().

Referenced by getXML().

     {
         $srt_dir = ilObjMediaObject::_getDirectory($this->getId()) . "/srt";
         
         if (!is_dir($srt_dir)) {
             return array();
         }
         
         $items = ilUtil::getDir($srt_dir);
 
         $srt_files = array();
         foreach ($items as $i) {
             if (!in_array($i["entry"], array(".", "..")) && $i["type"] == "file") {
                 $name = explode(".", $i["entry"]);
                 if ($name[1] == "srt" && substr($name[0], 0, 9) == "subtitle_") {
                     $srt_files[] = array("file" => $i["entry"],
                         "full_path" => "srt/" . $i["entry"], "language" => substr($name[0], 9, 2));
                 }
             }
         }
         
         return $srt_files;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThumbnailPath()

static ilObjMediaObject::getThumbnailPath	(	$a_mob_id,
		$a_thumbname
	)

static

Get thumbnail path.

Parameters

string $a_thumbname thumbnail file name

Returns: string thumbnail path

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

References _getThumbnailDirectory().

Referenced by ilPCIIMOverlaysTableGUI\fillRow().

     {
         $t_dir = ilObjMediaObject::_getThumbnailDirectory($a_mob_id);
         return $t_dir . "/" . $a_thumbname;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilObjMediaObject::getTitle ( )

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

Referenced by createMetaData(), duplicate(), getXML(), and updateMetaData().

     {
         return parent::getTitle();
     }

Here is the caller graph for this function:

◆ getUsages()

ilObjMediaObject::getUsages ( $a_include_history = true )

get all usages of current media object

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

References getId().

Referenced by delete(), and handleQuotaUpdate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVideoPreviewPic()

ilObjMediaObject::getVideoPreviewPic ( $a_filename_only = false )

Get video preview pic.

Parameters

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

References _getDirectory(), array, and getId().

Referenced by ilObjMediaCastGUI\getCastItemValues(), and uploadVideoPreviewPic().

     {
         $dir = ilObjMediaObject::_getDirectory($this->getId());
         $ppics = array("mob_vpreview.jpg",
             "mob_vpreview.jpeg",
             "mob_vpreview.png");
         foreach ($ppics as $p) {
             if (is_file($dir . "/" . $p)) {
                 if ($a_filename_only) {
                     return $p;
                 } else {
                     return $dir . "/" . $p;
                 }
             }
         }
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXML()

ilObjMediaObject::getXML	(	$a_mode = `IL_MODE_FULL`,
		$a_inst = `0`,
		$a_sign_locals = `false`
	)

get MediaObject XLM Tag

Parameters

int $a_mode IL_MODE_ALIAS | IL_MODE_OUTPUT | IL_MODE_FULL

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

References $def, $i, $ilUser, $location, $media_items, $name, $user, $xml, escapeProperty(), getDataDirectory(), getId(), getMediaItems(), getSrtFiles(), getTitle(), ilObject\getType(), handleAmps(), IL_MODE_ALIAS, IL_MODE_FULL, IL_MODE_OUTPUT, ilUtil\secureUrl(), and ilWACSignedPath\signFile().

Referenced by exportMediaFullscreen(), and exportXML().

     {
         $ilUser = $this->user;
         
         // TODO: full implementation of all parameters
         //echo "-".$a_mode."-";
         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=\"$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") {
                         require_once 'Services/WebAccessChecker/classes/class.ilWACSignedPath.php';
                         $location = ilWACSignedPath::signFile($this->getDataDirectory() . "/" . $item->getLocation());
                         $location = substr($location, strrpos($location, "/") + 1);
                     } else {
                         $location = $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>" .
                             str_replace("&", "&amp;", $this->getTitle()) . "</Title>";
                     }
 
                     // Parameter
                     $parameters = $item->getParameters();
                     foreach ($parameters as $name => $value) {
                         $xml .= "<Parameter Name=\"$name\" Value=\"$value\"/>";
                     }
                     $xml .= $item->getMapAreasXML();
                     
                     // Subtitles
                     if ($item->getPurpose() == "Standard") {
                         $srts = $this->getSrtFiles();
                         foreach ($srts as $srt) {
                             $def = "";
                             $meta_lang = "";
                             if ($ilUser->getLanguage() != $meta_lang &&
                                 $ilUser->getLanguage() == $srt["language"]) {
                                 $def = ' Default="true" ';
                             }
                             $xml .= "<Subtitle File=\"" . $srt["full_path"] .
                                 "\" Language=\"" . $srt["language"] . "\" " . $def . "/>";
                         }
                     }
                     $xml .= "</MediaItem>";
                 }
                 break;
 
             // full xml for export
             case IL_MODE_FULL:
 
 //                              $meta = $this->getMetaData();
                 $xml = "<MediaObject>";
 
                 // meta data
                 include_once("Services/MetaData/classes/class.ilMD2XML.php");
                 $md2xml = new ilMD2XML(0, $this->getId(), $this->getType());
                 $md2xml->setExportMode(true);
                 $md2xml->startExport();
                 $xml.= $md2xml->getXML();
 
                 $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleAmps()

ilObjMediaObject::handleAmps ( $a_str )

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

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

Referenced by getXML().

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

Here is the caller graph for this function:

◆ handleQuotaUpdate()

static ilObjMediaObject::handleQuotaUpdate ( ilObjMediaObject $a_mob )

staticprotected

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

References $DIC, $ilSetting, array, getDataDirectory(), getId(), getParentObjectIdForUsage(), ilObject\getType(), getUsages(), and ilDiskQuotaHandler\handleUpdatedSourceObject().

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         // if neither workspace nor portfolios are activated, we skip
         // the quota update here. this due to performance reasons on installations
         // that do not use workspace/portfolios, but heavily copy content.
         // in extreme cases (media object in pool and personal blog, deactivate workspace, change media object,
         // this may lead to incorrect data in the quota calculation)
         if ($ilSetting->get("disable_personal_workspace") && !$ilSetting->get('user_portfolios')) {
             return;
         }
 
         $parent_obj_ids = array();
         foreach ($a_mob->getUsages() as $item) {
             $parent_obj_id = $a_mob->getParentObjectIdForUsage($item);
             if ($parent_obj_id &&
                 !in_array($parent_obj_id, $parent_obj_ids)) {
                 $parent_obj_ids[]= $parent_obj_id;
             }
         }
         
         // we could suppress this if object is present in a (repository) media pool
         // but this would lead to "quota-breaches" when the pool item is deleted
         // and "suddenly" all workspace owners get filesize added to their
         // respective quotas, regardless of current status
         
         include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
         ilDiskQuotaHandler::handleUpdatedSourceObject(
             $a_mob->getType(),
             $a_mob->getId(),
             ilUtil::dirSize($a_mob->getDataDirectory()),
             $parent_obj_ids
         );
     }

Here is the call graph for this function:

◆ hasFullscreenItem()

ilObjMediaObject::hasFullscreenItem ( )

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

References hasPurposeItem().

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

Here is the call graph for this function:

◆ hasPurposeItem()

ilObjMediaObject::hasPurposeItem ( $purpose )

returns wether object has media item with specific purpose

Parameters

string $purpose

Returns: boolean

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

References getMediaItem().

Referenced by hasFullscreenItem().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAlias()

ilObjMediaObject::isAlias ( )

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

References $is_alias.

     {
         return $this->is_alias;
     }

◆ isTypeAllowed()

static ilObjMediaObject::isTypeAllowed ( $a_type )

static

Is type allowed.

Parameters

string $a_type

Returns: bool

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

References $a_type.

Referenced by ilPageObjectGUI\showPage().

     {
         if (in_array($a_type, self::getForbiddenFileTypes())) {
             return false;
         }
         if (count(self::getAllowedFileTypes()) == 0 || in_array($a_type, self::getAllowedFileTypes())) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ lookupUsages()

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

static

Lookup usages of media object.

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

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

References $DIC, $ilDB, $ret, $user, $users, ilPageObject\_exists(), ilObjUser\_getUsersForClipboadObject(), ilNewsItem\_lookupMediaObjectUsages(), and array.

Referenced by ilObjMediaObjectAccess\checkAccessMob(), and ilLMObject\updateInternalLinks().

     {
         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 = "";
             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") {
                 include_once("./Services/COPage/classes/class.ilPageObject.php");
                 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"]);
             }
         }
 
         // 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)
         include_once("./Services/News/classes/class.ilNewsItem.php");
         $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeThumbnail()

ilObjMediaObject::makeThumbnail	(	$a_file,
		$a_thumbname,
		$a_format = `"png"`,
		$a_size = `"80"`
	)

Make thumbnail.

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

References _getDirectory(), _getThumbnailDirectory(), ilUtil\convertImage(), and getId().

       {
         $m_dir = ilObjMediaObject::_getDirectory($this->getId());
         $t_dir = ilObjMediaObject::_getThumbnailDirectory($this->getId());
         self::_createThumbnailDirectory($this->getId());
         ilUtil::convertImage(
             $m_dir . "/" . $a_file,
             $t_dir . "/" . $a_thumbname,
             $a_format,
             $a_size
         );
     }

Here is the call graph for this function:

◆ MDUpdateListener()

ilObjMediaObject::MDUpdateListener ( $a_element )

Meta data update listener.

Important note: Do never call create() or update() method of ilObject here. It would result in an endless loop: update object -> update meta -> update object -> ... Use static _writeTitle() ... methods instead.

Parameters

string $a_element

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

References $id, ilObject\_writeDescription(), ilObject\_writeTitle(), getId(), ilObject\getType(), setDescription(), and setTitle().

     {
         include_once 'Services/MetaData/classes/class.ilMD.php';
 
         switch ($a_element) {
             case 'General':
 
                 // Update Title and description
                 $md = new ilMD(0, $this->getId(), $this->getType());
                 $md_gen = $md->getGeneral();
 
                 if (is_object($md_gen)) {
                     ilObject::_writeTitle($this->getId(), $md_gen->getTitle());
                     $this->setTitle($md_gen->getTitle());
     
                     foreach ($md_gen->getDescriptionIds() as $id) {
                         $md_des = $md_gen->getDescription($id);
                         ilObject::_writeDescription($this->getId(), $md_des->getDescription());
                         $this->setDescription($md_des->getDescription());
                         break;
                     }
                 }
 
                 break;
 
             default:
         }
         return true;
     }

Here is the call graph for this function:

◆ modifyExportIdentifier()

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

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

References ilUtil\insertInstIntoID().

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

Here is the call graph for this function:

◆ putInTree()

ilObjMediaObject::putInTree ( $a_parent_ref )

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

     {
         $this->ilias->raiseError("Operation ilObjMedia::putInTree() not allowed.", $this->ilias->error_obj->FATAL);
     }

◆ read()

ilObjMediaObject::read ( )

read media object data from db

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

References ilMediaItem\_getMediaItemsOfMOb().

     {
         //echo "<br>ilObjMediaObject:read";
         parent::read();
 
         // get media items
         ilMediaItem::_getMediaItemsOfMOb($this);
     }

Here is the call graph for this function:

◆ removeAdditionalFile()

ilObjMediaObject::removeAdditionalFile ( $a_file )

Remove additional file.

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

References $file, _getDirectory(), and getId().

Referenced by uploadVideoPreviewPic().

     {
         $file = str_replace("..", "", $a_file);
         $file = ilObjMediaObject::_getDirectory($this->getId()) . "/" . $file;
         if (is_file($file)) {
             unlink($file);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAllMediaItems()

ilObjMediaObject::removeAllMediaItems ( )

remove all media items

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

References array.

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

◆ removeMediaItem()

ilObjMediaObject::removeMediaItem ( $a_purpose )

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

References $i, $key, $media_items, array, and getId().

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

Here is the call graph for this function:

◆ renameExecutables()

static ilObjMediaObject::renameExecutables ( $a_dir )

static

Rename executables.

Parameters

string

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

References ilUtil\renameExecutables(), and ilUtil\rRenameSuffix().

Referenced by ilObjMediaObjectGUI\executeCommand(), ilMediaObjectDataSet\importRecord(), ilObjMediaObjectGUI\savePropertiesObject(), ilObjMediaObjectGUI\setObjectPerCreationForm(), and ilObjMediaObjectGUI\uploadFileObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAlias()

ilObjMediaObject::setAlias ( $a_is_alias )

set wether page object is an alias

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

     {
         $this->is_alias = $a_is_alias;
     }

◆ setContainsIntLink()

ilObjMediaObject::setContainsIntLink ( $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)

Parameters

boolean $a_contains_link true, if page contains intern link tag(s)

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

     {
         $this->contains_int_link = $a_contains_link;
     }

◆ setDescription()

ilObjMediaObject::setDescription ( $a_description )

set description of media object

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

Referenced by MDUpdateListener().

     {
         parent::setDescription($a_description);
     }

Here is the caller graph for this function:

◆ setId()

ilObjMediaObject::setId ( $a_id )

set id

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

     {
         $this->id = $a_id;
     }

◆ setImportId()

ilObjMediaObject::setImportId ( $a_id )

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

     {
         $this->import_id = $a_id;
     }

◆ setOriginID()

ilObjMediaObject::setOriginID ( $a_id )

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

     {
         return $this->origin_id = $a_id;
     }

◆ setRefId()

ilObjMediaObject::setRefId ( $a_id )

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

     {
         $this->ilias->raiseError("Operation ilObjMedia::setRefId() not allowed.", $this->ilias->error_obj->FATAL);
     }

◆ setTitle()

ilObjMediaObject::setTitle ( $a_title )

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

Referenced by MDUpdateListener().

     {
         parent::setTitle($a_title);
     }

Here is the caller graph for this function:

◆ update()

ilObjMediaObject::update ( $a_upload = false )

update media object in db

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

References $app_event_handler, $key, $media_items, array, ilMediaItem\deleteAllItemsOfMob(), getId(), getMediaItems(), League\Flysystem\Adapter\Polyfill\update(), and updateMetaData().

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

Here is the call graph for this function:

◆ updateMetaData()

ilObjMediaObject::updateMetaData ( )

update meta data entry

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

References getDescription(), getId(), getTitle(), and ilObject\getType().

Referenced by update().

     {
         include_once("Services/MetaData/classes/class.ilMD.php");
         include_once("Services/MetaData/classes/class.ilMDGeneral.php");
         include_once("Services/MetaData/classes/class.ilMDDescription.php");
 
         $md = new ilMD(0, $this->getId(), $this->getType());
         $md_gen = $md->getGeneral();
         $md_gen->setTitle($this->getTitle());
 
         // sets first description (maybe not appropriate)
         $md_des_ids = $md_gen->getDescriptionIds();
         if (count($md_des_ids) > 0) {
             $md_des = $md_gen->getDescription($md_des_ids[0]);
             $md_des->setDescription($this->getDescription());
             $md_des->update();
         }
         $md_gen->update();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uploadAdditionalFile()

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

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

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

References _getDirectory(), getId(), ilUtil\makeDirParents(), and ilMediaSvgSanitizer\sanitizeDir().

Referenced by uploadSrtFile(), and uploadVideoPreviewPic().

     {
         $a_subdir = str_replace("..", "", $a_subdir);
         $dir = $mob_dir = ilObjMediaObject::_getDirectory($this->getId());
         if ($a_subdir != "") {
             $dir.= "/" . $a_subdir;
         }
         ilUtil::makeDirParents($dir);
         if ($a_mode == "rename") {
             rename($tmp_name, $dir . "/" . $a_name);
         } else {
             ilUtil::moveUploadedFile($tmp_name, $a_name, $dir . "/" . $a_name, true, $a_mode);
         }
         self::renameExecutables($mob_dir);
         include_once("./Services/MediaObjects/classes/class.ilMediaSvgSanitizer.php");
         ilMediaSvgSanitizer::sanitizeDir($mob_dir);     // see #20339
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uploadMultipleSubtitleFile()

ilObjMediaObject::uploadMultipleSubtitleFile ( $a_file )

Upload multi srt file.

Parameters

array $a_file file info array

Exceptions

ilMediaObjectsException

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

References $ilUser, ilObject\$lng, $user, ilUtil\delDir(), getMultiSrtUploadDir(), ilUtil\makeDirParents(), and ilUtil\unzip().

     {
         $lng = $this->lng;
         $ilUser = $this->user;
 
         include_once("./Services/MediaObjects/exceptions/class.ilMediaObjectsException.php");
         if (!is_file($a_file["tmp_name"])) {
             throw new ilMediaObjectsException($lng->txt("mob_file_could_not_be_uploaded"));
         }
 
         $dir = $this->getMultiSrtUploadDir();
         ilUtil::delDir($dir, true);
         ilUtil::makeDirParents($dir);
         ilUtil::moveUploadedFile($a_file["tmp_name"], "multi_srt.zip", $dir . "/" . "multi_srt.zip");
         ilUtil::unzip($dir . "/multi_srt.zip", true);
     }

Here is the call graph for this function:

◆ uploadSrtFile()

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

Upload srt file.

Parameters

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

References uploadAdditionalFile().

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

Here is the call graph for this function:

◆ uploadVideoPreviewPic()

ilObjMediaObject::uploadVideoPreviewPic ( $a_prevpic )

Upload video preview picture.

Parameters

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

References array, getVideoPreviewPic(), removeAdditionalFile(), and uploadAdditionalFile().

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

Here is the call graph for this function:

Field Documentation

◆ $app_event_handler

ilObjMediaObject::$app_event_handler

protected

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

Referenced by create(), and update().

◆ $contains_int_link

ilObjMediaObject::$contains_int_link

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

Referenced by containsIntLink().

◆ $id

ilObjMediaObject::$id

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

Referenced by getId(), getParentObjectIdForUsage(), and MDUpdateListener().

◆ $is_alias

ilObjMediaObject::$is_alias

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

Referenced by isAlias().

◆ $media_items

ilObjMediaObject::$media_items

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

Referenced by create(), getMediaItems(), getXML(), removeMediaItem(), and update().

◆ $origin_id

ilObjMediaObject::$origin_id

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

Referenced by getOriginID().

◆ $user

ilObjMediaObject::$user

protected

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

Referenced by createMetaData(), getXML(), lookupUsages(), and uploadMultipleSubtitleFile().

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

Services/MediaObjects/classes/class.ilObjMediaObject.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _createThumbnailDirectory()

◆ _deleteAllUsages()

◆ _determineWidthHeight()

◆ _exists()

◆ _getDirectory()

◆ _getMobsOfObject()

◆ _getSimpleMimeTypes()

◆ _getThumbnailDirectory()

◆ _getURL()

◆ _lookupItemPath()

◆ _lookupStandardItemPath()

◆ _removeUsage()

◆ _resizeImage()

◆ _saveTempFileAsMediaObject()

◆ _saveUsage()

◆ _useAutoStartParameterOnly()

◆ addMediaItem()

◆ clearMultiSrtDirectory()

◆ containsIntLink()

◆ create()

◆ createDirectory()

◆ createMetaData()

◆ createReference()

◆ delete()

◆ deleteMetaData()

◆ duplicate()

◆ escapeProperty()

◆ exportFiles()

◆ exportMediaFullscreen()

◆ exportXML()

◆ fixFilename()

◆ generatePreviewPic()

◆ getAllowedFileTypes()

◆ getDataDirectory()

◆ getDescription()

◆ getFilesOfDirectory()

◆ getForbiddenFileTypes()

◆ getId()

◆ getImportId()

◆ getLinkedMediaObjects()

◆ getMediaItem()

◆ getMediaItemNr()

◆ getMediaItems()

◆ getMimeType()

◆ getMultiSrtFiles()

◆ getMultiSrtUploadDir()

◆ getOriginID()

◆ getParentObjectIdForUsage()

◆ getRefId()

◆ getRestrictedFileTypes()

◆ getSrtFiles()

◆ getThumbnailPath()

◆ getTitle()

◆ getUsages()

◆ getVideoPreviewPic()

◆ getXML()

◆ handleAmps()

◆ handleQuotaUpdate()

◆ hasFullscreenItem()

◆ hasPurposeItem()

◆ isAlias()

◆ isTypeAllowed()

◆ lookupUsages()

◆ makeThumbnail()

◆ MDUpdateListener()

◆ modifyExportIdentifier()

◆ putInTree()

◆ read()

◆ removeAdditionalFile()

◆ removeAllMediaItems()