| ILIAS
    Release_4_3_x_branch Revision 61807
    | 
Media pool object. More...
 Inheritance diagram for ilObjMediaPool:
 Inheritance diagram for ilObjMediaPool: Collaboration 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 | |
| createMepTree () | |
| Create media pool tree. | |
| & | 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="", $a_keyword_filter= '', $a_caption_filter) | |
| Get media objects. | |
| getAllMobIds ($a_id) | |
| Get all media object ids. | |
| 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. | |
| createFolder ($a_title, $a_parent=0) | |
| Create a new folder. | |
| cloneObject ($a_target_id, $a_copy_id=0) | |
| Clone media pool. | |
| copyTreeContent ($a_new_obj, $a_target_parent, $a_source_parent) | |
| Copy tree content. | |
|  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 | |
| 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) | |
| _lookupOwner ($a_id) | |
| lookup object owner | |
| _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 | |
| _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 | |
| applyDidacticTemplate ($a_tpl_id) | |
| Apply template. | |
| 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 ... | |
| 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. | |
| _lookupCreationDate ($a_id) | |
| Lookup creation date. | |
| 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 | _lookupObjIdByImportId ($a_import_id) | 
| static | _getAllReferences ($a_id) | 
| get all reference ids of object | |
| static | _lookupTitle ($a_id) | 
| lookup object title | |
| static | _getIdsForTitle ($title, $type= '', $partialmatch=false) | 
| static | _lookupDescription ($a_id) | 
| lookup object description | |
| static | _lookupObjId ($a_id) | 
| static | _lookupType ($a_id, $a_reference=false) | 
| lookup object type | |
| static | _lookupObjectId ($a_ref_id) | 
| lookup object id | |
| _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, $show_path=true) | 
| Prepare copy wizard object selection. | |
| static | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) | 
| Get icon for repository item. | |
| static | collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0) | 
| Collect deletion dependencies. | |
| static | getDeletionDependencies ($a_obj_id) | 
| Get deletion dependencies. | |
| static | getLongDescriptions (array $a_obj_ids) | 
| Get long description data. | |
| static | getAllOwnedRepositoryObjects ($a_user_id) | 
| Get all ids of objects user owns. | |
| Data Fields | |
| $tree | |
|  Data Fields inherited from ilObject | |
| const | TITLE_LENGTH = 128 | 
| max length of object title | |
| $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 | |
Media pool object.
Definition at line 21 of file class.ilObjMediaPool.php.
| ilObjMediaPool::cloneObject | ( | $a_target_id, | |
| $a_copy_id = 0 | |||
| ) | 
Clone media pool.
| 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().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjMediaPool::copyTreeContent | ( | $a_new_obj, | |
| $a_target_parent, | |||
| $a_source_parent | |||
| ) | 
Copy tree content.
| @return | 
Definition at line 690 of file class.ilObjMediaPool.php.
References getTree(), and ilMediaPoolItem\lookupForeignId().
Referenced by cloneObject().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjMediaPool::create | ( | ) | 
create new media pool
Reimplemented from ilObject.
Definition at line 118 of file class.ilObjMediaPool.php.
References createMepTree().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjMediaPool::createFolder | ( | $a_title, | |
| $a_parent = 0 | |||
| ) | 
Create a new folder.
| @return | 
Definition at line 640 of file class.ilObjMediaPool.php.
References $tree, getTree(), and insertInTree().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjMediaPool::createMepTree | ( | ) | 
Create media pool tree.
| @return | 
Definition at line 140 of file class.ilObjMediaPool.php.
References ilObject\getId().
Referenced by create().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller 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
Reimplemented from ilObject.
Definition at line 194 of file class.ilObjMediaPool.php.
References ilObject\_lookupType(), and ilMediaPoolItem\lookupForeignId().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjMediaPool::deleteChild | ( | $obj_id | ) | 
Delete a child of media tree.
| 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().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjMediaPool::getAllMobIds | ( | $a_id | ) | 
Get all media object ids.
Definition at line 453 of file class.ilObjMediaPool.php.
References $query.
Referenced by ilMediaPoolExporter\getXmlExportHeadDependencies().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjMediaPool::getChilds | ( | $obj_id = "", | |
| $a_type = "" | |||
| ) | 
get childs of node
Definition at line 333 of file class.ilObjMediaPool.php.
References $mobs.
| ilObjMediaPool::getChildsExceptFolders | ( | $obj_id = "" | ) | 
get childs of node
Definition at line 370 of file class.ilObjMediaPool.php.
References $mobs.
| ilObjMediaPool::getDefaultHeight | ( | ) | 
Get default height.
Definition at line 73 of file class.ilObjMediaPool.php.
Referenced by cloneObject().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjMediaPool::getDefaultWidth | ( | ) | 
Get default width.
Definition at line 53 of file class.ilObjMediaPool.php.
Referenced by cloneObject().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 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().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjMediaPool::getParentId | ( | $obj_id = "" | ) | 
Definition at line 503 of file class.ilObjMediaPool.php.
| 
 | static | 
Get Pool Tree.
| int | Media pool ID | 
Definition at line 106 of file class.ilObjMediaPool.php.
References $tree.
Referenced by ilMediaPoolTableGUI\__construct(), and read().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| & ilObjMediaPool::getTree | ( | ) | 
get media pool folder tree
Definition at line 153 of file class.ilObjMediaPool.php.
References $tree.
Referenced by cloneObject(), copyTreeContent(), and createFolder().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjMediaPool::getUsedFormats | ( | ) | 
Get used formats.
Definition at line 475 of file class.ilObjMediaPool.php.
References ilObject\$lng, $query, and ilObject\getId().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjMediaPool::ilObjMediaPool | ( | $a_id = 0, | |
| $a_call_by_reference = true | |||
| ) | 
Constructor public.
| 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().
 Here is the call graph for this function:
 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
Reimplemented from ilObject.
Definition at line 246 of file class.ilObjMediaPool.php.
| ilObjMediaPool::insertInTree | ( | $a_obj_id, | |
| $a_parent = "" | |||
| ) | 
Insert into tree.
| int | $a_obj_id | (mep_item obj_id) | 
| int | $a_parent | 
Definition at line 522 of file class.ilObjMediaPool.php.
Referenced by createFolder().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | static | 
Check whether foreign id is in tree.
| @return | 
Definition at line 602 of file class.ilObjMediaPool.php.
| 
 | static | 
Check wheter a mep item id is in the media pool.
Definition at line 620 of file class.ilObjMediaPool.php.
| 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
| string | event | 
| integer | reference id of object where the event occured | 
| array | passes optional parameters if required | 
Reimplemented from ilObject.
Definition at line 276 of file class.ilObjMediaPool.php.
References $_GET, $tree, and ilObject\getType().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjMediaPool::read | ( | ) | 
Read pool data.
Definition at line 81 of file class.ilObjMediaPool.php.
References ilObject\getId(), getPoolTree(), setDefaultHeight(), and setDefaultWidth().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjMediaPool::setDefaultHeight | ( | $a_val | ) | 
Set default height.
| int | default height | 
Definition at line 63 of file class.ilObjMediaPool.php.
Referenced by read().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjMediaPool::setDefaultWidth | ( | $a_val | ) | 
Set default width.
| int | default width | 
Definition at line 43 of file class.ilObjMediaPool.php.
Referenced by read().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjMediaPool::update | ( | ) | 
update object data
public
Reimplemented from ilObject.
Definition at line 164 of file class.ilObjMediaPool.php.
| ilObjMediaPool::$tree | 
Definition at line 23 of file class.ilObjMediaPool.php.
Referenced by createFolder(), getPoolTree(), getTree(), and notify().