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. | |
| read () | |
| create () | |
| create new media pool | |
| & | getTree () |
| get media pool folder tree | |
| update () | |
| update object data | |
| ilClone ($a_parent_ref) | |
| copy all entries of your object. | |
| 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 | |
| getParentId ($obj_id="") | |
| insertInTree ($a_obj_id, $a_parent="") | |
| deleteChild ($obj_id) | |
Data Fields | |
| $tree | |
Detailed Description
Media pool object.
- Id:
- class.ilObjMediaPool.php 11646 2006-07-27 14:05:18Z akill
/
Definition at line 39 of file class.ilObjMediaPool.php.
Member Function Documentation
| ilObjMediaPool::create | ( | ) |
create new media pool
Reimplemented from ilObject.
Definition at line 68 of file class.ilObjMediaPool.php.
References ilObject::getId().
{
parent::create();
// create media pool tree
$this->tree =& new ilTree($this->getId());
$this->tree->setTreeTablePK("mep_id");
$this->tree->setTableNames('mep_tree','object_data');
$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 146 of file class.ilObjMediaPool.php.
{
// 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)
{
switch ($child["type"])
{
case "mob":
include_once("content/classes/Media/class.ilObjMediaObject.php");
$mob = new ilObjMediaObject($child["obj_id"]);
$mob->delete();
break;
case "fold":
include_once("classes/class.ilObjFolder.php");
$fold = new ilObjFolder($child["obj_id"], false);
$fold->delete();
break;
}
}
return true;
}
| ilObjMediaPool::deleteChild | ( | $ | obj_id | ) |
Definition at line 336 of file class.ilObjMediaPool.php.
References $obj_id, ilObject::$title, ilObject::$type, ilObject::_lookupTitle(), and ilObject::_lookupType().
{
$type = ilObject::_lookupType($obj_id);
$title = ilObject::_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)
{
if ($node["type"] == "mob")
{
$obj =& new ilObjMediaObject($node["child"]);
$obj->delete();
}
if ($node["type"] == "fold")
{
$obj =& new ilObjFolder($node["child"], false);
$obj->delete();
}
}
}
Here is the call graph for this function:
| ilObjMediaPool::getChilds | ( | $ | obj_id = "", |
|
| $ | a_type = "" | |||
| ) |
get childs of node
Definition at line 280 of file class.ilObjMediaPool.php.
References $key, $mobs, and $obj_id.
{
$objs = array();
$mobs = array();
if ($obj_id == "")
{
$obj_id = $this->tree->getRootId();
}
if ($a_type != "mob")
{
$objs = $this->tree->getChildsByType($obj_id, "fold");
}
if ($a_type != "fold")
{
$mobs = $this->tree->getChildsByType($obj_id, "mob");
}
foreach($mobs as $key => $mob)
{
$objs[] = $mob;
}
return $objs;
}
| ilObjMediaPool::getParentId | ( | $ | obj_id = "" |
) |
| & ilObjMediaPool::getTree | ( | ) |
get media pool folder tree
Definition at line 83 of file class.ilObjMediaPool.php.
{
return $this->tree;
}
| ilObjMediaPool::ilClone | ( | $ | a_parent_ref | ) |
copy all entries of your object.
public
- Parameters:
-
integer ref_id of parent object
- Returns:
- integer new ref id
Reimplemented from ilObject.
Definition at line 113 of file class.ilObjMediaPool.php.
References $rbacadmin.
{
global $rbacadmin;
// always call parent ilClone function first!!
$new_ref_id = parent::ilClone($a_parent_ref);
// get object instance of ilCloned object
//$newObj =& $this->ilias->obj_factory->getInstanceByRefId($new_ref_id);
// create a local role folder & default roles
//$roles = $newObj->initDefaultRoles();
// ...finally assign role to creator of object
//$rbacadmin->assignUser($roles[0], $newObj->getOwner(), "n");
// always destroy objects in ilClone method because ilClone() is recursive and creates instances for each object in subtree!
//unset($newObj);
// ... and finally always return new reference ID!!
return $new_ref_id;
}
| 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 49 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 193 of file class.ilObjMediaPool.php.
References $rbacadmin.
{
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 = "" | |||
| ) |
Definition at line 319 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;
}
}
| 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 223 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 | ( | ) |
Definition at line 56 of file class.ilObjMediaPool.php.
References ilObject::getId().
{
parent::read();
$this->tree =& new ilTree($this->getId());
$this->tree->setTreeTablePK("mep_id");
$this->tree->setTableNames('mep_tree','object_data');
}
Here is the call graph for this function:
| ilObjMediaPool::update | ( | ) |
update object data
public
- Returns:
- boolean
Reimplemented from ilObject.
Definition at line 94 of file class.ilObjMediaPool.php.
{
if (!parent::update())
{
return false;
}
// put here object specific stuff
return true;
}
Field Documentation
| ilObjMediaPool::$tree |
Definition at line 41 of file class.ilObjMediaPool.php.
Referenced by notify().
The documentation for this class was generated from the following file:
- content/classes/class.ilObjMediaPool.php
