Media pool object. More...

Inheritance diagram for ilObjMediaPool:

Collaboration diagram for ilObjMediaPool:

Public Member Functions
	ilObjMediaPool ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...

	setDefaultWidth ($a_val)
	Set default width. More...

	getDefaultWidth ()
	Get default width. More...

	setDefaultHeight ($a_val)
	Set default height. More...

	getDefaultHeight ()
	Get default height. More...

	read ()
	Read pool data. More...

	create ()
	create new media pool More...

	createMepTree ()
	Create media pool tree. More...

&	getTree ()
	get media pool folder tree More...

	update ()
	update object data More...

	delete ()
	delete object and all related data More...

	initDefaultRoles ()
	init default roles settings More...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event happend, each object may decide how it reacts. More...

	getChilds ($obj_id="", $a_type="")
	get childs of node More...

	getChildsExceptFolders ($obj_id="")
	get childs of node More...

	getMediaObjects ($a_title_filter="", $a_format_filter="", $a_keyword_filter='', $a_caption_filter)
	Get media objects. More...

	getAllMobIds ($a_id)
	Get all media object ids. More...

	getUsedFormats ()
	Get used formats. More...

	getParentId ($obj_id="")

	insertInTree ($a_obj_id, $a_parent="")
	Insert into tree. More...

	deleteChild ($obj_id)
	Delete a child of media tree. More...

	createFolder ($a_title, $a_parent=0)
	Create a new folder. More...

	cloneObject ($a_target_id, $a_copy_id=0)
	Clone media pool. More...

	copyTreeContent ($a_new_obj, $a_target_parent, $a_source_parent)
	Copy tree content. More...

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

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

	read ($a_force_db=false)
	read object data from db into object More...

	getId ()
	get object id public More...

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

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

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

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

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

	getTitle ()
	get object title public More...

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

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

	getDescription ()
	get object description More...

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

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

	getImportId ()
	get import id More...

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

	getOwner ()
	get object owner More...

	getOwnerName ()

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

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

	getCreateDate ()
	get create date public More...

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

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

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

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

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...

	createRoleFolder ()
	creates a local role folder More...

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

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

	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...

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

Static Public Member Functions
static	getPoolTree ($a_obj_id)
	Get Pool Tree. More...

static	isForeignIdInTree ($a_pool_id, $a_foreign_id)
	Check whether foreign id is in tree. More...

static	isItemIdInTree ($a_pool_id, $a_item_id)
	Check wheter a mep item id is in the media pool. More...

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

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

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

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

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

static	_lookupObjId ($a_id)

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

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

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

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

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

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

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

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

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

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

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

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

Data Fields
	$tree

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

const	DESC_LENGTH = 128

	$ilias

	$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

	$obj_data_record
	object_data record More...

Detailed Description

Media pool object.

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

$Id$

Definition at line 21 of file class.ilObjMediaPool.php.

Member Function Documentation

◆ cloneObject()

ilObjMediaPool::cloneObject	(	$a_target_id,
		$a_copy_id = `0`
	)

Clone media pool.

Parameters

int	target ref_id
int	copy id

Definition at line 665 of file class.ilObjMediaPool.php.

References ilObject\$ilias, $ilUser, copyTreeContent(), getDefaultHeight(), getDefaultWidth(), ilObject\getDescription(), ilObject\getTitle(), and getTree().

         {
                 global $ilDB, $ilUser, $ilias;
 
                 $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
                 
                 $new_obj->setTitle($this->getTitle());
                 $new_obj->setDescription($this->getDescription());
                 $new_obj->setDefaultWidth($this->getDefaultWidth());
                 $new_obj->setDefaultHeight($this->getDefaultHeight());
                 $new_obj->update();
 
                 // copy content
                 $this->copyTreeContent($new_obj, $new_obj->getTree()->readRootId(),
                         $this->getTree()->readRootId());
 
                 return $new_obj;
         }

Here is the call graph for this function:

◆ copyTreeContent()

ilObjMediaPool::copyTreeContent	(	$a_new_obj,
		$a_target_parent,
		$a_source_parent
	)

Copy tree content.

Parameters

Definition at line 690 of file class.ilObjMediaPool.php.

References getTree(), and ilMediaPoolItem\lookupForeignId().

Referenced by cloneObject().

         {
                 include_once("./Modules/MediaPool/classes/class.ilMediaPoolItem.php");
                 include_once("./Modules/MediaPool/classes/class.ilMediaPoolPage.php");
                 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                 
                 // get all chapters of root lm
                 $nodes = $this->getTree()->getChilds($a_source_parent);
                 foreach ($nodes as $node)
                 {
                         $item = new ilMediaPoolItem();
                         $item->setType($node["type"]);
                         switch ($node["type"])
                         {
                                 case "mob":
                                         $mob_id = ilMediaPoolItem::lookupForeignId($node["child"]);
                                         $mob = new ilObjMediaObject($mob_id);
                                         $new_mob = $mob->duplicate();
                                         $item->setForeignId($new_mob->getId());
                                         $item->setTitle($new_mob->getTitle());
                                         $item->create();
                                         break;
                                 
                                 case "pg":
                                         $item->setTitle($node["title"]);
                                         $item->create();
                                         $page = new ilMediaPoolPage($node["child"]);
                                         $new_page = new ilMediaPoolPage();
                                         $new_page->setId($item->getId());
                                         $new_page->create();
                                         
                                         // copy page
                                         $page->copy($new_page->getId(), $new_page->getParentType(), $new_page->getParentId(), true);
                                         //$new_page->setXMLContent($page->copyXMLContent(true));
                                         //$new_page->buildDom();
                                         //$new_page->update();
                                         break;
                                         
                                 case "fold":
                                         $item->setTitle($node["title"]);
                                         $item->create();
                                         break;
                         }
 
                         // insert item into tree
                         $a_new_obj->insertInTree($item->getId(), $a_target_parent);
                         
                         // handle childs
                         $this->copyTreeContent($a_new_obj, $item->getId(), $node["child"]);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilObjMediaPool::create ( )

create new media pool

Definition at line 118 of file class.ilObjMediaPool.php.

References createMepTree().

         {
                 global $ilDB;
                 
                 parent::create();
 
                 $ilDB->manipulate("INSERT INTO mep_data ".
                         "(id, default_width, default_height) VALUES (".
                         $ilDB->quote($this->getId(), "integer").", ".
                         $ilDB->quote($this->getDefaultWidth(), "integer").", ".
                         $ilDB->quote($this->getDefaultHeight(), "integer").
                         ")");
 
                 $this->createMepTree();
         }

Here is the call graph for this function:

◆ createFolder()

ilObjMediaPool::createFolder	(	$a_title,
		$a_parent = `0`
	)

Create a new folder.

Parameters

Definition at line 640 of file class.ilObjMediaPool.php.

References getTree(), and insertInTree().

         {
                 // perform save
                 $mep_item = new ilMediaPoolItem();
                 $mep_item->setTitle($a_title);
                 $mep_item->setType("fold");
                 $mep_item->create();
                 if ($mep_item->getId() > 0)
                 {
                         $tree = $this->getTree();
                         $parent = $a_parent > 0
                                 ? $a_parent
                                 : $tree->getRootId();
                         $this->insertInTree($mep_item->getId(), $parent);
                         return $mep_item->getId();
                 }
                 return false;
         }

Here is the call graph for this function:

◆ createMepTree()

ilObjMediaPool::createMepTree ( )

Create media pool tree.

Parameters

Definition at line 140 of file class.ilObjMediaPool.php.

References ilObject\getId().

Referenced by create().

         {
                 // create media pool tree
                 $this->tree = new ilTree($this->getId());
                 $this->tree->setTreeTablePK("mep_id");
                 $this->tree->setTableNames('mep_tree','mep_item');
                 $this->tree->addTree($this->getId(), 1);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilObjMediaPool::delete ( )

delete object and all related data

this method has been tested on may 9th 2004 media pool tree, media objects and folders have been deleted correctly as desired

public

Returns: boolean true if all object data were removed; false if only a references were removed

Definition at line 194 of file class.ilObjMediaPool.php.

References ilObject\_lookupType(), and ilMediaPoolItem\lookupForeignId().

         {
                 // always call parent delete function first!!
                 if (!parent::delete())
                 {
                         return false;
                 }
 
                 // get childs
                 $childs = $this->tree->getSubTree($this->tree->getNodeData($this->tree->readRootId()));
 
                 // delete tree
                 $this->tree->removeTree($this->tree->getTreeId());
 
                 // delete childs
                 foreach ($childs as $child)
                 {
                         $fid = ilMediaPoolItem::lookupForeignId($child["obj_id"]);
                         switch ($child["type"])
                         {
                                 case "mob":
                                         if  (ilObject::_lookupType($fid) == "mob")
                                         {
                                                 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                                                 $mob = new ilObjMediaObject($fid);
                                                 $mob->delete();
                                         }
                                         break;
 
 /*                              case "fold":
                                         if  (ilObject::_lookupType($fid) == "fold")
                                         {
                                                 include_once("./Modules/Folder/classes/class.ilObjFolder.php");
                                                 $fold = new ilObjFolder($fid, false);
                                                 $fold->delete();
                                         }
                                         break;*/
                         }
                 }
                 
                 return true;
         }

Here is the call graph for this function:

◆ deleteChild()

ilObjMediaPool::deleteChild ( $obj_id )

Delete a child of media tree.

Parameters

int	mep_item id

Definition at line 543 of file class.ilObjMediaPool.php.

References ilObject\$title, ilObject\$type, ilMediaPoolPage\_exists(), ilObject\_lookupType(), ilMediaPoolItem\lookupForeignId(), ilMediaPoolItem\lookupTitle(), and ilMediaPoolItem\lookupType().

         {
                 $fid = ilMediaPoolItem::lookupForeignId($obj_id);
                 $type = ilMediaPoolItem::lookupType($obj_id);
                 $title = ilMediaPoolItem::lookupTitle($obj_id);
                 
                 $node_data = $this->tree->getNodeData($obj_id);
                 $subtree = $this->tree->getSubtree($node_data);
 
                 // delete tree
                 if($this->tree->isInTree($obj_id))
                 {
                         $this->tree->deleteTree($node_data);
                 }
 
                 // delete objects
                 foreach ($subtree as $node)
                 {
                         $fid = ilMediaPoolItem::lookupForeignId($node["child"]);
                         if ($node["type"] == "mob")
                         {
                                 if (ilObject::_lookupType($fid) == "mob")
                                 {
                                         $obj =& new ilObjMediaObject($fid);
                                         $obj->delete();
                                 }
                         }
 
                         if ($node["type"] == "fold")
                         {
                                 if ($fid > 0 && ilObject::_lookupType($fid) == "fold")
                                 {
                                         $obj = new ilObjFolder($fid, false);
                                         $obj->delete();
                                 }
                         }
 
                         if ($node["type"] == "pg")
                         {
                                 include_once("./Modules/MediaPool/classes/class.ilMediaPoolPage.php");
                                 if (ilMediaPoolPage::_exists($node["child"]))
                                 {
                                         $pg = new ilMediaPoolPage($node["child"]);
                                         $pg->delete();
                                 }
                         }
                         
                         include_once("./Modules/MediaPool/classes/class.ilMediaPoolItem.php");
                         $item = new ilMediaPoolItem($node["child"]);
                         $item->delete();
                 }
         }

Here is the call graph for this function:

◆ getAllMobIds()

ilObjMediaPool::getAllMobIds ( $a_id )

Get all media object ids.

Definition at line 453 of file class.ilObjMediaPool.php.

References $query.

Referenced by ilMediaPoolExporter\getXmlExportHeadDependencies().

         {
                 global $ilDB;
 
                 $query = "SELECT foreign_id as id FROM ".
                         " mep_tree JOIN mep_item ON (mep_tree.child = mep_item.obj_id) ".
                         " JOIN object_data ON (mep_item.foreign_id = object_data.obj_id) ".
                         " WHERE mep_tree.mep_id = ".$ilDB->quote($a_id, "integer").
                         " AND mep_item.type = ".$ilDB->quote("mob", "text").
                         " AND object_data.type = ".$ilDB->quote("mob", "text");
                 $set = $ilDB->query($query);
                 $ids = array();
                 while ($rec  = $ilDB->fetchAssoc($set))
                 {
                         $ids[] = $rec["id"];
                 }
                 return $ids;
         }

Here is the caller graph for this function:

◆ getChilds()

ilObjMediaPool::getChilds	(	$obj_id = `""`,
		$a_type = `""`
	)

get childs of node

Definition at line 333 of file class.ilObjMediaPool.php.

References $mobs.

         {
                 $objs = array();
                 $mobs = array();
                 $pgs = array();
                 if ($obj_id == "")
                 {
                         $obj_id = $this->tree->getRootId();
                 }
 
                 if ($a_type == "fold" || $a_type == "")
                 {
                         $objs = $this->tree->getChildsByType($obj_id, "fold");
                 }
                 if ($a_type == "mob" || $a_type == "")
                 {               
                         $mobs = $this->tree->getChildsByType($obj_id, "mob");
                 }
                 foreach($mobs as $key => $mob)
                 {
                         $objs[] = $mob;
                 }
                 if ($a_type == "pg" || $a_type == "")
                 {               
                         $pgs = $this->tree->getChildsByType($obj_id, "pg");
                 }
                 foreach($pgs as $key => $pg)
                 {
                         $objs[] = $pg;
                 }
 
                 return $objs;
         }

◆ getChildsExceptFolders()

ilObjMediaPool::getChildsExceptFolders ( $obj_id = "" )

get childs of node

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

References $mobs.

         {
                 $objs = array();
                 $mobs = array();
                 if ($obj_id == "")
                 {
                         $obj_id = $this->tree->getRootId();
                 }
 
                 $objs = $this->tree->getFilteredChilds(array("fold", "dummy"), $obj_id);
                 return $objs;
         }

◆ getDefaultHeight()

ilObjMediaPool::getDefaultHeight ( )

Get default height.

Returns: int default height

Definition at line 73 of file class.ilObjMediaPool.php.

Referenced by cloneObject().

         {
                 return $this->default_height;
         }

Here is the caller graph for this function:

◆ getDefaultWidth()

ilObjMediaPool::getDefaultWidth ( )

Get default width.

Returns: int default width

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

Referenced by cloneObject().

         {
                 return $this->default_width;
         }

Here is the caller graph for this function:

◆ getMediaObjects()

ilObjMediaPool::getMediaObjects	(	$a_title_filter = `""`,
		$a_format_filter = `""`,
		$a_keyword_filter = `''`,
		$a_caption_filter
	)

Get media objects.

Definition at line 386 of file class.ilObjMediaPool.php.

References $query, $res, ilMDKeyword\_searchKeywords(), and ilObject\getId().

         {
                 global $ilDB;
 
                 $query = "SELECT DISTINCT mep_tree.*, object_data.* ".
                         "FROM mep_tree JOIN mep_item ON (mep_tree.child = mep_item.obj_id) ".
                         " JOIN object_data ON (mep_item.foreign_id = object_data.obj_id) ";
                         
                 if ($a_format_filter != "" or $a_caption_filter != '')
                 {
                         $query.= " JOIN media_item ON (media_item.mob_id = object_data.obj_id) ";
                 }
                         
                 $query .=
                         " WHERE mep_tree.mep_id = ".$ilDB->quote($this->getId(), "integer").
                         " AND object_data.type = ".$ilDB->quote("mob", "text");
                         
                 // filter
                 if (trim($a_title_filter) != "")        // title
                 {
                         $query.= " AND ".$ilDB->like("object_data.title", "text", "%".trim($a_title_filter)."%");
                 }
                 if ($a_format_filter != "")                     // format
                 {
                         $filter = ($a_format_filter == "unknown")
                                 ? ""
                                 : $a_format_filter;
                         $query.= " AND ".$ilDB->equals("media_item.format", $filter, "text", true);
                 }
                 if(trim($a_caption_filter))
                 {
                         $query .= 'AND '.$ilDB->like('media_item.caption', 'text', '%'.trim($a_caption_filter).'%');
                 }
                         
                 $query.=
                         " ORDER BY object_data.title";
                 
                 $objs = array();
                 $set = $ilDB->query($query);
                 while ($rec = $ilDB->fetchAssoc($set))
                 {
                         $rec["foreign_id"] = $rec["obj_id"];
                         $rec["obj_id"] = "";
                         $objs[] = $rec;
                 }
                 
                 // Keyword filter
                 if($a_keyword_filter)
                 {
                         include_once './Services/MetaData/classes/class.ilMDKeyword.php';
                         $res = ilMDKeyword::_searchKeywords($a_keyword_filter,'mob',0);
                         
                         foreach($objs as $obj)
                         {
                                 if(in_array($obj['foreign_id'],$res))
                                 {
                                         $filtered[] = $obj;
                                 }
                         }
                         return (array) $filtered;
                 }
                 return $objs;
         }

Here is the call graph for this function:

◆ getParentId()

ilObjMediaPool::getParentId ( $obj_id = "" )

Definition at line 503 of file class.ilObjMediaPool.php.

         {
                 if ($obj_id == "")
                 {
                         return false;
                 }
                 if ($obj_id == $this->tree->getRootId())
                 {
                         return false;
                 }
 
                 return $this->tree->getParentId($obj_id);
         }

◆ getPoolTree()

static ilObjMediaPool::getPoolTree ( $a_obj_id )

static

Get Pool Tree.

Parameters

int	Media pool ID

Returns: object Tree object of media pool

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

References $tree.

Referenced by ilMediaPoolTableGUI\__construct(), and read().

         {
                 $tree = new ilTree($a_obj_id);
                 $tree->setTreeTablePK("mep_id");
                 $tree->setTableNames("mep_tree", "mep_item");
                 
                 return $tree;
         }

Here is the caller graph for this function:

◆ getTree()

& ilObjMediaPool::getTree ( )

get media pool folder tree

Definition at line 153 of file class.ilObjMediaPool.php.

References $tree.

Referenced by cloneObject(), copyTreeContent(), and createFolder().

         {
                 return $this->tree;
         }

Here is the caller graph for this function:

◆ getUsedFormats()

ilObjMediaPool::getUsedFormats ( )

Get used formats.

Definition at line 475 of file class.ilObjMediaPool.php.

References ilObject\$lng, $query, and ilObject\getId().

         {
                 global $ilDB, $lng;
 
                 $query = "SELECT DISTINCT media_item.format f FROM mep_tree ".
                         " JOIN mep_item ON (mep_item.obj_id = mep_tree.child) ".
                         " JOIN object_data ON (mep_item.foreign_id = object_data.obj_id) ".
                         " JOIN media_item ON (media_item.mob_id = object_data.obj_id) ".
                         " WHERE mep_tree.mep_id = ".$ilDB->quote($this->getId(), "integer").
                         " AND object_data.type = ".$ilDB->quote("mob", "text").
                         " ORDER BY f";
                 $formats = array();
                 $set = $ilDB->query($query);
                 while ($rec = $ilDB->fetchAssoc($set))
                 {
                         if ($rec["f"] != "")
                         {
                                 $formats[$rec["f"]] = $rec["f"];
                         }
                         else
                         {
                                 $formats["unknown"] = $lng->txt("mep_unknown");
                         }
                 }
                 
                 return $formats;
         }

Here is the call graph for this function:

◆ ilObjMediaPool()

ilObjMediaPool::ilObjMediaPool	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

References ilObject\ilObject().

         {
                 // this also calls read() method! (if $a_id is set)
                 $this->type = "mep";
                 $this->ilObject($a_id,$a_call_by_reference);
         }

Here is the call graph for this function:

◆ initDefaultRoles()

ilObjMediaPool::initDefaultRoles ( )

init default roles settings

If your module does not require any default roles, delete this method (For an example how this method is used, look at ilObjForum)

public

Returns: array object IDs of created local roles.

Definition at line 246 of file class.ilObjMediaPool.php.

         {
                 global $rbacadmin;
 
                 // create a local role folder
                 //$rfoldObj = $this->createRoleFolder("Local roles","Role Folder of forum obj_no.".$this->getId());
 
                 // create moderator role and assign role to rolefolder...
                 //$roleObj = $rfoldObj->createRole("Moderator","Moderator of forum obj_no.".$this->getId());
                 //$roles[] = $roleObj->getId();
 
                 //unset($rfoldObj);
                 //unset($roleObj);
 
                 return $roles ? $roles : array();
         }

◆ insertInTree()

ilObjMediaPool::insertInTree	(	$a_obj_id,
		$a_parent = `""`
	)

Insert into tree.

Parameters

int	$a_obj_id	(mep_item obj_id)
int	$a_parent

Definition at line 522 of file class.ilObjMediaPool.php.

Referenced by createFolder().

         {
                 if (!$this->tree->isInTree($a_obj_id))
                 {
                         $parent = ($a_parent == "")
                                 ? $this->tree->getRootId()
                                 : $a_parent;
                         $this->tree->insertNode($a_obj_id, $parent);
                         return true;
                 }
                 else
                 {
                         return false;
                 }
         }

Here is the caller graph for this function:

◆ isForeignIdInTree()

static ilObjMediaPool::isForeignIdInTree	(	$a_pool_id,
		$a_foreign_id
	)

static

Check whether foreign id is in tree.

Parameters

Definition at line 602 of file class.ilObjMediaPool.php.

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT * FROM mep_tree JOIN mep_item ON (child = obj_id) WHERE ".
                         " foreign_id = ".$ilDB->quote($a_foreign_id, "integer").
                         " AND mep_id = ".$ilDB->quote($a_pool_id, "integer")
                         );
                 if ($rec  = $ilDB->fetchAssoc($set))
                 {
                         return true;
                 }
                 return false;
         }

◆ isItemIdInTree()

static ilObjMediaPool::isItemIdInTree	(	$a_pool_id,
		$a_item_id
	)

static

Check wheter a mep item id is in the media pool.

Definition at line 620 of file class.ilObjMediaPool.php.

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT * FROM mep_tree WHERE child = ".
                         $ilDB->quote($a_item_id, "integer").
                         " AND mep_id = ".$ilDB->quote($a_pool_id, "integer"));
                 if ($rec  = $ilDB->fetchAssoc($set))
                 {
                         return true;
                 }
                 return false;
         }

◆ notify()

ilObjMediaPool::notify	(	$a_event,
		$a_ref_id,
		$a_parent_non_rbac_id,
		$a_node_id,
		$a_params = `0`
	)

notifys an object about an event occured Based on the event happend, each object may decide how it reacts.

If you are not required to handle any events related to your module, just delete this method. (For an example how this method is used, look at ilObjGroup)

public

Parameters

string	event
integer	reference id of object where the event occured
array	passes optional parameters if required

Returns: boolean

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

References $_GET, $tree, and ilObject\getType().

         {
                 global $tree;
 
                 switch ($a_event)
                 {
                         case "link":
 
                                 //var_dump("<pre>",$a_params,"</pre>");
                                 //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
 
                         case "cut":
 
                                 //echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
 
                         case "copy":
 
                                 //var_dump("<pre>",$a_params,"</pre>");
                                 //echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
 
                         case "paste":
 
                                 //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
 
                         case "new":
 
                                 //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
                 }
 
                 // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
                 if ($a_node_id==$_GET["ref_id"])
                 {
                         $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
                         $parent_type = $parent_obj->getType();
                         if($parent_type == $this->getType())
                         {
                                 $a_node_id = (int) $tree->getParentId($a_node_id);
                         }
                 }
 
                 parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
         }

Here is the call graph for this function:

◆ read()

ilObjMediaPool::read ( )

Read pool data.

Definition at line 81 of file class.ilObjMediaPool.php.

References ilObject\getId(), getPoolTree(), setDefaultHeight(), and setDefaultWidth().

         {
                 global $ilDB;
                 
                 parent::read();
 
                 $set = $ilDB->query("SELECT * FROM mep_data ".
                         " WHERE id = ".$ilDB->quote($this->getId(), "integer")
                         );
                 if ($rec = $ilDB->fetchAssoc($set))
                 {
                         $this->setDefaultWidth($rec["default_width"]);
                         $this->setDefaultHeight($rec["default_height"]);
                 }
                 $this->tree = ilObjMediaPool::getPoolTree($this->getId());
         }

Here is the call graph for this function:

◆ setDefaultHeight()

ilObjMediaPool::setDefaultHeight ( $a_val )

Set default height.

Parameters

int	default height

Definition at line 63 of file class.ilObjMediaPool.php.

Referenced by read().

         {
                 $this->default_height = $a_val;
         }

Here is the caller graph for this function:

◆ setDefaultWidth()

ilObjMediaPool::setDefaultWidth ( $a_val )

Set default width.

Parameters

int	default width

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

Referenced by read().

         {
                 $this->default_width = $a_val;
         }

Here is the caller graph for this function:

◆ update()

ilObjMediaPool::update ( )

update object data

public

Returns: boolean

Definition at line 164 of file class.ilObjMediaPool.php.

         {
                 global $ilDB;
                 
                 if (!parent::update())
                 {
                         return false;
                 }
 
                 // put here object specific stuff
                 $ilDB->manipulate("UPDATE mep_data SET ".
                         " default_width = ".$ilDB->quote($this->getDefaultWidth(), "integer").",".
                         " default_height = ".$ilDB->quote($this->getDefaultHeight(), "integer").
                         " WHERE id = ".$ilDB->quote($this->getId(), "integer")
                         );
 
                 return true;
         }

Field Documentation

◆ $tree

ilObjMediaPool::$tree

Definition at line 23 of file class.ilObjMediaPool.php.

Referenced by getPoolTree(), getTree(), and notify().

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

Modules/MediaPool/classes/class.ilObjMediaPool.php

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ cloneObject()

◆ copyTreeContent()

◆ create()

◆ createFolder()

◆ createMepTree()

◆ delete()

◆ deleteChild()

◆ getAllMobIds()

◆ getChilds()

◆ getChildsExceptFolders()

◆ getDefaultHeight()

◆ getDefaultWidth()

◆ getMediaObjects()

◆ getParentId()

◆ getPoolTree()

◆ getTree()

◆ getUsedFormats()

◆ ilObjMediaPool()

◆ initDefaultRoles()

◆ insertInTree()

◆ isForeignIdInTree()

◆ isItemIdInTree()

◆ notify()

◆ read()

◆ setDefaultHeight()

◆ setDefaultWidth()

◆ update()

Field Documentation

◆ $tree