ilObjMediaPool Class Reference

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.
	setDefaultWidth ($a_val)
	Set default width.
	getDefaultWidth ()
	Get default width.
	setDefaultHeight ($a_val)
	Set default height.
	getDefaultHeight ()
	Get default height.
	read ()
	Read pool data.
	create ()
	create new media pool
&	getTree ()
	get media pool folder tree
	update ()
	update object data
	delete ()
	delete object and all related data
	initDefaultRoles ()
	init default roles settings
	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.
	getChilds ($obj_id="", $a_type="")
	get childs of node
	getChildsExceptFolders ($obj_id="")
	get childs of node
	getMediaObjects ($a_title_filter="", $a_format_filter="")
	Get media objects.
	getUsedFormats ()
	Get used formats.
	getParentId ($obj_id="")
	insertInTree ($a_obj_id, $a_parent="")
	Insert into tree.
	deleteChild ($obj_id)
	Delete a child of media tree.
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	_lookupObjIdByImportId ($a_import_id)
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_getAllReferences ($a_id)
	get all reference ids of object
	_lookupOwner ($a_id)
	lookup object owner
	_lookupDescription ($a_id)
	lookup object description
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_lookupObjectId ($a_ref_id)
	lookup object id
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	createRoleFolder ()
	creates a local role folder
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone object permissions, put in tree ...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.

Static Public Member Functions
static	getPoolTree ($a_obj_id)
	Get Pool Tree.
static	isForeignIdInTree ($a_pool_id, $a_foreign_id)
	Check whether foreign id is in tree.
static	isItemIdInTree ($a_pool_id, $a_item_id)
	Check wheter a mep item id is in the media pool.
Static Public Member Functions inherited from ilObject
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.

Data Fields
	$tree
Data Fields inherited from ilObject
	$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

Detailed Description

Media pool object.

Author

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

Id:

class.ilObjMediaPool.php 22212 2009-10-26 10:35:13Z akill

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

Member Function Documentation

ilObjMediaPool::create

(

)

create new media pool

Reimplemented from ilObject.

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

References $ilDB, and ilObject\getId().

        {
                global $ilDB;
                
                parent::create();

                $ilDB->manipulate("INSERT INTO mep_data ".
                        "(id) VALUES (".
                        $ilDB->quote($this->getId(), "integer").
                        ")");
                        
                // 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:

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

Reimplemented from ilObject.

Definition at line 181 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:

ilObjMediaPool::deleteChild

(

$obj_id

)

Delete a child of media tree.

Parameters

int	mep_item id

Definition at line 488 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:

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

get childs of node

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

References $key, and $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;
        }

ilObjMediaPool::getChildsExceptFolders

(

$obj_id = ""

)

get childs of node

Definition at line 357 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;
        }

ilObjMediaPool::getDefaultHeight

(

)

Get default height.

Returns

int default height

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

        {
                return $this->default_height;
        }

ilObjMediaPool::getDefaultWidth

(

)

Get default width.

Returns

int default width

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

        {
                return $this->default_width;
        }

ilObjMediaPool::getMediaObjects	(		$a_title_filter = "",
			$a_format_filter = ""
	)

Get media objects.

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

References $filter, $ilDB, $query, 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 != "")
                {
                        $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);
                }
                        
                $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;
                }
                return $objs;
        }

Here is the call graph for this function:

ilObjMediaPool::getParentId

(

$obj_id = ""

)

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

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

                return $this->tree->getParentId($obj_id);
        }

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:

& ilObjMediaPool::getTree

(

)

get media pool folder tree

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

References $tree.

        {
                return $this->tree;
        }

ilObjMediaPool::getUsedFormats

(

)

Get used formats.

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

References $ilDB, 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	(		$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:

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.

Reimplemented from ilObject.

Definition at line 233 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();
        }

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 467 of file class.ilObjMediaPool.php.

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

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

static

Check whether foreign id is in tree.

Parameters

@return

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

References $ilDB.

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

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

static

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

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

References $ilDB.

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

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

Reimplemented from ilObject.

Definition at line 263 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:

ilObjMediaPool::read

(

)

Read pool data.

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

References $ilDB, 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:

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:

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:

ilObjMediaPool::update

(

)

update object data

public

Returns

boolean

Reimplemented from ilObject.

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

References $ilDB.

        {
                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

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