ilObjRepositorySettings Class Reference

Class ilObjRepositorySettings. More...

Inheritance diagram for ilObjRepositorySettings:

Collaboration diagram for ilObjRepositorySettings:

Public Member Functions
	__construct ($a_id, $a_call_by_reference=true)
	Constructor public.
	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!!
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)
	create ()
	create
	update ()
	update object in db
	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
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates.
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	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
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	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.
	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	addNewItemGroupSeparator ()
static	addNewItemGroup (array $a_titles)
static	updateNewItemGroup ($a_id, array $a_titles)
static	deleteNewItemGroup ($a_id)
static	getNewItemGroups ()
static	updateNewItemGroupOrder (array $a_order)
static	getNewItemGroupSubItems ()
static	getDefaultNewItemGrouping ()
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	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB.
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
static	_lookupObjectId ($a_ref_id)
	lookup object id
static	_exists ($a_id, $a_reference=false, $a_type=null)
	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.
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course.

Data Fields
const	NEW_ITEM_GROUP_TYPE_GROUP = 1
const	NEW_ITEM_GROUP_TYPE_SEPARATOR = 2
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title
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

Static Protected Member Functions
static	getAllObjTypes ()

Detailed Description

Class ilObjRepositorySettings.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id:

class.ilObjSystemFolder.php 33501 2012-03-03 11:11:05Z akill

Definition at line 14 of file class.ilObjRepositorySettings.php.

Constructor & Destructor Documentation

ilObjRepositorySettings::__construct	(		$a_id,
			$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 25 of file class.ilObjRepositorySettings.php.

        {
                $this->type = "reps";
                parent::__construct($a_id,$a_call_by_reference);
        }

Member Function Documentation

static ilObjRepositorySettings::addNewItemGroup ( array  $a_titles )

static

Definition at line 58 of file class.ilObjRepositorySettings.php.

References $ilDB.

Referenced by ilObjRepositorySettingsGUI\saveNewItemGroup().

        {
                global $ilDB;
                
                // append
                $pos = $ilDB->query("SELECT max(pos) mpos FROM il_new_item_grp");
                $pos = $ilDB->fetchAssoc($pos);
                $pos = (int)$pos["mpos"];
                $pos += 10;             
                
                $seq = $ilDB->nextID("il_new_item_grp");
                
                $ilDB->manipulate("INSERT INTO il_new_item_grp".
                        " (id, titles, pos, type) VALUES (".
                        $ilDB->quote($seq, "integer").
                        ", ".$ilDB->quote(serialize($a_titles), "text").
                        ", ".$ilDB->quote($pos, "integer").
                        ", ".$ilDB->quote(self::NEW_ITEM_GROUP_TYPE_GROUP, "integer").
                        ")");                   
                return true;
        }

Here is the caller graph for this function:

static ilObjRepositorySettings::addNewItemGroupSeparator ( )

static

Definition at line 37 of file class.ilObjRepositorySettings.php.

References $ilDB.

Referenced by ilObjRepositorySettingsGUI\addNewItemGroupSeparator().

        {
                global $ilDB;
                
                // append
                $pos = $ilDB->query("SELECT max(pos) mpos FROM il_new_item_grp");
                $pos = $ilDB->fetchAssoc($pos);
                $pos = (int)$pos["mpos"];
                $pos += 10;             
                
                $seq = $ilDB->nextID("il_new_item_grp");
                
                $ilDB->manipulate("INSERT INTO il_new_item_grp".
                        " (id, pos, type) VALUES (".
                        $ilDB->quote($seq, "integer").
                        ", ".$ilDB->quote($pos, "integer").
                        ", ".$ilDB->quote(self::NEW_ITEM_GROUP_TYPE_SEPARATOR, "integer").
                        ")");                   
                return true;
        }

Here is the caller graph for this function:

ilObjRepositorySettings::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!!

public

Returns

boolean true if object was removed completely; false if only a references was removed

Reimplemented from ilObject.

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

        {
                // DISABLED
                return false;
        }

static ilObjRepositorySettings::deleteNewItemGroup (   $a_id )

static

Definition at line 90 of file class.ilObjRepositorySettings.php.

References $ilDB, $ilSetting, and getNewItemGroupSubItems().

        {
                global $ilDB, $ilSetting;
                
                // move subitems to unassigned
                $sub_items = self::getNewItemGroupSubItems();
                $sub_items = $sub_items[$a_id];
                if($sub_items)
                {
                        foreach($sub_items as $obj_type)
                        {
                                $old_pos = $ilSetting->get("obj_add_new_pos_".$obj_type);
                                if(strlen($old_pos) == 8)
                                {
                                        $new_pos = "9999".substr($old_pos, 4);
                                        $ilSetting->set("obj_add_new_pos_".$obj_type, $new_pos);
                                        $ilSetting->set("obj_add_new_pos_grp_".$obj_type, 0);
                                }
                        }
                }
                
                $ilDB->manipulate("DELETE FROM il_new_item_grp".
                        " WHERE id = ".$ilDB->quote($a_id, "integer"));                         
                return true;
        }

Here is the call graph for this function:

static ilObjRepositorySettings::getAllObjTypes ( )

staticprotected

Definition at line 170 of file class.ilObjRepositorySettings.php.

References $res, ilModule\getAvailableCoreModules(), IL_COMP_MODULE, IL_COMP_SERVICE, and ilPlugin\lookupIdForName().

        {
                global $ilPluginAdmin, $objDefinition;
                
                $res = array();
                
                // parse modules
                include_once("./Services/Component/classes/class.ilModule.php");
                foreach(ilModule::getAvailableCoreModules() as $mod)
                {                                       
                        $has_repo = false;              
                        $rep_types = $objDefinition->getRepositoryObjectTypesForComponent(IL_COMP_MODULE, $mod["subdir"]);
                        if(sizeof($rep_types) > 0)
                        {
                                foreach($rep_types as $ridx => $rt)
                                {
                                        // we only want to display repository modules
                                        if($rt["repository"])
                                        {
                                                $has_repo = true;                                                       
                                        }
                                        else
                                        {
                                                unset($rep_types[$ridx]);
                                        }
                                }                                                                               
                        }                               
                        if($has_repo)
                        {               
                                foreach($rep_types as $rt)
                                {                                                                                                               
                                        $res[] = $rt["id"];
                                }                               
                        }
                }
                
                // parse plugins
                include_once("./Services/Component/classes/class.ilPlugin.php");
                $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Repository", "robj");
                foreach ($pl_names as $pl_name)
                {                                                               
                        $pl_id = ilPlugin::lookupIdForName(IL_COMP_SERVICE, "Repository", "robj", $pl_name);
                        if($pl_id)
                        {
                                $res[] = $pl_id;
                        }
                }
                
                return $res;
        }

Here is the call graph for this function:

static ilObjRepositorySettings::getDefaultNewItemGrouping ( )

static

Definition at line 236 of file class.ilObjRepositorySettings.php.

References ilObject\$lng, $res, and ilObject\$title.

Referenced by ilObjectAddNewItemGUI\parseRepository().

        {
                global $lng;
                
                $res = array();
                                                                
                $groups = array(
                        "organisation" => array("fold", "sess", "cat", "catr", "crs", "crsr", "grp", "itgr", "book"), 
                        "communication" => array("frm", "chtr"), 
                        "breaker1" => null,
                        "content" => array("file", "webr", "feed", "wiki", "blog", "lm", "htlm", "sahs", "glo", "dcl", "bibl", "mcst", "mep"), 
                        "breaker2" => null,                     
                        "assessment" => array("exc", "tst", "qpl"), 
                        "feedback" => array("poll", "svy", "spl"),
                        "templates" => array("prtt")
                );
                
                $pos = 0;
                foreach($groups as $group => $items) 
                {
                        $pos += 10;
                        $grp_id = $pos/10;                                              

                        if(is_array($items))
                        {
                                $title = $lng->txt("rep_add_new_def_grp_".$group);
                                
                                $res["groups"][$grp_id] = array("id" => $grp_id,
                                        "titles" => array($lng->getUserLanguage() => $title),
                                        "pos" => $pos,
                                        "type" => self::NEW_ITEM_GROUP_TYPE_GROUP,
                                        "title" => $title);

                                foreach($items as $idx => $item)
                                {
                                        $res["items"][$item] = $grp_id;
                                        $res["sort"][$item] = str_pad($pos, 4, "0", STR_PAD_LEFT).
                                                str_pad($idx+1, 4, "0", STR_PAD_LEFT);
                                }
                        }
                        else
                        {
                                $title = "COL_SEP";
                                
                                $res["groups"][$grp_id] = array("id" => $grp_id,
                                        "titles" => array($lng->getUserLanguage() => $title),
                                        "pos" => $pos,
                                        "type" => self::NEW_ITEM_GROUP_TYPE_SEPARATOR,
                                        "title" => $title);
                        }
                }       
                
                return $res;
        }

Here is the caller graph for this function:

static ilObjRepositorySettings::getNewItemGroups ( )

static

Definition at line 116 of file class.ilObjRepositorySettings.php.

References $ilDB, $ilUser, ilObject\$lng, $res, $row, and ilObject\$title.

Referenced by ilObjRepositorySettingsGUI\confirmDeleteNewItemGroup(), ilModulesTableGUI\getComponents(), ilNewItemGroupTableGUI\getGroups(), ilObjRepositorySettingsGUI\initNewItemGroupForm(), ilObjectAddNewItemGUI\parseRepository(), ilObjRepositorySettingsGUI\saveModules(), and ilObjRepositorySettingsGUI\saveNewItemGroupOrder().

        {
                global $ilDB, $lng, $ilUser;
                
                $def_lng = $lng->getDefaultLanguage();
                $usr_lng = $ilUser->getLanguage();
                
                $res = array();
                
                $set = $ilDB->query("SELECT * FROM il_new_item_grp ORDER BY pos");
                while($row = $ilDB->fetchAssoc($set))
                {
                        if($row["type"] == self::NEW_ITEM_GROUP_TYPE_GROUP)
                        {
                                $row["titles"] = unserialize($row["titles"]);

                                $title = $row["titles"][$usr_lng];
                                if(!$title)
                                {
                                        $title = $row["titles"][$def_lng];
                                }
                                if(!$title)
                                {
                                        $title = array_shift($row["titles"]);
                                }
                                $row["title"] = $title;
                        }
                        else
                        {
                                $row["title"] = $lng->txt("rep_new_item_group_separator");
                        }
                        
                        $res[$row["id"]] = $row;                        
                }
                
                return $res;
        }

Here is the caller graph for this function:

static ilObjRepositorySettings::getNewItemGroupSubItems ( )

static

Definition at line 221 of file class.ilObjRepositorySettings.php.

References $ilSetting, $res, and ilObject\$type.

Referenced by deleteNewItemGroup(), ilNewItemGroupTableGUI\getGroups(), ilObjectAddNewItemGUI\parseRepository(), and ilObjRepositorySettingsGUI\saveNewItemGroupOrder().

        {
                global $ilSetting;
                
                $res = array();
                
                foreach(self::getAllObjTypes() as $type)
                {                       
                        $pos_grp = $ilSetting->get("obj_add_new_pos_grp_".$type, 0);
                        $res[$pos_grp][] = $type;                                               
                }
                
                return $res;
        }       

Here is the caller graph for this function:

static ilObjRepositorySettings::updateNewItemGroup (   $a_id, array  $a_titles  )

static

Definition at line 80 of file class.ilObjRepositorySettings.php.

References $ilDB.

Referenced by ilObjRepositorySettingsGUI\updateNewItemGroup().

        {
                global $ilDB;
                
                $ilDB->manipulate("UPDATE il_new_item_grp".
                        " SET titles = ".$ilDB->quote(serialize($a_titles), "text").
                        " WHERE id = ".$ilDB->quote($a_id, "integer"));                 
                return true;
        }

Here is the caller graph for this function:

static ilObjRepositorySettings::updateNewItemGroupOrder ( array  $a_order )

static

Definition at line 154 of file class.ilObjRepositorySettings.php.

References ilObject\$id, and $ilDB.

Referenced by ilObjRepositorySettingsGUI\saveNewItemGroupOrder().

        {
                global $ilDB;
                
                asort($a_order);
                $pos = 0;
                foreach(array_keys($a_order) as $id)
                {
                        $pos += 10;
                        
                        $ilDB->manipulate("UPDATE il_new_item_grp".
                                " SET pos = ".$ilDB->quote($pos, "integer").
                                " WHERE id = ".$ilDB->quote($id, "integer"));                   
                }       
        }

Here is the caller graph for this function:

Field Documentation

const ilObjRepositorySettings::NEW_ITEM_GROUP_TYPE_GROUP = 1

Definition at line 16 of file class.ilObjRepositorySettings.php.

Referenced by ilNewItemGroupTableGUI\fillRow(), ilModulesTableGUI\getComponents(), and ilObjectAddNewItemGUI\parseRepository().

const ilObjRepositorySettings::NEW_ITEM_GROUP_TYPE_SEPARATOR = 2

Definition at line 17 of file class.ilObjRepositorySettings.php.

---

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

• Services/Repository/classes/class.ilObjRepositorySettings.php