ilObjMediaObject Class Reference

Inheritance diagram for ilObjMediaObject:

Collaboration diagram for ilObjMediaObject:

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

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

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

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

Static Protected Member Functions
static	handleQuotaUpdate (ilObjMediaObject $a_mob)

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

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilObjMediaObject::__construct

(

int

$a_id = 0

)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ILIAS\Repository\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 ( int  $a_obj_id )

static

Create thumbnail directory.

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

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

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

     : void {
        ilFileUtils::createDirectory(ilFileUtils::getWebspaceDir() . "/thumbs");
        ilFileUtils::createDirectory(ilFileUtils::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 ( string  $a_type, int  $a_id, ?int  $a_usage_hist_nr = 0, string  $a_lang = "-"  )

static

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

References $DIC, and $ilDB.

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

     : void {
        global $DIC;

        $ilDB = $DIC->database();

        $and_hist = "";
        if (!is_null($a_usage_hist_nr)) {
            $and_hist = " AND usage_hist_nr = " . $ilDB->quote($a_usage_hist_nr, "integer");
        }

        $mob_ids = array();
        $set = $ilDB->query("SELECT id FROM mob_usage" .
            " WHERE usage_type = " . $ilDB->quote($a_type, "text") .
            " AND usage_id = " . $ilDB->quote($a_id, "integer") .
            " AND usage_lang = " . $ilDB->quote($a_lang, "text") .
            $and_hist);
        while ($row = $ilDB->fetchAssoc($set)) {
            $mob_ids[] = $row["id"];
        }

        $q = "DELETE FROM mob_usage WHERE usage_type = " .
            $ilDB->quote($a_type, "text") .
            " AND usage_id= " . $ilDB->quote($a_id, "integer") .
            " AND usage_lang = " . $ilDB->quote($a_lang, "text") .
            $and_hist;
        $ilDB->manipulate($q);

        foreach ($mob_ids as $mob_id) {
            self::handleQuotaUpdate(new self($mob_id));
        }
    }

Here is the caller graph for this function:

_determineWidthHeight()

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

static

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

References $DIC, ilObject\$lng, ilUtil\deducibleSize(), ilMediaImageUtil\getImageSize(), ILIAS\Repository\int(), and ilLanguage\txt().

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

     : array {
        global $DIC;

        $lng = $DIC->language();
        $size = [];
        $wr = 0;
        $hr = 0;
        $width = 0;
        $height = 0;

        // determine width and height of known image types
        //$width = 640;
        //$height = 360;
        $info = "";

        /*
        if ($a_format == "audio/mpeg") {
            $width = 300;
            $height = 20;
        }*/

        if (ilUtil::deducibleSize($a_format)) {
            if ($a_type == "File") {
                $size = ilMediaImageUtil::getImageSize($a_file);
            } else {
                $size = ilMediaImageUtil::getImageSize($a_reference);
            }
        }

        if (!isset($size[0])) {
            $size[0] = 0;
        }
        if (!isset($size[1])) {
            $size[1] = 0;
        }

        if ($a_use_original) {
            if ($size[0] > 0 && $size[1] > 0) {
                //$width = $size[0];
                //$height = $size[1];
                $width = "";
                $height = "";
            } else {
                $info = $lng->txt("cont_could_not_determine_resource_size");
            }
        } else {
            $w = $a_user_width;
            $h = $a_user_height;
            $width = $w;
            $height = $h;
            //echo "<br>C-$width-$height-";
            if (ilUtil::deducibleSize($a_format) && $a_constrain_proportions) {
                if ($size[0] > 0 && $size[1] > 0) {
                    if ($w > 0) {
                        $wr = $size[0] / $w;
                    }
                    if ($h > 0) {
                        $hr = $size[1] / $h;
                    }
                    //echo "<br>+".$wr."+".$size[0]."+".$w."+";
                    //echo "<br>+".$hr."+".$size[1]."+".$h."+";
                    $r = max($wr, $hr);
                    if ($r > 0) {
                        $width = (int) round($size[0] / $r);
                        $height = (int) round($size[1] / $r);
                    }
                }
            }
            //echo "<br>D-$width-$height-";
        }
        //echo "<br>E-$width-$height-";

        if ($width == 0 && is_null($a_user_width)) {
            $width = "";
        }
        if ($height == 0 && is_null($a_user_height)) {
            $height = "";
        }
        return array("width" => $width, "height" => $height, "info" => $info);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_exists()

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

static

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

References ilInternalLink\_extractObjIdOfTarget(), and ilObject\_lookupType().

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

     : bool {
        if (is_int(strpos($id, "_"))) {
            $a_id = ilInternalLink::_extractObjIdOfTarget($id);
        }

        if (parent::_exists($id) && ilObject::_lookupType($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 ( int  $a_mob_id )

static

Get absolute directory.

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

References ilFileUtils\getWebspaceDir().

Referenced by ilObjMediaObjectGUI\_getMediaInfoHTML(), ilObjMediaCastAccess\_lookupDiskUsage(), _saveTempFileAsMediaObject(), ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\collectMediaFiles(), ilPCInteractiveImageGUI\create(), createDirectory(), ilObjMediaPoolGUI\createMediaFromUploadDir(), delete(), ilNewsItem\deliverMobFile(), ilMediaItem\determineDuration(), ilObjMediaCastGUI\determinePlaytimeObject(), duplicate(), ilPDNewsTableGUI\fillRow(), ilMediaItem\getDirectory(), getExternalMetadata(), 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\returnToContextObject(), ilObjMediaObjectGUI\savePropertiesObject(), ilMediaCreationGUI\saveUrl(), ilObjMediaObjectGUI\setObjectPerCreationForm(), ilPCInteractiveImageGUI\update(), ilObjMediaCastGUI\updateMediaItem(), uploadAdditionalFile(), and uploadVideoPreviewPic().

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

Here is the call graph for this function:

Here is the caller graph for this function:

_getMobsOfObject()

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

static

Returns

int[]

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

References $DIC, $ilDB, $mobs, ilObject\_lookupType(), and ILIAS\Repository\int().

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

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $lstr = "";
        if ($a_lang != "") {
            $lstr = " AND usage_lang = " . $ilDB->quote($a_lang, "text");
        }
        $hist_str = "";
        if ($a_usage_hist_nr > 0) {
            $hist_str = " AND usage_hist_nr = " . $ilDB->quote($a_usage_hist_nr, "integer");
        }

        $q = "SELECT * FROM mob_usage WHERE " .
            "usage_type = " . $ilDB->quote($a_type, "text") . " AND " .
            "usage_id = " . $ilDB->quote($a_id, "integer") .
            $lstr . $hist_str;
        $mobs = array();
        $mob_set = $ilDB->query($q);
        while ($mob_rec = $ilDB->fetchAssoc($mob_set)) {
            $mob_id = (int) $mob_rec['id'];
            if (ilObject::_lookupType($mob_id) === "mob") {
                $mobs[$mob_id] = $mob_id;
            }
        }

        return $mobs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getRelativeDirectory()

static ilObjMediaObject::_getRelativeDirectory ( int  $a_mob_id )

static

Get relative (to webspace dir) directory.

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

Referenced by ilMediaCreationGUI\handleUploadResult(), and ilObjMediaPoolGUI\handleUploadResult().

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

Here is the caller graph for this function:

_getThumbnailDirectory()

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

static

get directory for files of media object

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

References ilFileUtils\getWebspaceDir().

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

     : string {
        return ilFileUtils::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 ( int  $a_mob_id )

static

get directory for files of media object

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

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

Referenced by ilMediaObjectsPlayerWrapperGUI\audio(), ilMediaCastTableGUI\fillRow(), ilDclMobRecordRepresentation\getHTML(), McstImageGalleryGUI\getHTML(), ilNewsTimelineItemGUI\getMediaPath(), ilNewsForContextBlockGUI\getMediaPath(), ilMediaItem\getThumbnailTarget(), and ILIAS\MediaCast\Video\VideoSequence\init().

     : string {
        return ilUtil::getHtmlPath(ilFileUtils::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 ( int  $a_mob_id, bool  $a_url_encode = false, bool  $a_web = true, string  $a_purpose = ""  )

static

Get path for item with specific purpose.

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

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

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

     : string {
        if ($a_purpose == "") {
            $a_purpose = "Standard";
        }
        $location = ilMediaItem::_lookupLocationForMobId($a_mob_id, $a_purpose);
        if (preg_match("/https?\:/i", $location)) {
            return $location;
        }

        if ($a_url_encode) {
            $location = rawurlencode($location);
        }

        $path = ($a_web)
            ? ILIAS_HTTP_PATH
            : ".";

        return $path . "/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 ( int  $a_mob_id, bool  $a_url_encode = false, bool  $a_web = true  )

static

Get path for standard item.

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

References _lookupItemPath().

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

Here is the call graph for this function:

_removeUsage()

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

static

Remove usage of mob in another container.

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

References $DIC, and $ilDB.

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

     : void {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "DELETE FROM mob_usage WHERE " .
            " id = " . $ilDB->quote($a_mob_id, "integer") . " AND " .
            " usage_type = " . $ilDB->quote($a_type, "text") . " AND " .
            " usage_id = " . $ilDB->quote($a_id, "integer") . " AND " .
            " usage_lang = " . $ilDB->quote($a_lang, "text") . " AND " .
            " usage_hist_nr = " . $ilDB->quote($a_usage_hist_nr, "integer");
        $ilDB->manipulate($q);

        self::handleQuotaUpdate(new self($a_mob_id));
    }

Here is the caller graph for this function:

_resizeImage()

static ilObjMediaObject::_resizeImage ( string  $a_file, int  $a_width, int  $a_height, bool  $a_constrain_prop = false  )

static

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

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

References $location, and ilShellUtil\resizeImage().

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

     : string {
        $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;
        ilShellUtil::resizeImage(
            $a_file,
            $target_file,
            $a_width,
            $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 ( string  $name, string  $tmp_name, bool  $upload = true  )

static

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

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

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

Referenced by assLongMenuImport\fromXML(), assKprimChoiceImport\fromXML(), assErrorTextImport\fromXML(), assFileUploadImport\fromXML(), assFlashQuestionImport\fromXML(), assFormulaQuestionImport\fromXML(), assSingleChoiceImport\fromXML(), assImagemapQuestionImport\fromXML(), assTextSubsetImport\fromXML(), assClozeTestImport\fromXML(), assOrderingHorizontalImport\fromXML(), assMultipleChoiceImport\fromXML(), assNumericImport\fromXML(), assOrderingQuestionImport\fromXML(), assTextQuestionImport\fromXML(), assMatchingQuestionImport\fromXML(), ilObjTest\fromXML(), ilSurveyImporter\getSurvey(), ilForumXMLParser\handlerEndTag(), ilNewsTimelineGUI\save(), ilNewsItemGUI\saveNewsItem(), ilSoapUtils\saveTempFileAsMediaObject(), ilNewsTimelineGUI\update(), and ilNewsItemGUI\updateNewsItem().

     : ilObjMediaObject {
        // create dummy object in db (we need an id)
        $media_object = new ilObjMediaObject();
        $media_object->setTitle($name);
        $media_object->setDescription("");
        $media_object->create();

        // determine and create mob directory, move uploaded file to directory
        $media_object->createDirectory();
        $mob_dir = ilObjMediaObject::_getDirectory($media_object->getId());

        $media_item = new ilMediaItem();
        $media_object->addMediaItem($media_item);
        $media_item->setPurpose("Standard");

        $file = $mob_dir . "/" . $name;
        if ($upload) {
            ilFileUtils::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)) {
            $size = ilMediaImageUtil::getImageSize($file);
            $media_item->setWidth($size[0]);
            $media_item->setHeight($size[1]);
        }
        $media_item->setHAlign("Left");

        self::renameExecutables($mob_dir);
        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 ( int  $a_mob_id, string  $a_type, int  $a_id, int  $a_usage_hist_nr = 0, string  $a_lang = "-"  )

static

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

page)

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

References $DIC, $ilDB, ilObject\$log, ilLogger\debug(), and ilLoggerFactory\getLogger().

Referenced by ilRTE\_cleanupMediaObjectUsage(), SurveyQuestion\copyXHTMLMediaObjectsOfQuestion(), assQuestion\copyXHTMLMediaObjectsOfQuestion(), ilObjForumGUI\createThread(), ilDataCollectionDataSet\escapeArray(), assLongMenuImport\fromXML(), assKprimChoiceImport\fromXML(), assErrorTextImport\fromXML(), assFileUploadImport\fromXML(), assFlashQuestionImport\fromXML(), assFormulaQuestionImport\fromXML(), assImagemapQuestionImport\fromXML(), assMultipleChoiceImport\fromXML(), assNumericImport\fromXML(), assOrderingHorizontalImport\fromXML(), assSingleChoiceImport\fromXML(), assTextSubsetImport\fromXML(), assOrderingQuestionImport\fromXML(), assTextQuestionImport\fromXML(), assMatchingQuestionImport\fromXML(), ilObjTest\fromXML(), ilSurveyImporter\getSurvey(), ilForumAutoSaveAsyncDraftAction\handleMedia(), ilForumXMLParser\handlerEndTag(), ilForumUtil\moveMediaObjects(), ilDclMobRecordFieldModel\parseValue(), ilObjForumGUI\publishDraftObject(), ilForumUtil\saveMediaObjects(), ilPCMediaObject\saveMobUsage(), assQuestion\syncXHTMLMediaObjectsOfQuestion(), ilExSubmissionTextGUI\updateAssignmentTextObject(), and ilObjForumGUI\updateDraftObject().

     : void {
        global $DIC;

        $ilDB = $DIC->database();
        $log = ilLoggerFactory::getLogger('mob');
        $log->debug("save usage mob: " . $a_mob_id . ", type " . $a_type . " id: " . $a_id . ", hist: " . $a_usage_hist_nr . ", lang: " . $a_lang);
        $ilDB->replace(
            "mob_usage",
            array(
                "id" => array("integer", $a_mob_id),
                "usage_type" => array("text", $a_type),
                "usage_id" => array("integer", $a_id),
                "usage_lang" => array("text", $a_lang),
                "usage_hist_nr" => array("integer", $a_usage_hist_nr)
                ),
            array()
        );

        self::handleQuotaUpdate(new self($a_mob_id));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addMediaItem()

ilObjMediaObject::addMediaItem

(

ilMediaItem

$a_item

)

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

Referenced by ilMediaItem\_getMediaItemsOfMOb(), ilObjMediaCastGUI\createMediaItemForPurpose(), and ilObjMediaObjectGUI\setObjectPerCreationForm().

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

Here is the caller graph for this function:

beforeCreateMetaData()

ilObjMediaObject::beforeCreateMetaData ( )

protected

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

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

                                             : bool
    {
        $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 false;   // avoid parent to create md
    }

Here is the call graph for this function:

beforeDeleteMetaData()

ilObjMediaObject::beforeDeleteMetaData ( )

protected

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

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

                                             : bool
    {
        // Delete meta data
        $md = new ilMD(0, $this->getId(), $this->getType());
        $md->deleteAll();

        return false;
    }

Here is the call graph for this function:

beforeMDUpdateListener()

ilObjMediaObject::beforeMDUpdateListener ( string  $a_element )

protected

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

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

                                                                : bool
    {
        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;
        }
        return false;       // prevent parent from creating ilMD
    }

Here is the call graph for this function:

beforeUpdateMetaData()

ilObjMediaObject::beforeUpdateMetaData ( )

protected

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

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

                                             : bool
    {
        $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();
        return false;
    }

Here is the call graph for this function:

clearMultiSrtDirectory()

ilObjMediaObject::clearMultiSrtDirectory

(

)

Clear multi srt directory.

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

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

                                            : void
    {
        ilFileUtils::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 769 of file class.ilObjMediaObject.php.

References $contains_int_link.

                                     : bool
    {
        return $this->contains_int_link;
    }

create()

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

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

References ilObject\$app_event_handler, $i, ilObject\$id, ilObject\createMetaData(), ilObject\getId(), getMediaItems(), and ilAppEventHandler\raise().

Referenced by ilObjMediaObjectGUI\setObjectPerCreationForm().

                                                                                             : int
    {
        $id = 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())
        );

        return $id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createDirectory()

ilObjMediaObject::createDirectory

(

)

Create file directory of media object.

Exceptions

ilMediaObjectsException

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

References $path, _getDirectory(), ilObject\getId(), and ilFileUtils\makeDirParents().

Referenced by ilObjMediaObjectGUI\setObjectPerCreationForm(), and ilObjMediaCastGUI\updateMediaItem().

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

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilObjMediaObject::delete

(

)

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

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

                            : bool
    {
        $mob_logger = ilLoggerFactory::getLogger('mob');
        $mob_logger->debug("ilObjMediaObject: Delete called for media object ID '" . $this->getId() . "'.");

        if (!($this->getId() > 0)) {
            return false;
        }

        $usages = $this->getUsages();

        $mob_logger->debug("ilObjMediaObject: ... Found " . count($usages) . " usages.");

        if (count($usages) == 0) {
            // remove directory
            ilFileUtils::delDir(ilObjMediaObject::_getDirectory($this->getId()));

            // remove thumbnail directory
            ilFileUtils::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.");
        }
        return true;
    }

Here is the call graph for this function:

duplicate()

ilObjMediaObject::duplicate

(

)

Duplicate media object, return new media object.

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

References ILIAS\LTI\ToolProvider\$key, _getDirectory(), _getThumbnailDirectory(), ilObject\getDescription(), ilObject\getId(), getMediaItems(), ilObject\getTitle(), and ilFileUtils\rCopy().

Referenced by ilDclMobRecordFieldModel\afterClone().

                               : ilObjMediaObject
    {
        $new_obj = new ilObjMediaObject();
        $new_obj->setTitle($this->getTitle());
        $new_obj->setDescription($this->getDescription());

        // media items
        foreach ($this->getMediaItems() as $key => $val) {
            $new_obj->addMediaItem($val);
        }

        $new_obj->create(false, true);

        // files
        $new_obj->createDirectory();
        self::_createThumbnailDirectory($new_obj->getId());
        ilFileUtils::rCopy(
            ilObjMediaObject::_getDirectory($this->getId()),
            ilObjMediaObject::_getDirectory($new_obj->getId())
        );
        ilFileUtils::rCopy(
            ilObjMediaObject::_getThumbnailDirectory($this->getId()),
            ilObjMediaObject::_getThumbnailDirectory($new_obj->getId())
        );

        // meta data
        $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 ( string  $a_value )

protected

Escape property (e.g.

title, caption) to XSLT -> HTML output

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

Referenced by getXML().

     : string {
        return htmlspecialchars($a_value);
    }

Here is the caller graph for this function:

exportFiles()

ilObjMediaObject::exportFiles

(

string

$a_target_dir

)

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

Exceptions

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

References ilObject\getId(), ilFileUtils\getWebspaceDir(), IL_INST_ID, ilFileUtils\makeDir(), and ilFileUtils\rCopy().

     : void {
        $subdir = "il_" . IL_INST_ID . "_mob_" . $this->getId();
        ilFileUtils::makeDir($a_target_dir . "/objects/" . $subdir);

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

Here is the call graph for this function:

exportXML()

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

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

References ilXmlWriter\appendXML(), getXML(), and IL_MODE_FULL.

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

Here is the call graph for this function:

fixFilename()

static ilObjMediaObject::fixFilename ( string  $a_name )

static

Fix filename of uploaded file.

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

References ilFileUtils\getASCIIFilename().

Referenced by ilMediaCreationGUI\handleUploadResult(), ilObjMediaPoolGUI\handleUploadResult(), ilObjMediaObjectGUI\savePropertiesObject(), and ilObjMediaObjectGUI\setObjectPerCreationForm().

     : string {
        $a_name = ilFileUtils::getASCIIFilename($a_name);

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

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.

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

                                                : array
    {
        $mset = new ilSetting("mobs");
        if (trim((string) $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 1336 of file class.ilObjMediaObject.php.

References ilObject\getId(), and ilFileUtils\getWebspaceDir().

Referenced by getXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getExternalMetadata()

ilObjMediaObject::getExternalMetadata

(

)

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

References Vendor\Package\$e, $url, _getDirectory(), ilExternalMediaAnalyzer\extractVimeoParameters(), ilObject\getId(), getMediaItem(), ilExternalMediaAnalyzer\getVimeoMetadata(), ilExternalMediaAnalyzer\getYoutubeMetadata(), ilExternalMediaAnalyzer\isVimeo(), ilObject\setDescription(), and ilObject\setTitle().

Referenced by ilObjMediaObjectGUI\setObjectPerCreationForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getFilesOfDirectory()

ilObjMediaObject::getFilesOfDirectory

(

string

$a_subdir = ""

)

Get files of directory.

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

References Vendor\Package\$e, _getDirectory(), ilFileUtils\getDir(), and ilObject\getId().

     : array {
        $a_subdir = str_replace("..", "", $a_subdir);
        $dir = ilObjMediaObject::_getDirectory($this->getId());
        if ($a_subdir != "") {
            $dir .= "/" . $a_subdir;
        }

        $files = array();
        if (is_dir($dir)) {
            $entries = ilFileUtils::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.

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

Referenced by ilPCMediaObjectEditorGUI\getUploadForm(), ilObjMediaObjectGUI\initForm(), and ilObjMediaObjectGUI\returnToContextObject().

                                                  : array
    {
        $mset = new ilSetting("mobs");
        if (trim((string) $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:

getLinkedMediaObjects()

ilObjMediaObject::getLinkedMediaObjects

(

array

$a_ignore = []

)

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

Parameters

int[]

$a_ignore array of IDs that should be ignored

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

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

     : array {
        $linked = array();

        // get linked media objects (map areas)
        $med_items = $this->getMediaItems();

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

Here is the call graph for this function:

getMediaItem()

ilObjMediaObject::getMediaItem

(

string

$a_purpose

)

get item for media purpose

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

Referenced by ilObjMediaObjectGUI\_getMediaInfoHTML(), ilMediaObjectsPlayerWrapperGUI\audio(), getExternalMetadata(), ilObjMediaCastGUI\getMediaItem(), ilNewsTimelineItemGUI\getMediaPath(), ilMediaCreationGUI\handleUploadResult(), ilObjMediaPoolGUI\handleUploadResult(), hasPurposeItem(), ilPCImageMapEditorGUI\makeMapWorkCopy(), ilMediaCreationGUI\saveUrl(), and uploadVideoPreviewPic().

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

Here is the caller graph for this function:

getMediaItems()

& ilObjMediaObject::getMediaItems

(

)

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

References $media_items.

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

                                    : array
    {
        return $this->media_items;
    }

Here is the caller graph for this function:

getMimeType()

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

static

get mime type for file

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

Referenced by _saveTempFileAsMediaObject(), ilExAssignmentGUI\addFiles(), ilObjMediaObjectGUI\assignFullscreenObject(), ilObjMediaObjectGUI\assignStandardObject(), ilKprimChoiceWizardInputGUI\checkUploads(), ilPCInteractiveImageGUI\create(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilPublicUserProfileGUI\deliverVCard(), ilMediaPlayerGUI\getMp3PlayerHtml(), ilMediaCreationGUI\handleUploadResult(), ilObjMediaPoolGUI\handleUploadResult(), makeThumbnail(), ilDclMobRecordFieldModel\parseValue(), ilNewsTimelineItemGUI\renderMedia(), ilNewsTimelineItemGUI\renderMediaModal(), ilObjMediaObjectGUI\savePropertiesObject(), ilMediaCreationGUI\saveUrl(), assSingleChoice\setImageFile(), assMultipleChoice\setImageFile(), ilObjMediaObjectGUI\setObjectPerCreationForm(), ilNewsForContextBlockGUI\showNews(), ilPCInteractiveImageGUI\update(), ilObjMediaCastGUI\updateMediaItem(), and ilFSStorageExercise\uploadFile().

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

Here is the caller graph for this function:

getMultiSrtFiles()

ilObjMediaObject::getMultiSrtFiles

(

)

Get all srt files of srt multi upload.

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

References $i, $lang, ilMDLanguageItem\_getPossibleLanguageCodes(), ilFileUtils\getDir(), and getMultiSrtUploadDir().

                                      : array
    {
        $items = array();

        $lang_codes = ilMDLanguageItem::_getPossibleLanguageCodes();

        $dir = $this->getMultiSrtUploadDir();
        $files = ilFileUtils::getDir($dir);
        foreach ($files as $k => $i) {
            // check directory
            if ($i["type"] == "file" && !in_array($k, array(".", ".."))) {
                if (pathinfo($k, PATHINFO_EXTENSION) == "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.

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

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

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

                                          : string
    {
        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 276 of file class.ilObjMediaObject.php.

References $origin_id.

                                 : string
    {
        return $this->origin_id;
    }

getParentObjectIdForUsage()

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

static

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

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

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

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

     : ?int {
        $cont_type = "";
        if (is_int(strpos($a_usage["type"], ":"))) {
            $us_arr = explode(":", $a_usage["type"]);
            $type = $us_arr[1];
            $cont_type = $us_arr[0];
        } else {
            $type = $a_usage["type"];
        }

        $id = $a_usage["id"];
        $obj_id = null;

        switch ($type) {
            // RTE / tiny mce
            case "html":

                switch ($cont_type) {
                    case "qpl":
                        // Question Pool *Question* Text (Test)
                        $qinfo = assQuestion::_getQuestionInfo($id);
                        if (isset($qinfo["original_id"]) && $qinfo["original_id"] > 0) {
                            $obj_id = ilObjTest::_lookupTestObjIdForQuestionId($id);    // usage in test
                        } else {
                            $obj_id = (int) ($qinfo["obj_fi"] ?? 0);            // usage in pool
                        }
                        break;

                    case "spl":
                        // Question Pool *Question* Text (Survey)
                        $quest = SurveyQuestion::_instanciateQuestion($id);
                        if ($quest) {
                            $parent_id = $quest->getObjId();

                            // pool question copy - find survey, do not use pool itself
                            if ($quest->getOriginalId() &&
                                ilObject::_lookupType($parent_id) == "spl") {
                                $obj_id = (int) SurveyQuestion::_lookupSurveyObjId($id);
                            }
                            // original question (in pool or survey)
                            else {
                                $obj_id = (int) $parent_id;
                            }

                            unset($quest);
                        }
                        break;

                    case "exca":
                        // Exercise assignment
                        $returned_pk = $a_usage['id'];
                        // #15995 - we are just checking against exercise object
                        $obj_id = ilExSubmission::lookupExerciseIdForReturnedId($returned_pk);
                        break;

                    case "frm":
                        // Forum
                        $post_pk = $a_usage['id'];
                        $oPost = new ilForumPost($post_pk);
                        $frm_pk = $oPost->getForumId();
                        $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
                        break;


                    case "frm~d":
                        $draft_id = $a_usage['id'];
                        $oDraft = ilForumPostDraft::newInstanceByDraftId($draft_id);

                        $frm_pk = $oDraft->getForumId();
                        $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
                        break;
                    case "frm~h":
                        $history_id = $a_usage['id'];
                        $oHistoryDraft = new ilForumDraftsHistory($history_id);
                        $oDraft = ilForumPostDraft::newInstanceByDraftId($oHistoryDraft->getDraftId());

                        $frm_pk = $oDraft->getForumId();
                        $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
                        break;
                        // temporary items (per user)
                    case "frm~":
                    case "exca~":
                        $obj_id = (int) $a_usage['id'];
                        break;

                        // "old" category pages
                    case "cat":
                        // InfoScreen Text
                    case "tst":
                    case "svy":
                        // data collection
                    case "dcl":
                        $obj_id = (int) $id;
                        break;
                }
                break;

                // page editor
            case "pg":

                switch ($cont_type) {
                    // question feedback // parent obj id is q id
                    case "qfbg":
                    case "qpl":

                        if ($cont_type == "qfbg") {
                            $id = ilPageObject::lookupParentId($id, 'qfbg');
                        }

                        // Question Pool Question Pages
                        $qinfo = assQuestion::_getQuestionInfo($id);
                        if ($qinfo["original_id"] > 0) {
                            $obj_id = ilObjTest::_lookupTestObjIdForQuestionId($id);    // usage in test
                        } else {
                            $obj_id = $qinfo["obj_fi"];         // usage in pool
                        }
                        if ($obj_id == 0) {     // this is the case, if question is in learning module -> get lm id
                            $pinfo = ilPCQuestion::_getPageForQuestionId($id, "lm");
                            if ($pinfo && $pinfo["parent_type"] == "lm") {
                                $obj_id = ilLMObject::_lookupContObjID($pinfo["page_id"]);
                            }
                            $pinfo = ilPCQuestion::_getPageForQuestionId($id, "sahs");
                            if ($pinfo && $pinfo["parent_type"] == "sahs") {
                                $obj_id = (int) ilSCORM2004Node::_lookupSLMID($pinfo["page_id"]);
                            }
                        }
                        break;

                    case "lm":
                        // learning modules
                        $obj_id = ilLMObject::_lookupContObjID($id);
                        break;

                    case "gdf":
                        // glossary definition
                        $term_id = ilGlossaryDefinition::_lookupTermId($id);
                        $obj_id = (int) ilGlossaryTerm::_lookGlossaryID($term_id);
                        break;

                    case "wpg":
                        // wiki page
                        $obj_id = (int) ilWikiPage::lookupObjIdByPage($id);
                        break;

                    case "sahs":
                        // sahs page
                        // can this implementation be used for other content types, too?
                        $obj_id = ilPageObject::lookupParentId($id, 'sahs');
                        break;

                    case "prtf":
                        // portfolio
                        $obj_id = ilPortfolioPage::findPortfolioForPage($id);
                        break;

                    case "prtt":
                        // portfolio template
                        $obj_id = ilPortfolioTemplatePage::findPortfolioForPage($id);
                        break;

                    case "blp":
                        // blog
                        $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 "copa":
                    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":
                $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:

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

Referenced by ilPCMediaObjectEditorGUI\getUploadForm(), ilObjMediaObjectGUI\initForm(), and ilObjMediaObjectGUI\returnToContextObject().

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

Here is the caller graph for this function:

getSrtFiles()

ilObjMediaObject::getSrtFiles

(

)

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

References $i, $name, _getDirectory(), ilFileUtils\getDir(), and ilObject\getId().

Referenced by ilMobSubtitleTableGUI\__construct(), and getXML().

                                 : array
    {
        $srt_dir = ilObjMediaObject::_getDirectory($this->getId()) . "/srt";

        if (!is_dir($srt_dir)) {
            return array();
        }

        $items = ilFileUtils::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 ( int  $a_mob_id, string  $a_thumbname  )

static

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

References _getThumbnailDirectory().

Referenced by ilPCIIMOverlaysTableGUI\fillRow().

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

getUsages()

ilObjMediaObject::getUsages

(

bool

$a_include_history = true

)

get all usages of current media object

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

References ilObject\getId().

Referenced by delete().

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

(

bool

$a_filename_only = false

)

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

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

Referenced by uploadVideoPreviewPic().

     : string {
        $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	(	int	$a_mode = IL_MODE_FULL,
		int	$a_inst = 0,
		bool	$a_sign_locals = false
	)

get MediaObject XLM Tag

Parameters

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

Returns

string

Exceptions

ilWACException

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

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

Referenced by exportXML(), and ilCOPageHTMLExport\renderMob().

     : string {
        $ilUser = $this->user;
        $xml = "";
        // 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=\"" . $this->escapeProperty($value) . "\"/>";
                    }
                    $xml .= $item->getMapAreasXML();
                    $xml .= "</MediaAliasItem>";
                }
                break;

                // for output we need technical sections of meta data
            case IL_MODE_OUTPUT:

                // get first technical section
                //                              $meta = $this->getMetaData();
                $xml = "<MediaObject Id=\"il__mob_" . $this->getId() . "\">";

                $media_items = $this->getMediaItems();
                for ($i = 0; $i < count($media_items); $i++) {
                    $item = $media_items[$i];

                    $xml .= "<MediaItem Purpose=\"" . $item->getPurpose() . "\">";

                    if ($a_sign_locals && $item->getLocationType() == "LocalFile") {
                        $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>" .
                            $this->escapeProperty($this->getTitle()) . "</Title>";
                    }

                    // Parameter
                    $parameters = $item->getParameters();
                    foreach ($parameters as $name => $value) {
                        $xml .= "<Parameter Name=\"$name\" Value=\"" . $this->escapeProperty($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
                $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

(

string

$a_str

)

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

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

Referenced by getXML().

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

Here is the caller graph for this function:

handleQuotaUpdate()

static ilObjMediaObject::handleQuotaUpdate ( ilObjMediaObject  $a_mob )

staticprotected

Deprecated:

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

     : void {
    }

hasFullscreenItem()

ilObjMediaObject::hasFullscreenItem

(

)

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

References hasPurposeItem().

Referenced by ilObjMediaObjectGUI\_getMediaInfoHTML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

hasPurposeItem()

ilObjMediaObject::hasPurposeItem

(

string

$purpose

)

returns whether object has media item with specific purpose

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

References getMediaItem().

Referenced by hasFullscreenItem().

                                                   : bool
    {
        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 263 of file class.ilObjMediaObject.php.

References $is_alias.

                             : bool
    {
        return $this->is_alias;
    }

isTypeAllowed()

static ilObjMediaObject::isTypeAllowed ( string  $a_type )

static

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

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

     : bool {
        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 ( int  $a_id, bool  $a_include_history = true  )

static

Lookup usages of media object.

Todo:

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

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

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

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

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $hist_str = "";
        if ($a_include_history) {
            $hist_str = ", usage_hist_nr";
        }
        // get usages in pages
        $q = "SELECT DISTINCT usage_type, usage_id, usage_lang" . $hist_str . " FROM mob_usage WHERE id = " .
            $ilDB->quote($a_id, "integer");

        if (!$a_include_history) {
            $q .= " AND usage_hist_nr = " . $ilDB->quote(0, "integer");
        }

        $us_set = $ilDB->query($q);
        $ret = array();
        while ($us_rec = $ilDB->fetchAssoc($us_set)) {
            $ut = "";
            $ct = 0;
            if (is_int(strpos($us_rec["usage_type"], ":"))) {
                $us_arr = explode(":", $us_rec["usage_type"]);
                $ut = $us_arr[1];
                $ct = $us_arr[0];
            }

            // check whether page exists
            $skip = false;
            if ($ut == "pg") {
                if (!ilPageObject::_exists($ct, $us_rec["usage_id"])) {
                    $skip = true;
                }
            }

            if (!$skip) {
                $ret[] = array(
                    "type" => $us_rec["usage_type"],
                    "id" => $us_rec["usage_id"],
                    "lang" => $us_rec["usage_lang"],
                    "hist_nr" => ($us_rec["usage_hist_nr"] ?? 0)
                );
            }
        }

        // get usages in media pools
        $q = "SELECT DISTINCT mep_id FROM mep_tree JOIN mep_item ON (child = obj_id) WHERE mep_item.foreign_id = " .
            $ilDB->quote($a_id, "integer") . " AND mep_item.type = " . $ilDB->quote("mob", "text");
        $us_set = $ilDB->query($q);
        while ($us_rec = $ilDB->fetchAssoc($us_set)) {
            $ret[] = array("type" => "mep",
                "id" => $us_rec["mep_id"]);
        }

        // get usages in news items (media casts)
        $news_usages = ilNewsItem::_lookupMediaObjectUsages($a_id);
        foreach ($news_usages as $nu) {
            $ret[] = $nu;
        }


        // get usages in map areas
        $q = "SELECT DISTINCT mob_id FROM media_item it, map_area area " .
            " WHERE area.item_id = it.id " .
            " AND area.link_type = " . $ilDB->quote("int", "text") . " " .
            " AND area.target = " . $ilDB->quote("il__mob_" . $a_id, "text");
        $us_set = $ilDB->query($q);
        while ($us_rec = $ilDB->fetchAssoc($us_set)) {
            $ret[] = array("type" => "map",
                "id" => $us_rec["mob_id"]);
        }

        // get usages in personal clipboards
        $users = ilObjUser::_getUsersForClipboadObject("mob", $a_id);
        foreach ($users as $user) {
            $ret[] = array("type" => "clip",
                "id" => $user);
        }

        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

makeThumbnail()

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

Make thumbnail.

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

References _getDirectory(), _getThumbnailDirectory(), ilShellUtil\convertImage(), ilObject\getId(), ilMediaImageUtil\getImageSize(), getMimeType(), and ILIAS\Repository\int().

     : void {
        $size = (int) $a_size;
        $m_dir = ilObjMediaObject::_getDirectory($this->getId());
        $t_dir = ilObjMediaObject::_getThumbnailDirectory($this->getId());
        $file = $m_dir . "/" . $a_file;

        $mime = ilObjMediaObject::getMimeType($file);
        $wh = ilMediaImageUtil::getImageSize($file);

        // see #8602
        if ($size > (int) $wh[0] && $size > $wh[1]) {
            $a_size = "";
        }

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

Here is the call graph for this function:

modifyExportIdentifier()

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

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

References ilUtil\insertInstIntoID().

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

        return $a_value;
    }

Here is the call graph for this function:

read()

ilObjMediaObject::read

(

)

Exceptions

ilObjectNotFoundException
ilObjectTypeMismatchException

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

References ilMediaItem\_getMediaItemsOfMOb().

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

Here is the call graph for this function:

removeAdditionalFile()

ilObjMediaObject::removeAdditionalFile

(

string

$a_file

)

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

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

Referenced by uploadVideoPreviewPic().

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

(

)

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

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

removeMediaItem()

ilObjMediaObject::removeMediaItem

(

string

$a_purpose

)

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

References $i, ILIAS\LTI\ToolProvider\$key, $media_items, and ilObject\getId().

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

Here is the call graph for this function:

renameExecutables()

static ilObjMediaObject::renameExecutables ( string  $a_dir )

static

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

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

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

     : void {
        ilFileUtils::renameExecutables($a_dir);
        if (!self::isTypeAllowed("html")) {
            ilFileUtils::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

(

bool

$a_is_alias

)

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

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

setContainsIntLink()

ilObjMediaObject::setContainsIntLink

(

bool

$a_contains_link

)

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

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

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

setOriginID()

ilObjMediaObject::setOriginID

(

string

$a_id

)

Deprecated:

(seems to be obsolete)

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

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

update()

ilObjMediaObject::update

(

bool

$a_upload = false

)

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

References ilObject\$app_event_handler, ILIAS\LTI\ToolProvider\$key, ilMediaItem\deleteAllItemsOfMob(), ilObject\getId(), getMediaItems(), ilAppEventHandler\raise(), and ilObject\updateMetaData().

Referenced by ilObjMediaObjectGUI\setObjectPerCreationForm().

                                                  : bool
    {
        parent::update();

        if (!$a_upload) {
            $this->updateMetaData();
        }

        // iterate all items
        $media_items = $this->getMediaItems();
        ilMediaItem::deleteAllItemsOfMob($this->getId());

        $j = 1;
        foreach ($media_items as $key => $val) {
            $item = $val;
            if (is_object($item)) {
                $item->setMobId($this->getId());
                $item->setNr($j);
                if ($item->getLocationType() == "Reference") {
                    $item->extractUrlParameters();
                }
                $item->create();
                $j++;
            }
        }

        self::handleQuotaUpdate($this);
        $ilAppEventHandler = $this->app_event_handler;
        $ilAppEventHandler->raise(
            'Services/MediaObjects',
            'update',
            array('object' => $this,
                    'obj_type' => 'mob',
                    'obj_id' => $this->getId())
        );

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadAdditionalFile()

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

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

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

References _getDirectory(), ilObject\getId(), ilFileUtils\makeDirParents(), ilFileUtils\moveUploadedFile(), ilFileUtils\rename(), and ilMediaSvgSanitizer\sanitizeDir().

Referenced by uploadSrtFile(), and uploadVideoPreviewPic().

     : void {
        $a_subdir = str_replace("..", "", $a_subdir);
        $dir = $mob_dir = ilObjMediaObject::_getDirectory($this->getId());
        if ($a_subdir != "") {
            $dir .= "/" . $a_subdir;
        }
        ilFileUtils::makeDirParents($dir);
        if ($a_mode == "rename") {
            ilFileUtils::rename($tmp_name, $dir . "/" . $a_name);
        } else {
            ilFileUtils::moveUploadedFile($tmp_name, $a_name, $dir . "/" . $a_name, true, $a_mode);
        }
        self::renameExecutables($mob_dir);
        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

(

array

$a_file

)

Upload multi srt file.

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

References ilObject\$lng, ilFileUtils\delDir(), getMultiSrtUploadDir(), ilFileUtils\makeDirParents(), ilFileUtils\moveUploadedFile(), ilLanguage\txt(), and ilFileUtils\unzip().

     : void {
        $lng = $this->lng;

        if (!is_file($a_file["tmp_name"])) {
            throw new ilMediaObjectsException($lng->txt("mob_file_could_not_be_uploaded"));
        }

        $dir = $this->getMultiSrtUploadDir();
        ilFileUtils::delDir($dir, true);
        ilFileUtils::makeDirParents($dir);
        ilFileUtils::moveUploadedFile($a_file["tmp_name"], "multi_srt.zip", $dir . "/" . "multi_srt.zip");
        ilFileUtils::unzip($dir . "/multi_srt.zip", true);
    }

Here is the call graph for this function:

uploadSrtFile()

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

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

References uploadAdditionalFile().

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

(

array

$a_prevpic

)

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

References Vendor\Package\$e, $GLOBALS, $message, _getDirectory(), ilShellUtil\convertImage(), ilShellUtil\escapeShellArg(), ilShellUtil\execConvert(), ilFFmpeg\extractImage(), ilObject\getId(), ilFFmpeg\getLastReturnValues(), getMediaItem(), getVideoPreviewPic(), ilShellUtil\isConvertVersionAtLeast(), removeAdditionalFile(), uploadAdditionalFile(), and ilLogLevel\WARNING.

     : void {
        // remove old one
        if ($this->getVideoPreviewPic(true) != "") {
            $this->removeAdditionalFile($this->getVideoPreviewPic(true));
        }

        $pi = pathinfo($a_prevpic["name"]);
        $ext = $pi["extension"];
        if (in_array($ext, array("jpg", "jpeg", "png"))) {
            $this->uploadAdditionalFile("mob_vpreview." . $ext, $a_prevpic["tmp_name"]);
        }
    }

Here is the call graph for this function:

Field Documentation

$contains_int_link

bool ilObjMediaObject::$contains_int_link

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

Referenced by containsIntLink().

$is_alias

bool ilObjMediaObject::$is_alias

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

Referenced by isAlias().

$media_items

array ilObjMediaObject::$media_items

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

Referenced by getMediaItems(), and removeMediaItem().

$origin_id

string ilObjMediaObject::$origin_id

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

Referenced by getOriginID().

$user

ilObjUser ilObjMediaObject::$user

protected

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

Referenced by beforeCreateMetaData(), and getXML().

---

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

• Services/MediaObjects/classes/class.ilObjMediaObject.php