ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilObjMediaObject Class Reference

Class ilObjMediaObject. More...

+ Inheritance diagram for ilObjMediaObject:
+ Collaboration diagram for ilObjMediaObject:

Public Member Functions

 __construct ($a_id=0)
 Constructor @access public. More...
 
 setRefId ($a_id)
 set reference id @access public More...
 
 getRefId ()
 get reference id @access public More...
 
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!? More...
 
 createReference ()
 creates reference for object More...
 
 setTitle ($a_title)
 set object title More...
 
 getTitle ()
 get object title @access public More...
 
 delete ()
 delete media object More...
 
 getDescription ()
 get description of media object More...
 
 setDescription ($a_description)
 set description of media object More...
 
 MDUpdateListener ($a_element)
 Meta data update listener. More...
 
 createMetaData ()
 create meta data entry More...
 
 updateMetaData ()
 update meta data entry More...
 
 deleteMetaData ()
 delete meta data entry More...
 
 addMediaItem ($a_item)
 add media item to media object More...
 
getMediaItems ()
 get all media items More...
 
getMediaItem ($a_purpose)
 get item for media purpose More...
 
 removeMediaItem ($a_purpose)
 
 removeAllMediaItems ()
 remove all media items More...
 
 getMediaItemNr ($a_purpose)
 
 hasFullscreenItem ()
 
 hasPurposeItem ($purpose)
 returns wether object has media item with specific purpose More...
 
 read ()
 read media object data from db More...
 
 setId ($a_id)
 set id More...
 
 getId ()
 get object id @access public More...
 
 setAlias ($a_is_alias)
 set wether page object is an alias More...
 
 isAlias ()
 
 setOriginID ($a_id)
 
 getOriginID ()
 
 getImportId ()
 get import id More...
 
 setImportId ($a_id)
 set import id More...
 
 create ($a_create_meta_data=false, $a_save_media_items=true)
 create media object in db More...
 
 update ($a_upload=false)
 update media object in db More...
 
 createDirectory ()
 Create file directory of media object. More...
 
 getFilesOfDirectory ($a_subdir="")
 Get files of directory. More...
 
 getXML ($a_mode=IL_MODE_FULL, $a_inst=0, $a_sign_locals=false)
 get MediaObject XLM Tag More...
 
 handleAmps ($a_str)
 Replace "&" (if not an "&") with "&". More...
 
 exportXML (&$a_xml_writer, $a_inst=0)
 export XML More...
 
 exportFiles ($a_target_dir)
 export all media files of object to target directory note: target directory must be the export target directory, "/objects/il_<inst>_mob_<mob_id>/..." will be appended to this directory More...
 
 exportMediaFullscreen ($a_target_dir, $pg_obj)
 
 modifyExportIdentifier ($a_tag, $a_param, $a_value)
 
 setContainsIntLink ($a_contains_link)
 content parser set this flag to true, if the media object contains internal links (this method should only be called by the import parser) More...
 
 containsIntLink ()
 returns true, if mob was marked as containing an intern link (via setContainsIntLink) (this method should only be called by the import parser) More...
 
 getUsages ($a_include_history=true)
 get all usages of current media object More...
 
 getDataDirectory ()
 
 uploadAdditionalFile ($a_name, $tmp_name, $a_subdir="", $a_mode="move_uploaded")
 Create new media object and update page in db and return new media object. More...
 
 uploadSrtFile ($a_tmp_name, $a_language, $a_mode="move_uploaded")
 Upload srt file. More...
 
 getSrtFiles ()
 Get srt files. More...
 
 makeThumbnail ( $a_file, $a_thumbname, $a_format="png", $a_size="80")
 Make thumbnail. More...
 
 removeAdditionalFile ($a_file)
 Remove additional file. More...
 
 getLinkedMediaObjects ($a_ignore="")
 Get all media objects linked in map areas of this media object. More...
 
 duplicate ()
 Duplicate media object, return new media object. More...
 
 uploadVideoPreviewPic ($a_prevpic)
 Upload video preview picture. More...
 
 generatePreviewPic ($a_width, $a_height)
 Upload video preview picture. More...
 
 getVideoPreviewPic ($a_filename_only=false)
 Get video preview pic. More...
 
 getMultiSrtUploadDir ()
 Get directory for multi srt upload. More...
 
 uploadMultipleSubtitleFile ($a_file)
 Upload multi srt file. More...
 
 clearMultiSrtDirectory ()
 Clear multi feedback directory. More...
 
 getMultiSrtFiles ()
 Get all srt files of srt multi upload. More...
 
- Public Member Functions inherited from ilObject
 __construct ($a_id=0, $a_reference=true)
 Constructor @access public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ()
 read object data from db into object More...
 
 getId ()
 get object id @access public More...
 
 setId ($a_id)
 set object id @access public More...
 
 setRefId ($a_id)
 set reference id @access public More...
 
 getRefId ()
 get reference id @access public More...
 
 getType ()
 get object type @access public More...
 
 setType ($a_type)
 set object type @access public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title @access public More...
 
 getUntranslatedTitle ()
 get untranslated object title @access public More...
 
 setTitle ($a_title)
 set object title More...
 
 getDescription ()
 get object description More...
 
 setDescription ($a_desc)
 set object description More...
 
 getLongDescription ()
 get object long description (stored in object_description) More...
 
 getImportId ()
 get import id More...
 
 setImportId ($a_import_id)
 set import id More...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date @access public More...
 
 getLastUpdateDate ()
 get last update date @access public More...
 
 getDiskUsage ()
 Gets the disk usage of the object in bytes. More...
 
 create ()
 create More...
 
 update ()
 update object in db More...
 
 MDUpdateListener ($a_element)
 Meta data update listener. More...
 
 createMetaData ()
 create meta data entry More...
 
 updateMetaData ()
 update meta data entry More...
 
 deleteMetaData ()
 delete meta data entry More...
 
 updateOwner ()
 update owner of object in db More...
 
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!? More...
 
 setPermissions ($a_parent_ref)
 set permissions of object More...
 
 setParentRolePermissions ($a_parent_ref)
 Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
 
 createReference ()
 creates reference for object More...
 
 countReferences ()
 count references of object More...
 
 initDefaultRoles ()
 init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...
 
 applyDidacticTemplate ($a_tpl_id)
 Apply template. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container. More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies. More...
 
 cloneMetaData ($target_obj)
 Copy meta data. More...
 
 getPossibleSubObjects ($a_filter=true)
 get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...
 

Static Public Member Functions

static _exists ($a_id, $a_reference=false, $a_type=null)
 checks wether a lm content object with specified id exists or not More...
 
static _getDirectory ($a_mob_id)
 get directory for files of media object (static) More...
 
static _getURL ($a_mob_id)
 get directory for files of media object (static) More...
 
static _getThumbnailDirectory ($a_mob_id, $a_mode="filesystem")
 get directory for files of media object (static) More...
 
static _lookupStandardItemPath ( $a_mob_id, $a_url_encode=false, $a_web=true)
 Get path for standard item. More...
 
static _lookupItemPath ( $a_mob_id, $a_url_encode=false, $a_web=true, $a_purpose="")
 Get path for item with specific purpose. More...
 
static _createThumbnailDirectory ($a_obj_id)
 Create thumbnail directory. More...
 
static _deleteAllUsages ($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
 static More...
 
static _getMobsOfObject ($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
 get mobs of object More...
 
static _saveUsage ($a_mob_id, $a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
 Save usage of mob within another container (e.g. More...
 
static _removeUsage ($a_mob_id, $a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
 Remove usage of mob in another container. More...
 
static lookupUsages ($a_id, $a_include_history=true)
 Lookup usages of media object. More...
 
static getParentObjectIdForUsage ($a_usage, $a_include_all_access_obj_ids=false)
 Get's the repository object ID of a parent object, if possible. More...
 
static _resizeImage ($a_file, $a_width, $a_height, $a_constrain_prop=false)
 resize image and return new image file ("_width_height" string appended) More...
 
static getMimeType ($a_file, $a_external=null)
 get mime type for file More...
 
static _determineWidthHeight ( $a_format, $a_type, $a_file, $a_reference, $a_constrain_proportions, $a_use_original, $a_user_width, $a_user_height)
 Determine width and height. More...
 
static _getSimpleMimeTypes ()
 Get simple mime types that deactivate parameter property files tab in ILIAS. More...
 
static _useAutoStartParameterOnly ($a_loc, $a_format)
 Check whether only autostart parameter should be supported (instead of parameters input field. More...
 
static _saveTempFileAsMediaObject ($name, $tmp_name, $upload=true)
 Create new media object and update page in db and return new media object. More...
 
static getThumbnailPath ($a_mob_id, $a_thumbname)
 Get thumbnail path. More...
 
static getRestrictedFileTypes ()
 Get restricted file types (this is for the input form, this list will be empty, if "allowed list" is empty) More...
 
static getForbiddenFileTypes ()
 Get forbidden file types. More...
 
static getAllowedFileTypes ()
 Get allowed file types. More...
 
static isTypeAllowed ($a_type)
 Is type allowed. More...
 
static fixFilename ($a_name)
 Fix filename of uploaded file. More...
 
static renameExecutables ($a_dir)
 Rename executables. More...
 
- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _lookupImportId ($a_obj_id)
 
static _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
static _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static _lookupOwner ($a_id)
 lookup object owner More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
static _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
static _lookupObjId ($a_id)
 
static _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
static setDeletedDates ($a_ref_ids)
 Set deleted date @global type $ilDB. More...
 
static _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
static _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
static _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
static _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id More...
 
static _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type More...
 
static _exists ($a_id, $a_reference=false, $a_type=null)
 checks if an object exists in object_data@access public More...
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type. More...
 
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection. More...
 
static _getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item. More...
 
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies. More...
 
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies. More...
 
static getLongDescriptions (array $a_obj_ids)
 Get long description data. More...
 
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns. More...
 
static fixMissingTitles ($a_type, array &$a_obj_title_map)
 Try to fix missing object titles. More...
 
static _lookupCreationDate ($a_id)
 Lookup creation date. More...
 
static hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course. More...
 

Data Fields

 $is_alias
 
 $origin_id
 
 $id
 
 $media_items
 
 $contains_int_link
 
- Data Fields inherited from ilObject
const TITLE_LENGTH = 255
 max length of object title More...
 
const DESC_LENGTH = 128
 
 $lng
 
 $id
 
 $ref_id
 
 $type
 
 $title
 
 $untranslatedTitle
 
 $desc
 
 $long_desc
 
 $owner
 
 $create_date
 
 $last_update
 
 $import_id
 
 $register = false
 
 $referenced
 
 $objectList
 
 $max_title
 
 $max_desc
 
 $add_dots
 

Protected Member Functions

 escapeProperty ($a_value)
 Escape property (e.g. More...
 

Static Protected Member Functions

static handleQuotaUpdate (ilObjMediaObject $a_mob)
 

Protected Attributes

 $user
 
 $app_event_handler
 
- Protected Attributes inherited from ilObject
 $objDefinition
 
 $db
 
 $log
 
 $error
 
 $tree
 
 $app_event_handler
 
 $rbacadmin
 
 $rbacreview
 

Detailed Description

Class ilObjMediaObject.

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

ILIAS Media Object

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjMediaObject::__construct (   $a_id = 0)

Constructor @access public.

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

49 {
50 global $DIC;
51
52 $this->user = $DIC->user();
53 $this->app_event_handler = $DIC["ilAppEventHandler"];
54 $this->lng = $DIC->language();
55 $this->is_alias = false;
56 $this->media_items = array();
57 $this->contains_int_link = false;
58 $this->type = "mob";
59 parent::__construct($a_id, false);
60 }
user()
Definition: user.php:4
global $DIC
Definition: saml.php:7

References $DIC, and user().

+ Here is the call graph for this function:

Member Function Documentation

◆ _createThumbnailDirectory()

static ilObjMediaObject::_createThumbnailDirectory (   $a_obj_id)
static

Create thumbnail directory.

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

646 {
648 ilUtil::createDirectory(ilUtil::getWebspaceDir() . "/thumbs/mm_" . $a_obj_id);
649 }
static getWebspaceDir($mode="filesystem")
get webspace directory
static createDirectory($a_dir, $a_mod=0755)
create directory

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _deleteAllUsages()

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

static

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

1026 {
1027 global $DIC;
1028
1029 $ilDB = $DIC->database();
1030
1031 $and_hist = "";
1032 if ($a_usage_hist_nr !== false) {
1033 $and_hist = " AND usage_hist_nr = " . $ilDB->quote($a_usage_hist_nr, "integer");
1034 }
1035
1036 $mob_ids = array();
1037 $set = $ilDB->query("SELECT id FROM mob_usage" .
1038 " WHERE usage_type = " . $ilDB->quote($a_type, "text") .
1039 " AND usage_id = " . $ilDB->quote($a_id, "integer") .
1040 " AND usage_lang = " . $ilDB->quote($a_lang, "text") .
1041 $and_hist);
1042 while ($row = $ilDB->fetchAssoc($set)) {
1043 $mob_ids[] = $row["id"];
1044 }
1045
1046 $q = "DELETE FROM mob_usage WHERE usage_type = " .
1047 $ilDB->quote($a_type, "text") .
1048 " AND usage_id= " . $ilDB->quote($a_id, "integer") .
1049 " AND usage_lang = " . $ilDB->quote($a_lang, "text") .
1050 $and_hist;
1051 $ilDB->manipulate($q);
1052
1053 foreach ($mob_ids as $mob_id) {
1054 self::handleQuotaUpdate(new self($mob_id));
1055 }
1056 }
static handleQuotaUpdate(ilObjMediaObject $a_mob)
global $ilDB
$a_type
Definition: workflow.php:92

References $a_type, $DIC, $ilDB, $row, and handleQuotaUpdate().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _determineWidthHeight()

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

Determine width and height.

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

1511 {
1512 global $DIC;
1513
1514 $lng = $DIC->language();
1515
1516 // determine width and height of known image types
1517 //$width = 640;
1518 //$height = 360;
1519 $info = "";
1520
1521 if ($a_format == "audio/mpeg") {
1522 $width = 300;
1523 $height = 20;
1524 }
1525
1526 if (ilUtil::deducibleSize($a_format)) {
1527 include_once("./Services/MediaObjects/classes/class.ilMediaImageUtil.php");
1528 if ($a_type == "File") {
1530 } else {
1531 $size = ilMediaImageUtil::getImageSize($a_reference);
1532 }
1533 }
1534
1535 if ($a_use_original) {
1536 if ($size[0] > 0 && $size[1] > 0) {
1537 //$width = $size[0];
1538 //$height = $size[1];
1539 $width = "";
1540 $height = "";
1541 } else {
1542 $info = $lng->txt("cont_could_not_determine_resource_size");
1543 }
1544 } else {
1545 $w = (int) $a_user_width;
1546 $h = (int) $a_user_height;
1547 $width = $w;
1548 $height = $h;
1549 //echo "<br>C-$width-$height-";
1550 if (ilUtil::deducibleSize($a_format) && $a_constrain_proportions) {
1551 if ($size[0] > 0 && $size[1] > 0) {
1552 if ($w > 0) {
1553 $wr = $size[0] / $w;
1554 }
1555 if ($h > 0) {
1556 $hr = $size[1] / $h;
1557 }
1558 //echo "<br>+".$wr."+".$size[0]."+".$w."+";
1559 //echo "<br>+".$hr."+".$size[1]."+".$h."+";
1560 $r = max($wr, $hr);
1561 if ($r > 0) {
1562 $width = (int) ($size[0]/$r);
1563 $height = (int) ($size[1]/$r);
1564 }
1565 }
1566 }
1567 //echo "<br>D-$width-$height-";
1568 }
1569 //echo "<br>E-$width-$height-";
1570
1571 if ($width == 0 && $a_user_width === "") {
1572 $width = "";
1573 }
1574 if ($height == 0 && $a_user_height === "") {
1575 $height = "";
1576 }
1577
1578 return array("width" => $width, "height" => $height, "info" => $info);
1579 }
$size
Definition: RandomTest.php:84
static getImageSize($a_location)
Get image size from location.
static deducibleSize($a_mime)
checks if mime type is provided by getimagesize()
$h
$w
$r
Definition: example_031.php:79
$info
Definition: index.php:5

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _exists()

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

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

Parameters
int$idid
Returns
boolean true, if lm content object exists

Reimplemented from ilObject.

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

100 {
101 global $DIC;
102
103 $ilDB = $DIC->database();
104
105 include_once("./Services/Link/classes/class.ilInternalLink.php");
106 if (is_int(strpos($a_id, "_"))) {
108 }
109
110 if (parent::_exists($a_id, false) && ilObject::_lookupType($a_id) == "mob") {
111 return true;
112 }
113 return false;
114 }
static _lookupType($a_id, $a_reference=false)
lookup object type

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _getDirectory()

static ilObjMediaObject::_getDirectory (   $a_mob_id)
static

get directory for files of media object (static)

Parameters
int$a_mob_idmedia object id

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

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

References ilUtil\getWebspaceDir().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _getMobsOfObject()

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

get mobs of object

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

1062 {
1063 global $DIC;
1064
1065 $ilDB = $DIC->database();
1066
1067 $lstr = "";
1068 if ($a_lang != "") {
1069 $lstr = " AND usage_lang = " . $ilDB->quote($a_lang, "text");
1070 }
1071 $hist_str = "";
1072 if ($a_usage_hist_nr !== false) {
1073 $hist_str = " AND usage_hist_nr = " . $ilDB->quote($a_usage_hist_nr, "integer");
1074 }
1075
1076 $q = "SELECT * FROM mob_usage WHERE " .
1077 "usage_type = " . $ilDB->quote($a_type, "text") . " AND " .
1078 "usage_id = " . $ilDB->quote($a_id, "integer") .
1079 $lstr . $hist_str;
1080 $mobs = array();
1081 $mob_set = $ilDB->query($q);
1082 while ($mob_rec = $ilDB->fetchAssoc($mob_set)) {
1083 if (ilObject::_lookupType($mob_rec["id"]) == "mob") {
1084 $mobs[$mob_rec["id"]] = $mob_rec["id"];
1085 }
1086 }
1087
1088 return $mobs;
1089 }
$mobs

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _getSimpleMimeTypes()

static ilObjMediaObject::_getSimpleMimeTypes ( )
static

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

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

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

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

+ Here is the caller graph for this function:

◆ _getThumbnailDirectory()

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

get directory for files of media object (static)

Parameters
int$a_mob_idmedia object id

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

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

References ilUtil\getWebspaceDir().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _getURL()

static ilObjMediaObject::_getURL (   $a_mob_id)
static

get directory for files of media object (static)

Parameters
int$a_mob_idmedia object id
Returns
string

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

577 {
578 return ilUtil::getHtmlPath(ilUtil::getWebspaceDir() . "/mobs/mm_" . $a_mob_id);
579 }
static getHtmlPath($relative_path)
get url of path

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _lookupItemPath()

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

Get path for item with specific purpose.

Parameters
int$a_mob_idmedia object id

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

614 {
615 if ($a_purpose == "") {
616 $a_purpose = "Standard";
617 }
618 $location = ilMediaItem::_lookupLocationForMobId($a_mob_id, $a_purpose);
619 if (preg_match("/https?\:/i", $location)) {
620 return $location;
621 }
622
623 if ($a_url_encode) {
624 $location = rawurlencode($location);
625 }
626
627 $path = ($a_web)
628 ? ILIAS_HTTP_PATH
629 : ".";
630
631 return $path . "/data/" . CLIENT_ID . "/mobs/mm_" . $a_mob_id . "/" . $location;
632 }
$location
Definition: buildRTE.php:44
static _lookupLocationForMobId($a_mob_id, $a_purpose)
Lookup location for mob id.

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _lookupStandardItemPath()

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

Get path for standard item.

Parameters
int$a_mob_idmedia object id

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

600 {
601 return ilObjMediaObject::_lookupItemPath($a_mob_id, $a_url_encode, $a_web, "Standard");
602 }
static _lookupItemPath( $a_mob_id, $a_url_encode=false, $a_web=true, $a_purpose="")
Get path for item with specific purpose.

References _lookupItemPath().

Referenced by ilSCORM2004ScoGUI\getExportResources().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _removeUsage()

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

Remove usage of mob in another container.

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

1119 {
1120 global $DIC;
1121
1122 $ilDB = $DIC->database();
1123
1124 $q = "DELETE FROM mob_usage WHERE " .
1125 " id = " . $ilDB->quote((int) $a_mob_id, "integer") . " AND " .
1126 " usage_type = " . $ilDB->quote($a_type, "text") . " AND " .
1127 " usage_id = " . $ilDB->quote((int) $a_id, "integer") . " AND " .
1128 " usage_lang = " . $ilDB->quote($a_lang, "text") . " AND " .
1129 " usage_hist_nr = " . $ilDB->quote((int) $a_usage_hist_nr, "integer");
1130 $ilDB->manipulate($q);
1131
1132 self::handleQuotaUpdate(new self($a_mob_id));
1133 }

References $a_type, $DIC, $ilDB, and handleQuotaUpdate().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _resizeImage()

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

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

Parameters
string$a_filefull file name
int$a_widthwidth
int$a_heightheight

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

1466 {
1467 $file_path = pathinfo($a_file);
1468 $location = substr($file_path["basename"], 0, strlen($file_path["basename"]) -
1469 strlen($file_path["extension"]) - 1) . "_" .
1470 $a_width . "_" .
1471 $a_height . "." . $file_path["extension"];
1472 $target_file = $file_path["dirname"] . "/" .
1473 $location;
1475 $a_file,
1476 $target_file,
1477 (int) $a_width,
1478 (int) $a_height,
1479 $a_constrain_prop
1480 );
1481
1482 return $location;
1483 }
static resizeImage($a_from, $a_to, $a_width, $a_height, $a_constrain_prop=false)
resize image

References $location, and ilUtil\resizeImage().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _saveTempFileAsMediaObject()

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

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

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

1621 {
1622 // create dummy object in db (we need an id)
1623 $media_object = new ilObjMediaObject();
1624 $media_object->setTitle($name);
1625 $media_object->setDescription("");
1626 $media_object->create();
1627
1628 // determine and create mob directory, move uploaded file to directory
1629 $media_object->createDirectory();
1630 $mob_dir = ilObjMediaObject::_getDirectory($media_object->getId());
1631
1632 $media_item = new ilMediaItem();
1633 $media_object->addMediaItem($media_item);
1634 $media_item->setPurpose("Standard");
1635
1636 $file = $mob_dir . "/" . $name;
1637 if ($upload) {
1638 ilUtil::moveUploadedFile($tmp_name, $name, $file);
1639 } else {
1640 copy($tmp_name, $file);
1641 }
1642 // get mime type
1644 $location = $name;
1645 // set real meta and object data
1646 $media_item->setFormat($format);
1647 $media_item->setLocation($location);
1648 $media_item->setLocationType("LocalFile");
1649 $media_object->setTitle($name);
1650 $media_object->setDescription($format);
1651
1653 include_once("./Services/MediaObjects/classes/class.ilMediaImageUtil.php");
1655 $media_item->setWidth($size[0]);
1656 $media_item->setHeight($size[1]);
1657 }
1658 $media_item->setHAlign("Left");
1659
1660 self::renameExecutables($mob_dir);
1661 include_once("./Services/MediaObjects/classes/class.ilMediaSvgSanitizer.php");
1662 ilMediaSvgSanitizer::sanitizeDir($mob_dir); // see #20339
1663
1664 $media_object->update();
1665
1666 return $media_object;
1667 }
Class ilMediaItem.
static sanitizeDir($a_path)
Sanitize directory recursively.
Class ilObjMediaObject.
static getMimeType($a_file, $a_external=null)
get mime type for file
static _getDirectory($a_mob_id)
get directory for files of media object (static)
static renameExecutables($a_dir)
Rename executables.
if($format !==null) $name
Definition: metadata.php:146
$format
Definition: metadata.php:141
if(!file_exists("$old.txt")) if( $old===$new) if(file_exists("$new.txt")) $file

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

Referenced by assClozeTestImport\fromXML(), assErrorTextImport\fromXML(), assFileUploadImport\fromXML(), assFlashQuestionImport\fromXML(), assFormulaQuestionImport\fromXML(), assImagemapQuestionImport\fromXML(), assJavaAppletImport\fromXML(), assKprimChoiceImport\fromXML(), assMatchingQuestionImport\fromXML(), assMultipleChoiceImport\fromXML(), assNumericImport\fromXML(), assOrderingHorizontalImport\fromXML(), assOrderingQuestionImport\fromXML(), assSingleChoiceImport\fromXML(), assTextQuestionImport\fromXML(), assTextSubsetImport\fromXML(), ilObjTest\fromXML(), ilForumXMLParser\handlerEndTag(), ilObjSurvey\importObject(), ilSurveyImporter\importXmlRepresentation(), and ilSoapUtils\saveTempFileAsMediaObject().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _saveUsage()

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

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

page)

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

1095 {
1096 global $DIC;
1097
1098 $ilDB = $DIC->database();
1099
1100 $ilDB->replace(
1101 "mob_usage",
1102 array(
1103 "id" => array("integer", (int) $a_mob_id),
1104 "usage_type" => array("text", $a_type),
1105 "usage_id" => array("integer", $a_id),
1106 "usage_lang" => array("text", $a_lang),
1107 "usage_hist_nr" => array("integer", (int) $a_usage_hist_nr)
1108 ),
1109 array()
1110 );
1111
1112 self::handleQuotaUpdate(new self($a_mob_id));
1113 }

References $a_type, $DIC, $ilDB, and handleQuotaUpdate().

Referenced by ilRTE\_cleanupMediaObjectUsage(), ilForumDraftsHistory\addMobsToDraftsHistory(), ilObjForumGUI\addThreadObject(), ilObjForumGUI\autosaveDraftAsyncObject(), ilObjForumGUI\autosaveThreadDraftAsyncObject(), SurveyQuestion\copyXHTMLMediaObjectsOfQuestion(), assQuestion\copyXHTMLMediaObjectsOfQuestion(), assErrorTextImport\fromXML(), assFileUploadImport\fromXML(), assFlashQuestionImport\fromXML(), assFormulaQuestionImport\fromXML(), assImagemapQuestionImport\fromXML(), assJavaAppletImport\fromXML(), assKprimChoiceImport\fromXML(), assMatchingQuestionImport\fromXML(), assMultipleChoiceImport\fromXML(), assNumericImport\fromXML(), assOrderingHorizontalImport\fromXML(), assOrderingQuestionImport\fromXML(), assSingleChoiceImport\fromXML(), assTextQuestionImport\fromXML(), assTextSubsetImport\fromXML(), ilObjTest\fromXML(), ilForumXMLParser\handlerEndTag(), ilObjSurvey\importObject(), ilSurveyImporter\importXmlRepresentation(), ilForumUtil\moveMediaObjects(), ilDclMobRecordFieldModel\parseValue(), ilObjForumGUI\publishDraftObject(), ilObjForumGUI\publishThreadDraftObject(), ilForumUtil\saveMediaObjects(), ilPCMediaObject\saveMobUsage(), assQuestion\syncXHTMLMediaObjectsOfQuestion(), and ilExSubmissionTextGUI\updateAssignmentTextObject().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _useAutoStartParameterOnly()

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

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

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

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

1603 {
1604 $lpath = pathinfo($a_loc);
1605 if ($lpath["extension"] == "mp3" && $a_format == "audio/mpeg") {
1606 return true;
1607 }
1608 if ($lpath["extension"] == "flv") {
1609 return true;
1610 }
1611 if (in_array($a_format, array("video/mp4", "video/webm"))) {
1612 return true;
1613 }
1614 return false;
1615 }

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

+ Here is the caller graph for this function:

◆ addMediaItem()

ilObjMediaObject::addMediaItem (   $a_item)

add media item to media object

Parameters
object$a_itemmedia item object

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

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

◆ clearMultiSrtDirectory()

ilObjMediaObject::clearMultiSrtDirectory ( )

Clear multi feedback directory.

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

2038 {
2040 }
getMultiSrtUploadDir()
Get directory for multi srt upload.
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively

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

+ Here is the call graph for this function:

◆ containsIntLink()

ilObjMediaObject::containsIntLink ( )

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

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

1018 {
1020 }

References $contains_int_link.

◆ create()

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

create media object in db

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

453 {
454 parent::create();
455
456 if (!$a_create_meta_data) {
457 $this->createMetaData();
458 }
459
460 if ($a_save_media_items) {
461 $media_items = $this->getMediaItems();
462 for ($i=0; $i<count($media_items); $i++) {
463 $item = $media_items[$i];
464 $item->setMobId($this->getId());
465 $item->setNr($i+1);
466 $item->create();
467 }
468 }
469
471
472 $ilAppEventHandler = $this->app_event_handler;
473 $ilAppEventHandler->raise(
474 'Services/MediaObjects',
475 'create',
476 array('object' => $this,
477 'obj_type' => 'mob',
478 'obj_id' => $this->getId())
479 );
480 }
getId()
get object id @access public
& getMediaItems()
get all media items
createMetaData()
create meta data entry
$i
Definition: disco.tpl.php:19

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

+ Here is the call graph for this function:

◆ createDirectory()

ilObjMediaObject::createDirectory ( )

Create file directory of media object.

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

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

+ Here is the call graph for this function:

◆ createMetaData()

ilObjMediaObject::createMetaData ( )

create meta data entry

Reimplemented from ilObject.

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

227 {
228 include_once 'Services/MetaData/classes/class.ilMDCreator.php';
229
231
232 $md_creator = new ilMDCreator(0, $this->getId(), $this->getType());
233 $md_creator->setTitle($this->getTitle());
234 $md_creator->setTitleLanguage($ilUser->getPref('language'));
235 $md_creator->setDescription($this->getDescription());
236 $md_creator->setDescriptionLanguage($ilUser->getPref('language'));
237 $md_creator->setKeywordLanguage($ilUser->getPref('language'));
238 $md_creator->setLanguage($ilUser->getPref('language'));
239 $md_creator->create();
240
241 return true;
242 }
getTitle()
get object title @access public
getDescription()
get description of media object
getType()
get object type @access public
$ilUser
Definition: imgupload.php:18

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

Referenced by create().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ createReference()

ilObjMediaObject::createReference ( )

creates reference for object

@access public

Returns
integer reference_id of object

Reimplemented from ilObject.

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

78 {
79 $this->ilias->raiseError("Operation ilObjMedia::createReference() not allowed.", $this->ilias->error_obj->FATAL);
80 }
redirection script todo: (a better solution should control the processing via a xml file)

◆ delete()

ilObjMediaObject::delete ( )

delete media object

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

120 {
121 $mob_logger = ilLoggerFactory::getLogger('mob');
122 $mob_logger->debug("ilObjMediaObject: Delete called for media object ID '" . $this->getId() . "'.");
123
124 if (!($this->getId() > 0)) {
125 return;
126 }
127
128 $usages = $this->getUsages();
129
130 $mob_logger->debug("ilObjMediaObject: ... Found " . count($usages) . " usages.");
131
132 if (count($usages) == 0) {
133 // remove directory
135
136 // remove thumbnail directory
138
139 // delete meta data of mob
140 $this->deleteMetaData();
141
142 // delete media items
144
145 // this is just to make sure, there should be no entries left at
146 // this point as they depend on the usage
148
149 // delete object
150 parent::delete();
151
152 $mob_logger->debug("ilObjMediaObject: ... deleted.");
153 } else {
154 foreach ($usages as $u) {
155 $mob_logger->debug("ilObjMediaObject: ... usage type:" . $u["type"] .
156 ", id:" . $u["id"] .
157 ", lang:" . $u["lang"] .
158 ", hist_nr:" . $u["hist_nr"] . ".");
159 }
160 $mob_logger->debug("ilObjMediaObject: ... not deleted.");
161 }
162 }
static getLogger($a_component_id)
Get component logger.
static deleteAllItemsOfMob($a_mob_id)
Delete all items of a mob.
static _getThumbnailDirectory($a_mob_id, $a_mode="filesystem")
get directory for files of media object (static)
deleteMetaData()
delete meta data entry
getUsages($a_include_history=true)
get all usages of current media object

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

+ Here is the call graph for this function:

◆ deleteMetaData()

ilObjMediaObject::deleteMetaData ( )

delete meta data entry

Reimplemented from ilObject.

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

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

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

Referenced by delete().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ duplicate()

ilObjMediaObject::duplicate ( )

Duplicate media object, return new media object.

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

1881 {
1882 $new_obj = new ilObjMediaObject();
1883 $new_obj->setTitle($this->getTitle());
1884 $new_obj->setDescription($this->getDescription());
1885
1886 // media items
1887 foreach ($this->getMediaItems() as $key => $val) {
1888 $new_obj->addMediaItem($val);
1889 }
1890
1891 $new_obj->create(false, true);
1892
1893 // files
1894 $new_obj->createDirectory();
1895 self::_createThumbnailDirectory($new_obj->getId());
1898 ilObjMediaObject::_getDirectory($new_obj->getId())
1899 );
1903 );
1904
1905 // meta data
1906 include_once("Services/MetaData/classes/class.ilMD.php");
1907 $md = new ilMD(0, $this->getId(), "mob");
1908 $new_md = $md->cloneMD(0, $new_obj->getId(), "mob");
1909
1910 return $new_obj;
1911 }
static _createThumbnailDirectory($a_obj_id)
Create thumbnail directory.
static rCopy($a_sdir, $a_tdir, $preserveTimeAttributes=false)
Copies content of a directory $a_sdir recursively to a directory $a_tdir.
$key
Definition: croninfo.php:18

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

+ Here is the call graph for this function:

◆ escapeProperty()

ilObjMediaObject::escapeProperty (   $a_value)
protected

Escape property (e.g.

title, caption) to XSLT -> HTML output

Parameters
string$a_value
Returns
string

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

889 {
890 return htmlspecialchars($a_value);
891 }

Referenced by getXML().

+ Here is the caller graph for this function:

◆ exportFiles()

ilObjMediaObject::exportFiles (   $a_target_dir)

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

Parameters
string$a_target_dirtarget directory

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

921 {
922 $subdir = "il_" . IL_INST_ID . "_mob_" . $this->getId();
923 ilUtil::makeDir($a_target_dir . "/objects/" . $subdir);
924
925 $mobdir = ilUtil::getWebspaceDir() . "/mobs/mm_" . $this->getId();
926 ilUtil::rCopy($mobdir, $a_target_dir . "/objects/" . $subdir);
927 //echo "from:$mobdir:to:".$a_target_dir."/objects/".$subdir.":<br>";
928 }
static makeDir($a_dir)
creates a new directory and inherits all filesystem permissions of the parent directory You may pass ...

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

+ Here is the call graph for this function:

◆ exportMediaFullscreen()

ilObjMediaObject::exportMediaFullscreen (   $a_target_dir,
  $pg_obj 
)

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

931 {
932 $subdir = "il_" . IL_INST_ID . "_mob_" . $this->getId();
933 $a_target_dir = $a_target_dir . "/objects/" . $subdir;
934 ilUtil::makeDir($a_target_dir);
935 $tpl = new ilTemplate("tpl.fullscreen.html", true, true, "Modules/LearningModule");
936 $tpl->setCurrentBlock("ilMedia");
937
938 //$int_links = $page_object->getInternalLinks();
939 $med_links = ilMediaItem::_getMapAreasIntLinks($this->getId());
940
941 // @todo
942 //$link_xml = $this->getLinkXML($med_links, $this->getLayoutLinkTargets());
943
944 require_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
945 //$media_obj = new ilObjMediaObject($_GET["mob_id"]);
946 require_once("./Services/COPage/classes/class.ilPageObject.php");
947
948 $xml = "<dummy>";
949 // todo: we get always the first alias now (problem if mob is used multiple
950 // times in page)
951 $xml.= $pg_obj->getMediaAliasElement($this->getId());
952 $xml.= $this->getXML(IL_MODE_OUTPUT);
953 //$xml.= $link_xml;
954 $xml.="</dummy>";
955
956 //die(htmlspecialchars($xml));
957
958 $xsl = file_get_contents("./Services/COPage/xsl/page.xsl");
959 $args = array( '/_xml' => $xml, '/_xsl' => $xsl );
960 $xh = xslt_create();
961
962 //echo "<b>XML:</b>".htmlentities($xml);
963 // determine target frames for internal links
964 $wb_path = "";
965 $enlarge_path = "";
966 $params = array('mode' => "fullscreen", 'enlarge_path' => $enlarge_path,
967 'link_params' => "ref_id=" . $_GET["ref_id"],'fullscreen_link' => "",
968 'ref_id' => $_GET["ref_id"], 'webspace_path' => $wb_path);
969 $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", null, $args, $params);
970 //echo xslt_error($xh);
971 xslt_free($xh);
972
973 // unmask user html
974 include_once("./Services/MediaObjects/classes/class.ilPlayerUtil.php");
975 $tpl->setVariable("LOCATION_CONTENT_STYLESHEET", "../../css/style.css");
976 $tpl->setVariable("LOCATION_STYLESHEET", "../../css/system.css");
977 $tpl->setVariable("MEDIA_CONTENT", $output);
978 $output = $tpl->get();
979 //$output = preg_replace("/\/mobs\/mm_(\d+)\/([^\"]+)/i","$2",$output);
980 $output = preg_replace("/mobs\/mm_(\d+)\/([^\"]+)/i", "$2", $output);
981 $output = preg_replace("/\.\/Services\/MediaObjects\/flash_mp3_player/i", "../../players", $output);
982 $output = preg_replace("/\.\/" . str_replace("/", "\/", ilPlayerUtil::getFlashVideoPlayerDirectory()) . "/i", "../../players", $output);
983 $output = preg_replace("/file=..\/..\/..\//i", "file=../objects/" . $subdir . "/", $output);
984 //die(htmlspecialchars($output));
985 fwrite(fopen($a_target_dir . '/fullscreen.html', 'w'), $output);
986 }
$tpl
Definition: ilias.php:10
$_GET["client_id"]
const IL_MODE_OUTPUT
static _getMapAreasIntLinks($a_mob_id)
get all internal links of map areas of a mob
getXML($a_mode=IL_MODE_FULL, $a_inst=0, $a_sign_locals=false)
get MediaObject XLM Tag
static getFlashVideoPlayerDirectory()
Get flash video player directory.
special template class to simplify handling of ITX/PEAR
if(!is_dir( $entity_dir)) exit("Fatal Error ([A-Za-z0-9]+)\s+" &#(? foreach( $entity_files as $file) $output
xslt_free(&$proc)
xslt_create()
$xml
Definition: metadata.php:240
$params
Definition: disable.php:11

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

+ Here is the call graph for this function:

◆ exportXML()

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

export XML

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

908 {
909 $a_xml_writer->appendXML($this->getXML(IL_MODE_FULL, $a_inst));
910 }
const IL_MODE_FULL

References getXML(), and IL_MODE_FULL.

+ Here is the call graph for this function:

◆ fixFilename()

static ilObjMediaObject::fixFilename (   $a_name)
static

Fix filename of uploaded file.

Parameters
string$a_nameupload file name
Returns
string fixed file name

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

1989 {
1990 $a_name = ilUtil::getASCIIFilename($a_name);
1991
1992 $rchars = array("`", "=", "$", "{", "}", "'", ";", " ", "(", ")");
1993 $a_name = str_replace($rchars, "_", $a_name);
1994 $a_name = str_replace("__", "_", $a_name);
1995 return $a_name;
1996 }
static getASCIIFilename($a_filename)
convert utf8 to ascii filename

References ilUtil\getASCIIFilename().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ generatePreviewPic()

ilObjMediaObject::generatePreviewPic (   $a_width,
  $a_height 
)

Upload video preview picture.

Parameters

return

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

1940 {
1941 $item = $this->getMediaItem("Standard");
1942
1943 if ($item->getLocationType() == "LocalFile" &&
1944 is_int(strpos($item->getFormat(), "image/"))) {
1945 $dir = ilObjMediaObject::_getDirectory($this->getId());
1946 $file = $dir . "/" .
1947 $item->getLocation();
1948 if (is_file($file)) {
1949 if (ilUtil::isConvertVersionAtLeast("6.3.8-3")) {
1950 ilUtil::execConvert(ilUtil::escapeShellArg($file) . "[0] -geometry " . $a_width . "x" . $a_height . "^ -gravity center -extent " . $a_width . "x" . $a_height . " PNG:" . $dir . "/mob_vpreview.png");
1951 } else {
1952 ilUtil::convertImage($file, $dir . "/mob_vpreview.png", "PNG", $a_width . "x" . $a_height);
1953 }
1954 }
1955 }
1956 }
& getMediaItem($a_purpose)
get item for media purpose
static convertImage( $a_from, $a_to, $a_target_format="", $a_geometry="", $a_background_color="")
convert image
static isConvertVersionAtLeast($a_version)
Compare convert version numbers.
static escapeShellArg($a_arg)
static execConvert($args)
execute convert command

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

+ Here is the call graph for this function:

◆ getAllowedFileTypes()

static ilObjMediaObject::getAllowedFileTypes ( )
static

Get allowed file types.

Returns
array

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

1846 {
1847 $mset = new ilSetting("mobs");
1848 if (trim($mset->get("restricted_file_types")) == "") {
1849 return array();
1850 }
1851 return array_map(
1852 function ($v) {
1853 return strtolower(trim($v));
1854 },
1855 explode(",", $mset->get("restricted_file_types"))
1856 );
1857 }
ILIAS Setting Class.

◆ getDataDirectory()

ilObjMediaObject::getDataDirectory ( )

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

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

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

Referenced by getXML(), and handleQuotaUpdate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getDescription()

ilObjMediaObject::getDescription ( )

get description of media object

Returns
string description

Reimplemented from ilObject.

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

170 {
171 return parent::getDescription();
172 }
static getDescription()
Definition: Php.php:51

References Gettext\Languages\Exporter\getDescription().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getFilesOfDirectory()

ilObjMediaObject::getFilesOfDirectory (   $a_subdir = "")

Get files of directory.

Parameters
string$a_subdirsubdirectry
Returns
array array of files

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

658 {
659 $a_subdir = str_replace("..", "", $a_subdir);
660 $dir = ilObjMediaObject::_getDirectory($this->getId());
661 if ($a_subdir != "") {
662 $dir.= "/" . $a_subdir;
663 }
664
665 $files = array();
666 if (is_dir($dir)) {
667 $entries = ilUtil::getDir($dir);
668 foreach ($entries as $e) {
669 if (is_file($dir . "/" . $e["entry"]) && $e["entry"] != "." && $e["entry"] != "..") {
670 $files[] = $e["entry"];
671 }
672 }
673 }
674
675 return $files;
676 }
$files
Definition: add-vimline.php:18
static getDir($a_dir, $a_rec=false, $a_sub_dir="")
get directory

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

+ Here is the call graph for this function:

◆ getForbiddenFileTypes()

static ilObjMediaObject::getForbiddenFileTypes ( )
static

Get forbidden file types.

Returns
array

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

1827 {
1828 $mset = new ilSetting("mobs");
1829 if (trim($mset->get("black_list_file_types")) == "") {
1830 return array();
1831 }
1832 return array_map(
1833 function ($v) {
1834 return strtolower(trim($v));
1835 },
1836 explode(",", $mset->get("black_list_file_types"))
1837 );
1838 }

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

+ Here is the caller graph for this function:

◆ getId()

◆ getImportId()

ilObjMediaObject::getImportId ( )

get import id

Reimplemented from ilObject.

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

440 {
441 return $this->import_id;
442 }

References ilObject\$import_id.

◆ getLinkedMediaObjects()

ilObjMediaObject::getLinkedMediaObjects (   $a_ignore = "")

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

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

1782 {
1783 $linked = array();
1784
1785 if (!is_array($a_ignore)) {
1786 $a_ignore = array();
1787 }
1788
1789 // get linked media objects (map areas)
1790 $med_items = $this->getMediaItems();
1791
1792 foreach ($med_items as $med_item) {
1793 $int_links = ilMapArea::_getIntLinks($med_item->getId());
1794 foreach ($int_links as $k => $int_link) {
1795 if ($int_link["Type"] == "MediaObject") {
1796 include_once("./Services/Link/classes/class.ilInternalLink.php");
1797 $l_id = ilInternalLink::_extractObjIdOfTarget($int_link["Target"]);
1798 if (ilObject::_exists($l_id)) {
1799 if (!in_array($l_id, $linked) &&
1800 !in_array($l_id, $a_ignore)) {
1801 $linked[] = $l_id;
1802 }
1803 }
1804 }
1805 }
1806 }
1807 //var_dump($linked);
1808 return $linked;
1809 }
static _getIntLinks($a_item_id)
get all internal links of a media items map areas
static _exists($a_id, $a_reference=false, $a_type=null)
checks if an object exists in object_data@access public

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

+ Here is the call graph for this function:

◆ getMediaItem()

& ilObjMediaObject::getMediaItem (   $a_purpose)

get item for media purpose

Parameters
string$a_purpose
Returns
ilMediaItem

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

307 {
308 foreach ($this->media_items as $media_item) {
309 if ($media_item->getPurpose() == $a_purpose) {
310 return $media_item;
311 }
312 }
313 return false;
314 }

Referenced by generatePreviewPic(), and hasPurposeItem().

+ Here is the caller graph for this function:

◆ getMediaItemNr()

ilObjMediaObject::getMediaItemNr (   $a_purpose)

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

349 {
350 for ($i=0; $i<count($this->media_items); $i++) {
351 if ($this->media_items[$i]->getPurpose() == $a_purpose) {
352 return $i + 1;
353 }
354 }
355 return false;
356 }

References $i.

◆ getMediaItems()

& ilObjMediaObject::getMediaItems ( )

get all media items

Returns
array array of media item objects

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

296 {
297 return $this->media_items;
298 }

References $media_items.

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

+ Here is the caller graph for this function:

◆ getMimeType()

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

get mime type for file

Parameters
string$a_filefile name
Returns
string mime type static

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

1493 {
1494 include_once("./Services/Utilities/classes/class.ilMimeTypeUtil.php");
1496 return $mime;
1497 }
static lookupMimeType($path_to_file, $fallback=self::APPLICATION__OCTET_STREAM, $a_external=null)

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiSrtFiles()

ilObjMediaObject::getMultiSrtFiles ( )

Get all srt files of srt multi upload.

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

2046 {
2047 $items = array();
2048
2049 include_once("./Services/MetaData/classes/class.ilMDLanguageItem.php");
2051
2052 $dir = $this->getMultiSrtUploadDir();
2053 $files = ilUtil::getDir($dir);
2054 foreach ($files as $k => $i) {
2055 // check directory
2056 if ($i["type"] == "file" && !in_array($k, array(".", ".."))) {
2057 if (pathinfo($k, PATHINFO_EXTENSION) == "srt") {
2058 $lang = "";
2059 if (substr($k, strlen($k) - 7, 1) == "_") {
2060 $lang = substr($k, strlen($k) - 6, 2);
2061 if (!in_array($lang, $lang_codes)) {
2062 $lang = "";
2063 }
2064 }
2065 $items[] = array("filename" => $k, "lang" => $lang);
2066 }
2067 }
2068 }
2069 return $items;
2070 }
$lang
Definition: consent.php:3

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

+ Here is the call graph for this function:

◆ getMultiSrtUploadDir()

ilObjMediaObject::getMultiSrtUploadDir ( )

Get directory for multi srt upload.

Parameters

return

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

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

References _getDirectory(), and getId().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getOriginID()

ilObjMediaObject::getOriginID ( )

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

425 {
426 return $this->origin_id;
427 }

References $origin_id.

◆ getParentObjectIdForUsage()

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

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

see ilWebAccessChecker

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

1238 {
1239 if (is_int(strpos($a_usage["type"], ":"))) {
1240 $us_arr = explode(":", $a_usage["type"]);
1241 $type = $us_arr[1];
1242 $cont_type = $us_arr[0];
1243 } else {
1244 $type = $a_usage["type"];
1245 }
1246
1247 $id = $a_usage["id"];
1248 $obj_id = false;
1249
1250 switch ($type) {
1251 // RTE / tiny mce
1252 case "html":
1253
1254 switch ($cont_type) {
1255 case "qpl":
1256 // Question Pool *Question* Text (Test)
1257 include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
1259 if ($qinfo["original_id"] > 0) {
1260 include_once("./Modules/Test/classes/class.ilObjTest.php");
1261 $obj_id = ilObjTest::_lookupTestObjIdForQuestionId($id); // usage in test
1262 } else {
1263 $obj_id = $qinfo["obj_fi"]; // usage in pool
1264 }
1265 break;
1266
1267 case "spl":
1268 // Question Pool *Question* Text (Survey)
1269 include_once("./Modules/SurveyQuestionPool/classes/class.SurveyQuestion.php");
1271 if ($quest) {
1272 $parent_id = $quest->getObjId();
1273
1274 // pool question copy - find survey, do not use pool itself
1275 if ($quest->getOriginalId() &&
1276 ilObject::_lookupType($parent_id) == "spl") {
1278 }
1279 // original question (in pool or survey)
1280 else {
1281 $obj_id = $parent_id;
1282 }
1283
1284 unset($quest);
1285 }
1286 break;
1287
1288 case "exca":
1289 // Exercise assignment
1290 $returned_pk = $a_usage['id'];
1291 // #15995 - we are just checking against exercise object
1292 include_once 'Modules/Exercise/classes/class.ilExSubmission.php';
1293 $obj_id = ilExSubmission::lookupExerciseIdForReturnedId($returned_pk);
1294 break;
1295
1296 case "frm":
1297 // Forum
1298 $post_pk = $a_usage['id'];
1299 include_once 'Modules/Forum/classes/class.ilForumPost.php';
1300 include_once 'Modules/Forum/classes/class.ilForum.php';
1301 $oPost = new ilForumPost($post_pk);
1302 $frm_pk = $oPost->getForumId();
1303 $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
1304 break;
1305
1306
1307 case "frm~d":
1308 $draft_id = $a_usage['id'];
1309 include_once 'Modules/Forum/classes/class.ilForumPostDraft.php';
1310 include_once 'Modules/Forum/classes/class.ilForum.php';
1311 $oDraft = ilForumPostDraft::newInstanceByDraftId($draft_id);
1312
1313 $frm_pk = $oDraft->getForumId();
1314 $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
1315 break;
1316 case "frm~h":
1317 $history_id = $a_usage['id'];
1318 include_once 'Modules/Forum/classes/class.ilForumDraftsHistory.php';
1319 include_once 'Modules/Forum/classes/class.ilForumPostDraft.php';
1320 include_once 'Modules/Forum/classes/class.ilForum.php';
1321 $oHistoryDraft = new ilForumDraftsHistory($history_id);
1322 $oDraft = ilForumPostDraft::newInstanceByDraftId($oHistoryDraft->getDraftId());
1323
1324 $frm_pk = $oDraft->getForumId();
1325 $obj_id = ilForum::_lookupObjIdForForumId($frm_pk);
1326 break;
1327 // temporary items (per user)
1328 case "frm~":
1329 case "exca~":
1330 $obj_id = $a_usage['id'];
1331 break;
1332
1333 // "old" category pages
1334 case "cat":
1335 // InfoScreen Text
1336 case "tst":
1337 case "svy":
1338 // data collection
1339 case "dcl":
1340 $obj_id = $id;
1341 break;
1342 }
1343 break;
1344
1345 // page editor
1346 case "pg":
1347
1348 switch ($cont_type) {
1349 // question feedback // parent obj id is q id
1350 case "qfbg":
1351 include_once('./Services/COPage/classes/class.ilPageObject.php');
1353 // note: no break here, we only altered the $id to the question id
1354
1355 // no break
1356 case "qpl":
1357 // Question Pool Question Pages
1358 include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
1360 if ($qinfo["original_id"] > 0) {
1361 include_once("./Modules/Test/classes/class.ilObjTest.php");
1362 $obj_id = ilObjTest::_lookupTestObjIdForQuestionId($id); // usage in test
1363 } else {
1364 $obj_id = $qinfo["obj_fi"]; // usage in pool
1365 }
1366 if ($obj_id == 0) { // this is the case, if question is in learning module -> get lm id
1367 include_once("./Services/COPage/classes/class.ilPCQuestion.php");
1369 if ($pinfo && $pinfo["parent_type"] == "lm") {
1370 include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
1371 $obj_id = ilLMObject::_lookupContObjID($pinfo["page_id"]);
1372 }
1373 $pinfo = ilPCQuestion::_getPageForQuestionId($id, "sahs");
1374 if ($pinfo && $pinfo["parent_type"] == "sahs") {
1375 include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Node.php");
1376 $obj_id = ilSCORM2004Node::_lookupSLMID($pinfo["page_id"]);
1377 }
1378 }
1379 break;
1380
1381 case "lm":
1382 // learning modules
1383 include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
1385 break;
1386
1387 case "gdf":
1388 // glossary definition
1389 include_once("./Modules/Glossary/classes/class.ilGlossaryDefinition.php");
1390 include_once("./Modules/Glossary/classes/class.ilGlossaryTerm.php");
1392 $obj_id = ilGlossaryTerm::_lookGlossaryID($term_id);
1393 break;
1394
1395 case "wpg":
1396 // wiki page
1397 include_once 'Modules/Wiki/classes/class.ilWikiPage.php';
1399 break;
1400
1401 case "sahs":
1402 // sahs page
1403 // can this implementation be used for other content types, too?
1404 include_once('./Services/COPage/classes/class.ilPageObject.php');
1405 $obj_id = ilPageObject::lookupParentId($id, 'sahs');
1406 break;
1407
1408 case "prtf":
1409 // portfolio
1410 include_once "Modules/Portfolio/classes/class.ilPortfolioPage.php";
1412 break;
1413
1414 case "prtt":
1415 // portfolio template
1416 include_once "Modules/Portfolio/classes/class.ilPortfolioTemplatePage.php";
1418 break;
1419
1420 case "blp":
1421 // blog
1422 include_once('./Services/COPage/classes/class.ilPageObject.php');
1423 $obj_id = ilPageObject::lookupParentId($id, 'blp');
1424 break;
1425
1426 case "impr":
1427 // imprint page - always id 1
1428 // fallthrough
1429
1430 case "crs":
1431 case "grp":
1432 case "cat":
1433 case "fold":
1434 case "root":
1435 case "cont":
1436 case "cstr":
1437 // repository pages
1438 $obj_id = $id;
1439 break;
1440 }
1441 break;
1442
1443 // Media Pool
1444 case "mep":
1445 $obj_id = $id;
1446 break;
1447
1448 // News Context Object (e.g. MediaCast)
1449 case "news":
1450 include_once("./Services/News/classes/class.ilNewsItem.php");
1452 break;
1453 }
1454
1455 return $obj_id;
1456 }
static _instanciateQuestion($question_id)
Creates an instance of a question with a given question id.
static _lookupSurveyObjId($a_question_id)
static _getQuestionInfo($question_id)
Returns question information from the database.
static lookupExerciseIdForReturnedId($a_returned_id)
Get exercise from submission id (used in ilObjMediaObject)
Class ilForumDraftHistory.
static newInstanceByDraftId($draft_id)
static _lookupObjIdForForumId($a_for_id)
static _lookupTermId($a_def_id)
Looks up term id for a definition id.
static _lookGlossaryID($term_id)
get glossary id form term id
static _lookupContObjID($a_id)
get learning module / digibook id for lm object
static _lookupContextObjId($a_news_id)
Context Object ID.
static _lookupTestObjIdForQuestionId($a_q_id)
Get test Object ID for question ID.
static _getPageForQuestionId($a_q_id, $a_parent_type="")
Get page for question id.
static lookupParentId($a_id, $a_type)
Lookup parent id.
static findPortfolioForPage($a_page_id)
Get portfolio id of page id.
static _lookupSLMID($a_id)
Lookup Scorm Learning Module ID for node id.
static lookupObjIdByPage($a_page_id)
returns the wiki/object id to a given page id

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getRefId()

ilObjMediaObject::getRefId ( )

get reference id @access public

Returns
integer reference id

Reimplemented from ilObject.

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

68 {
69 return false;
70 }

◆ getRestrictedFileTypes()

static ilObjMediaObject::getRestrictedFileTypes ( )
static

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

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

1815 {
1816 return array_filter(self::getAllowedFileTypes(), function ($v) {
1817 return !in_array($v, self::getForbiddenFileTypes());
1818 });
1819 }

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

+ Here is the caller graph for this function:

◆ getSrtFiles()

ilObjMediaObject::getSrtFiles ( )

Get srt files.

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

1709 {
1710 $srt_dir = ilObjMediaObject::_getDirectory($this->getId()) . "/srt";
1711
1712 if (!is_dir($srt_dir)) {
1713 return array();
1714 }
1715
1716 $items = ilUtil::getDir($srt_dir);
1717
1718 $srt_files = array();
1719 foreach ($items as $i) {
1720 if (!in_array($i["entry"], array(".", "..")) && $i["type"] == "file") {
1721 $name = explode(".", $i["entry"]);
1722 if ($name[1] == "srt" && substr($name[0], 0, 9) == "subtitle_") {
1723 $srt_files[] = array("file" => $i["entry"],
1724 "full_path" => "srt/" . $i["entry"], "language" => substr($name[0], 9, 2));
1725 }
1726 }
1727 }
1728
1729 return $srt_files;
1730 }

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

Referenced by getXML().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getThumbnailPath()

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

Get thumbnail path.

Parameters
string$a_thumbnamethumbnail file name
Returns
string thumbnail path

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

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

References _getThumbnailDirectory().

Referenced by ilPCIIMOverlaysTableGUI\fillRow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getTitle()

ilObjMediaObject::getTitle ( )

get object title @access public

Returns
string object title

Reimplemented from ilObject.

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

88 {
89 return parent::getTitle();
90 }

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

+ Here is the caller graph for this function:

◆ getUsages()

ilObjMediaObject::getUsages (   $a_include_history = true)

get all usages of current media object

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

1139 {
1140 return self::lookupUsages($this->getId(), $a_include_history);
1141 }
static lookupUsages($a_id, $a_include_history=true)
Lookup usages of media object.

References getId(), and lookupUsages().

Referenced by delete(), and handleQuotaUpdate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getVideoPreviewPic()

ilObjMediaObject::getVideoPreviewPic (   $a_filename_only = false)

Get video preview pic.

Parameters

return

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

1965 {
1966 $dir = ilObjMediaObject::_getDirectory($this->getId());
1967 $ppics = array("mob_vpreview.jpg",
1968 "mob_vpreview.jpeg",
1969 "mob_vpreview.png");
1970 foreach ($ppics as $p) {
1971 if (is_file($dir . "/" . $p)) {
1972 if ($a_filename_only) {
1973 return $p;
1974 } else {
1975 return $dir . "/" . $p;
1976 }
1977 }
1978 }
1979 return "";
1980 }

References _getDirectory(), and getId().

Referenced by uploadVideoPreviewPic().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getXML()

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

get MediaObject XLM Tag

Parameters
int$a_modeIL_MODE_ALIAS | IL_MODE_OUTPUT | IL_MODE_FULL

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

684 {
686
687 // TODO: full implementation of all parameters
688 //echo "-".$a_mode."-";
689 switch ($a_mode) {
690 case IL_MODE_ALIAS:
691 $xml = "<MediaObject>";
692 $xml .= "<MediaAlias OriginId=\"il__mob_" . $this->getId() . "\"/>";
693 $media_items = $this->getMediaItems();
694 for ($i=0; $i<count($media_items); $i++) {
695 $item = $media_items[$i];
696 $xml .= "<MediaAliasItem Purpose=\"" . $item->getPurpose() . "\">";
697
698 // Layout
699 $width = ($item->getWidth() != "")
700 ? "Width=\"" . $item->getWidth() . "\""
701 : "";
702 $height = ($item->getHeight() != "")
703 ? "Height=\"" . $item->getHeight() . "\""
704 : "";
705 $halign = ($item->getHAlign() != "")
706 ? "HorizontalAlign=\"" . $item->getHAlign() . "\""
707 : "";
708 $xml .= "<Layout $width $height $halign />";
709
710 // Caption
711 if ($item->getCaption() != "") {
712 $xml .= "<Caption Align=\"bottom\">" .
713 $this->escapeProperty($item->getCaption()) . "</Caption>";
714 }
715
716 // Text Representation
717 if ($item->getTextRepresentation() != "") {
718 $xml .= "<TextRepresentation>" .
719 $this->escapeProperty($item->getTextRepresentation()) . "</TextRepresentation>";
720 }
721
722 // Parameter
723 $parameters = $item->getParameters();
724 foreach ($parameters as $name => $value) {
725 $xml .= "<Parameter Name=\"$name\" Value=\"$value\"/>";
726 }
727 $xml .= $item->getMapAreasXML();
728 $xml .= "</MediaAliasItem>";
729 }
730 break;
731
732 // for output we need technical sections of meta data
733 case IL_MODE_OUTPUT:
734
735 // get first technical section
736// $meta = $this->getMetaData();
737 $xml = "<MediaObject Id=\"il__mob_" . $this->getId() . "\">";
738
739 $media_items = $this->getMediaItems();
740 for ($i=0; $i<count($media_items); $i++) {
741 $item = $media_items[$i];
742
743 $xml .= "<MediaItem Purpose=\"" . $item->getPurpose() . "\">";
744
745 if ($a_sign_locals && $item->getLocationType() == "LocalFile") {
746 require_once 'Services/WebAccessChecker/classes/class.ilWACSignedPath.php';
747 $location = ilWACSignedPath::signFile($this->getDataDirectory() . "/" . $item->getLocation());
748 $location = substr($location, strrpos($location, "/") + 1);
749 } else {
750 $location = $item->getLocation();
751 if ($item->getLocationType() != "LocalFile") { //#25941
753 }
754 }
755
756 $xml.= "<Location Type=\"" . $item->getLocationType() . "\">" .
757 $this->handleAmps($location) . "</Location>";
758
759 // Format
760 $xml.= "<Format>" . $item->getFormat() . "</Format>";
761
762 // Layout
763 $width = ($item->getWidth() != "")
764 ? "Width=\"" . $item->getWidth() . "\""
765 : "";
766 $height = ($item->getHeight() != "")
767 ? "Height=\"" . $item->getHeight() . "\""
768 : "";
769 $halign = ($item->getHAlign() != "")
770 ? "HorizontalAlign=\"" . $item->getHAlign() . "\""
771 : "";
772 $xml .= "<Layout $width $height $halign />";
773
774 // Caption
775 if ($item->getCaption() != "") {
776 $xml .= "<Caption Align=\"bottom\">" .
777 $this->escapeProperty($item->getCaption()) . "</Caption>";
778 }
779
780 // Text Representation
781 if ($item->getTextRepresentation() != "") {
782 $xml .= "<TextRepresentation>" .
783 $this->escapeProperty($item->getTextRepresentation()) . "</TextRepresentation>";
784 }
785
786 // Title
787 if ($this->getTitle() != "") {
788 $xml .= "<Title>" .
789 str_replace("&", "&amp;", $this->getTitle()) . "</Title>";
790 }
791
792 // Parameter
793 $parameters = $item->getParameters();
794 foreach ($parameters as $name => $value) {
795 $xml .= "<Parameter Name=\"$name\" Value=\"$value\"/>";
796 }
797 $xml .= $item->getMapAreasXML();
798
799 // Subtitles
800 if ($item->getPurpose() == "Standard") {
801 $srts = $this->getSrtFiles();
802 foreach ($srts as $srt) {
803 $def = "";
804 $meta_lang = "";
805 if ($ilUser->getLanguage() != $meta_lang &&
806 $ilUser->getLanguage() == $srt["language"]) {
807 $def = ' Default="true" ';
808 }
809 $xml .= "<Subtitle File=\"" . $srt["full_path"] .
810 "\" Language=\"" . $srt["language"] . "\" " . $def . "/>";
811 }
812 }
813 $xml .= "</MediaItem>";
814 }
815 break;
816
817 // full xml for export
818 case IL_MODE_FULL:
819
820// $meta = $this->getMetaData();
821 $xml = "<MediaObject>";
822
823 // meta data
824 include_once("Services/MetaData/classes/class.ilMD2XML.php");
825 $md2xml = new ilMD2XML(0, $this->getId(), $this->getType());
826 $md2xml->setExportMode(true);
827 $md2xml->startExport();
828 $xml.= $md2xml->getXML();
829
830 $media_items = $this->getMediaItems();
831 for ($i=0; $i<count($media_items); $i++) {
832 $item = $media_items[$i];
833
834 // highlight mode
835 $xml .= "<MediaItem Purpose=\"" . $item->getPurpose() . "\">";
836
837 // Location
838 $xml.= "<Location Type=\"" . $item->getLocationType() . "\">" .
839 $this->handleAmps($item->getLocation()) . "</Location>";
840
841 // Format
842 $xml.= "<Format>" . $item->getFormat() . "</Format>";
843
844 // Layout
845 $width = ($item->getWidth() != "")
846 ? "Width=\"" . $item->getWidth() . "\""
847 : "";
848 $height = ($item->getHeight() != "")
849 ? "Height=\"" . $item->getHeight() . "\""
850 : "";
851 $halign = ($item->getHAlign() != "")
852 ? "HorizontalAlign=\"" . $item->getHAlign() . "\""
853 : "";
854 $xml .= "<Layout $width $height $halign />";
855
856 // Caption
857 if ($item->getCaption() != "") {
858 $xml .= "<Caption Align=\"bottom\">" .
859 str_replace("&", "&amp;", $item->getCaption()) . "</Caption>";
860 }
861
862 // Text Representation
863 if ($item->getTextRepresentation() != "") {
864 $xml .= "<TextRepresentation>" .
865 str_replace("&", "&amp;", $item->getTextRepresentation()) . "</TextRepresentation>";
866 }
867
868 // Parameter
869 $parameters = $item->getParameters();
870 foreach ($parameters as $name => $value) {
871 $xml .= "<Parameter Name=\"$name\" Value=\"$value\"/>";
872 }
873 $xml .= $item->getMapAreasXML(true, $a_inst);
874 $xml .= "</MediaItem>";
875 }
876 break;
877 }
878 $xml .= "</MediaObject>";
879 return $xml;
880 }
const IL_MODE_ALIAS
escapeProperty($a_value)
Escape property (e.g.
handleAmps($a_str)
Replace "&" (if not an "&") with "&".
static secureUrl($url)
Prepare secure href attribute.
static signFile($path_to_file)
$def
Definition: croninfo.php:21

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

Referenced by exportMediaFullscreen(), and exportXML().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ handleAmps()

ilObjMediaObject::handleAmps (   $a_str)

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

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

898 {
899 $a_str = str_replace("&amp;", "&", $a_str);
900 $a_str = str_replace("&", "&amp;", $a_str);
901 return $a_str;
902 }

Referenced by getXML().

+ Here is the caller graph for this function:

◆ handleQuotaUpdate()

static ilObjMediaObject::handleQuotaUpdate ( ilObjMediaObject  $a_mob)
staticprotected

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

524 {
525 global $DIC;
526
527 $ilSetting = $DIC->settings();
528
529 // if neither workspace nor portfolios are activated, we skip
530 // the quota update here. this due to performance reasons on installations
531 // that do not use workspace/portfolios, but heavily copy content.
532 // in extreme cases (media object in pool and personal blog, deactivate workspace, change media object,
533 // this may lead to incorrect data in the quota calculation)
534 if ($ilSetting->get("disable_personal_workspace") && !$ilSetting->get('user_portfolios')) {
535 return;
536 }
537
538 $parent_obj_ids = array();
539 foreach ($a_mob->getUsages() as $item) {
540 $parent_obj_id = $a_mob->getParentObjectIdForUsage($item);
541 if ($parent_obj_id &&
542 !in_array($parent_obj_id, $parent_obj_ids)) {
543 $parent_obj_ids[]= $parent_obj_id;
544 }
545 }
546
547 // we could suppress this if object is present in a (repository) media pool
548 // but this would lead to "quota-breaches" when the pool item is deleted
549 // and "suddenly" all workspace owners get filesize added to their
550 // respective quotas, regardless of current status
551
552 include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
554 $a_mob->getType(),
555 $a_mob->getId(),
556 ilUtil::dirSize($a_mob->getDataDirectory()),
557 $parent_obj_ids
558 );
559 }
static handleUpdatedSourceObject($a_src_obj_type, $a_src_obj_id, $a_src_filesize, $a_owner_obj_ids=null, $a_is_prtf=false)
Find and update/create all related entries for source object.
static getParentObjectIdForUsage($a_usage, $a_include_all_access_obj_ids=false)
Get's the repository object ID of a parent object, if possible.
global $ilSetting
Definition: privfeed.php:17

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

Referenced by _deleteAllUsages(), _removeUsage(), _saveUsage(), create(), delete(), and update().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasFullscreenItem()

ilObjMediaObject::hasFullscreenItem ( )

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

360 {
361 return $this->hasPurposeItem("Fullscreen");
362 }
hasPurposeItem($purpose)
returns wether object has media item with specific purpose

References hasPurposeItem().

+ Here is the call graph for this function:

◆ hasPurposeItem()

ilObjMediaObject::hasPurposeItem (   $purpose)

returns wether object has media item with specific purpose

Parameters
string$purpose
Returns
boolean

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

371 {
372 if (is_object($this->getMediaItem($purpose))) {
373 return true;
374 } else {
375 return false;
376 }
377 }

References getMediaItem().

Referenced by hasFullscreenItem().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isAlias()

ilObjMediaObject::isAlias ( )

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

415 {
416 return $this->is_alias;
417 }

References $is_alias.

◆ isTypeAllowed()

static ilObjMediaObject::isTypeAllowed (   $a_type)
static

Is type allowed.

Parameters
string$a_type
Returns
bool

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

1866 {
1867 if (in_array($a_type, self::getForbiddenFileTypes())) {
1868 return false;
1869 }
1870 if (count(self::getAllowedFileTypes()) == 0 || in_array($a_type, self::getAllowedFileTypes())) {
1871 return true;
1872 }
1873 return false;
1874 }

References $a_type.

Referenced by ilPageObjectGUI\showPage().

+ Here is the caller graph for this function:

◆ lookupUsages()

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

Lookup usages of media object.

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

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

1149 {
1150 global $DIC;
1151
1152 $ilDB = $DIC->database();
1153
1154 $hist_str = "";
1155 if ($a_include_history) {
1156 $hist_str = ", usage_hist_nr";
1157 }
1158
1159 // get usages in pages
1160 $q = "SELECT DISTINCT usage_type, usage_id, usage_lang" . $hist_str . " FROM mob_usage WHERE id = " .
1161 $ilDB->quote($a_id, "integer");
1162
1163 if (!$a_include_history) {
1164 $q.= " AND usage_hist_nr = " . $ilDB->quote(0, "integer");
1165 }
1166
1167 $us_set = $ilDB->query($q);
1168 $ret = array();
1169 while ($us_rec = $ilDB->fetchAssoc($us_set)) {
1170 $ut = "";
1171 if (is_int(strpos($us_rec["usage_type"], ":"))) {
1172 $us_arr = explode(":", $us_rec["usage_type"]);
1173 $ut = $us_arr[1];
1174 $ct = $us_arr[0];
1175 }
1176
1177 // check whether page exists
1178 $skip = false;
1179 if ($ut == "pg") {
1180 include_once("./Services/COPage/classes/class.ilPageObject.php");
1181 if (!ilPageObject::_exists($ct, $us_rec["usage_id"])) {
1182 $skip = true;
1183 }
1184 }
1185
1186 if (!$skip) {
1187 $ret[] = array("type" => $us_rec["usage_type"],
1188 "id" => $us_rec["usage_id"],
1189 "lang" => $us_rec["usage_lang"],
1190 "hist_nr" => $us_rec["usage_hist_nr"]);
1191 }
1192 }
1193
1194 // get usages in media pools
1195 $q = "SELECT DISTINCT mep_id FROM mep_tree JOIN mep_item ON (child = obj_id) WHERE mep_item.foreign_id = " .
1196 $ilDB->quote($a_id, "integer") . " AND mep_item.type = " . $ilDB->quote("mob", "text");
1197 $us_set = $ilDB->query($q);
1198 while ($us_rec = $ilDB->fetchAssoc($us_set)) {
1199 $ret[] = array("type" => "mep",
1200 "id" => $us_rec["mep_id"]);
1201 }
1202
1203 // get usages in news items (media casts)
1204 include_once("./Services/News/classes/class.ilNewsItem.php");
1205 $news_usages = ilNewsItem::_lookupMediaObjectUsages($a_id);
1206 foreach ($news_usages as $nu) {
1207 $ret[] = $nu;
1208 }
1209
1210
1211 // get usages in map areas
1212 $q = "SELECT DISTINCT mob_id FROM media_item it, map_area area " .
1213 " WHERE area.item_id = it.id " .
1214 " AND area.link_type = " . $ilDB->quote("int", "text") . " " .
1215 " AND area.target = " . $ilDB->quote("il__mob_" . $a_id, "text");
1216 $us_set = $ilDB->query($q);
1217 while ($us_rec = $ilDB->fetchAssoc($us_set)) {
1218 $ret[] = array("type" => "map",
1219 "id" => $us_rec["mob_id"]);
1220 }
1221
1222 // get usages in personal clipboards
1224 foreach ($users as $user) {
1225 $ret[] = array("type" => "clip",
1226 "id" => $user);
1227 }
1228
1229 return $ret;
1230 }
$users
Definition: authpage.php:44
static _lookupMediaObjectUsages($a_mob_id)
Lookup media object usage(s)
static _getUsersForClipboadObject($a_type, $a_id)
get all users, that have a certain object within their clipboard
static _exists($a_parent_type, $a_id, $a_lang="", $a_no_cache=false)
Checks whether page exists.
$ret
Definition: parser.php:6

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ makeThumbnail()

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

Make thumbnail.

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

1740 {
1741 $m_dir = ilObjMediaObject::_getDirectory($this->getId());
1745 $m_dir . "/" . $a_file,
1746 $t_dir . "/" . $a_thumbname,
1747 $a_format,
1748 $a_size
1749 );
1750 }

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

+ Here is the call graph for this function:

◆ MDUpdateListener()

ilObjMediaObject::MDUpdateListener (   $a_element)

Meta data update listener.

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

Parameters
string$a_element

Reimplemented from ilObject.

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

194 {
195 include_once 'Services/MetaData/classes/class.ilMD.php';
196
197 switch ($a_element) {
198 case 'General':
199
200 // Update Title and description
201 $md = new ilMD(0, $this->getId(), $this->getType());
202 $md_gen = $md->getGeneral();
203
204 if (is_object($md_gen)) {
205 ilObject::_writeTitle($this->getId(), $md_gen->getTitle());
206 $this->setTitle($md_gen->getTitle());
207
208 foreach ($md_gen->getDescriptionIds() as $id) {
209 $md_des = $md_gen->getDescription($id);
210 ilObject::_writeDescription($this->getId(), $md_des->getDescription());
211 $this->setDescription($md_des->getDescription());
212 break;
213 }
214 }
215
216 break;
217
218 default:
219 }
220 return true;
221 }
setTitle($a_title)
set object title
setDescription($a_description)
set description of media object
static _writeTitle($a_obj_id, $a_title)
write title to db (static)
static _writeDescription($a_obj_id, $a_desc)
write description to db (static)

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

+ Here is the call graph for this function:

◆ modifyExportIdentifier()

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

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

989 {
990 if ($a_tag == "Identifier" && $a_param == "Entry") {
991 $a_value = ilUtil::insertInstIntoID($a_value);
992 }
993
994 return $a_value;
995 }
static insertInstIntoID($a_value)
inserts installation id into ILIAS id

References ilUtil\insertInstIntoID().

+ Here is the call graph for this function:

◆ putInTree()

ilObjMediaObject::putInTree (   $a_parent_ref)

maybe this method should be in tree object!?

Todo:
role/rbac stuff
Parameters
int$a_parent_refRef-ID of the parent object

Reimplemented from ilObject.

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

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

◆ read()

ilObjMediaObject::read ( )

read media object data from db

Reimplemented from ilObject.

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

385 {
386 //echo "<br>ilObjMediaObject:read";
387 parent::read();
388
389 // get media items
391 }
static _getMediaItemsOfMOb(&$a_mob)
read media items into media objects (static)

References ilMediaItem\_getMediaItemsOfMOb().

+ Here is the call graph for this function:

◆ removeAdditionalFile()

ilObjMediaObject::removeAdditionalFile (   $a_file)

Remove additional file.

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

1769 {
1770 $file = str_replace("..", "", $a_file);
1772 if (is_file($file)) {
1773 unlink($file);
1774 }
1775 }

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

Referenced by uploadVideoPreviewPic().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ removeAllMediaItems()

ilObjMediaObject::removeAllMediaItems ( )

remove all media items

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

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

◆ removeMediaItem()

ilObjMediaObject::removeMediaItem (   $a_purpose)

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

321 {
322 foreach ($this->media_items as $key => $media_item) {
323 if ($media_item->getPurpose() == $a_purpose) {
324 unset($this->media_items[$key]);
325 }
326 }
327 // update numbers and keys
328 $i = 1;
329 $media_items = array();
330 foreach ($this->media_items as $media_item) {
331 $media_items [$i] = $media_item;
332 $media_item->setMobId($this->getId());
333 $media_item->setNr($i);
334 $i++;
335 }
336 $this->media_items = $media_items;
337 }

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

+ Here is the call graph for this function:

◆ renameExecutables()

static ilObjMediaObject::renameExecutables (   $a_dir)
static

Rename executables.

Parameters
string

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

2078 {
2080 if (!self::isTypeAllowed("html")) {
2081 ilUtil::rRenameSuffix($a_dir, "html", "sec"); // see #20187
2082 }
2083 }
static rRenameSuffix($a_dir, $a_old_suffix, $a_new_suffix)
Renames all files with certain suffix and gives them a new suffix.
static renameExecutables($a_dir)
Rename uploaded executables for security reasons.

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setAlias()

ilObjMediaObject::setAlias (   $a_is_alias)

set wether page object is an alias

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

410 {
411 $this->is_alias = $a_is_alias;
412 }

◆ setContainsIntLink()

ilObjMediaObject::setContainsIntLink (   $a_contains_link)

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

Parameters
boolean$a_contains_linktrue, if page contains intern link tag(s)

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

1009 {
1010 $this->contains_int_link = $a_contains_link;
1011 }

◆ setDescription()

ilObjMediaObject::setDescription (   $a_description)

set description of media object

Reimplemented from ilObject.

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

178 {
179 parent::setDescription($a_description);
180 }

Referenced by MDUpdateListener().

+ Here is the caller graph for this function:

◆ setId()

ilObjMediaObject::setId (   $a_id)

set id

Reimplemented from ilObject.

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

397 {
398 $this->id = $a_id;
399 }

◆ setImportId()

ilObjMediaObject::setImportId (   $a_import_id)

set import id

@access public

Parameters
string$a_import_idimport id

Reimplemented from ilObject.

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

445 {
446 $this->import_id = $a_id;
447 }

◆ setOriginID()

ilObjMediaObject::setOriginID (   $a_id)

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

420 {
421 return $this->origin_id = $a_id;
422 }

◆ setRefId()

ilObjMediaObject::setRefId (   $a_id)

set reference id @access public

Parameters
integer$a_idreference id

Reimplemented from ilObject.

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

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

◆ setTitle()

ilObjMediaObject::setTitle (   $a_title)

set object title

@access public

Parameters
string$a_titleobject title

Reimplemented from ilObject.

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

83 {
84 parent::setTitle($a_title);
85 }

Referenced by MDUpdateListener().

+ Here is the caller graph for this function:

◆ update()

ilObjMediaObject::update (   $a_upload = false)

update media object in db

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

487 {
489
490 if (!$a_upload) {
491 $this->updateMetaData();
492 }
493
495
496 // iterate all items
497 $media_items = $this->getMediaItems();
498 $j = 1;
499 foreach ($media_items as $key => $val) {
500 $item = $media_items[$key];
501 if (is_object($item)) {
502 $item->setMobId($this->getId());
503 $item->setNr($j);
504 if ($item->getLocationType() == "Reference") {
505 $item->extractUrlParameters();
506 }
507 $item->create();
508 $j++;
509 }
510 }
511
513 $ilAppEventHandler = $this->app_event_handler;
514 $ilAppEventHandler->raise(
515 'Services/MediaObjects',
516 'update',
517 array('object' => $this,
518 'obj_type' => 'mob',
519 'obj_id' => $this->getId())
520 );
521 }
updateMetaData()
update meta data entry
update($pash, $contents, Config $config)

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

+ Here is the call graph for this function:

◆ updateMetaData()

ilObjMediaObject::updateMetaData ( )

update meta data entry

Reimplemented from ilObject.

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

248 {
249 include_once("Services/MetaData/classes/class.ilMD.php");
250 include_once("Services/MetaData/classes/class.ilMDGeneral.php");
251 include_once("Services/MetaData/classes/class.ilMDDescription.php");
252
253 $md = new ilMD(0, $this->getId(), $this->getType());
254 $md_gen = $md->getGeneral();
255 $md_gen->setTitle($this->getTitle());
256
257 // sets first description (maybe not appropriate)
258 $md_des_ids = $md_gen->getDescriptionIds();
259 if (count($md_des_ids) > 0) {
260 $md_des = $md_gen->getDescription($md_des_ids[0]);
261 $md_des->setDescription($this->getDescription());
262 $md_des->update();
263 }
264 $md_gen->update();
265 }

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

Referenced by update().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ uploadAdditionalFile()

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

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

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

1673 {
1674 $a_subdir = str_replace("..", "", $a_subdir);
1675 $dir = $mob_dir = ilObjMediaObject::_getDirectory($this->getId());
1676 if ($a_subdir != "") {
1677 $dir.= "/" . $a_subdir;
1678 }
1680 if ($a_mode == "rename") {
1681 rename($tmp_name, $dir . "/" . $a_name);
1682 } else {
1683 ilUtil::moveUploadedFile($tmp_name, $a_name, $dir . "/" . $a_name, true, $a_mode);
1684 }
1685 self::renameExecutables($mob_dir);
1686 include_once("./Services/MediaObjects/classes/class.ilMediaSvgSanitizer.php");
1687 ilMediaSvgSanitizer::sanitizeDir($mob_dir); // see #20339
1688 }
static makeDirParents($a_dir)
Create a new directory and all parent directories.

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

Referenced by uploadSrtFile(), and uploadVideoPreviewPic().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ uploadMultipleSubtitleFile()

ilObjMediaObject::uploadMultipleSubtitleFile (   $a_file)

Upload multi srt file.

Parameters
array$a_filefile info array
Exceptions
ilMediaObjectsException

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

2018 {
2019 $lng = $this->lng;
2021
2022 include_once("./Services/MediaObjects/exceptions/class.ilMediaObjectsException.php");
2023 if (!is_file($a_file["tmp_name"])) {
2024 throw new ilMediaObjectsException($lng->txt("mob_file_could_not_be_uploaded"));
2025 }
2026
2027 $dir = $this->getMultiSrtUploadDir();
2028 ilUtil::delDir($dir, true);
2030 ilUtil::moveUploadedFile($a_file["tmp_name"], "multi_srt.zip", $dir . "/" . "multi_srt.zip");
2031 ilUtil::unzip($dir . "/multi_srt.zip", true);
2032 }
General exception class for media objects.
static unzip($a_file, $overwrite=false, $a_flat=false)
unzip file

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

+ Here is the call graph for this function:

◆ uploadSrtFile()

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

Upload srt file.

Parameters

return

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

1697 {
1698 if (is_file($a_tmp_name) && $a_language != "") {
1699 $this->uploadAdditionalFile("subtitle_" . $a_language . ".srt", $a_tmp_name, "srt", $a_mode);
1700 return true;
1701 }
1702 return false;
1703 }
uploadAdditionalFile($a_name, $tmp_name, $a_subdir="", $a_mode="move_uploaded")
Create new media object and update page in db and return new media object.

References uploadAdditionalFile().

+ Here is the call graph for this function:

◆ uploadVideoPreviewPic()

ilObjMediaObject::uploadVideoPreviewPic (   $a_prevpic)

Upload video preview picture.

Parameters

return

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

1920 {
1921 // remove old one
1922 if ($this->getVideoPreviewPic(true) != "") {
1923 $this->removeAdditionalFile($this->getVideoPreviewPic(true));
1924 }
1925
1926 $pi = pathinfo($a_prevpic["name"]);
1927 $ext = $pi["extension"];
1928 if (in_array($ext, array("jpg", "jpeg", "png"))) {
1929 $this->uploadAdditionalFile("mob_vpreview." . $ext, $a_prevpic["tmp_name"]);
1930 }
1931 }
getVideoPreviewPic($a_filename_only=false)
Get video preview pic.
removeAdditionalFile($a_file)
Remove additional file.

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

+ Here is the call graph for this function:

Field Documentation

◆ $app_event_handler

ilObjMediaObject::$app_event_handler
protected

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

Referenced by create(), and update().

◆ $contains_int_link

ilObjMediaObject::$contains_int_link

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

Referenced by containsIntLink().

◆ $id

ilObjMediaObject::$id

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

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

◆ $is_alias

ilObjMediaObject::$is_alias

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

Referenced by isAlias().

◆ $media_items

ilObjMediaObject::$media_items

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

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

◆ $origin_id

ilObjMediaObject::$origin_id

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

Referenced by getOriginID().

◆ $user

ilObjMediaObject::$user
protected

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