Inheritance diagram for ilObjRepositorySettings:

Collaboration diagram for ilObjRepositorySettings:

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

	delete ()

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

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

	read ()
	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 ()

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

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

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

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

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

	applyDidacticTemplate ($a_tpl_id)
	Apply template. 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...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

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	deleteObjectType ($a_type)

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

static	_lookupImportId ($a_obj_id)

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

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

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

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

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

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

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

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

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

static	_lookupObjId ($a_id)

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

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

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

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

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

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

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

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

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

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

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

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

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

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

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

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

◆ __construct()

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

◆ addNewItemGroup()

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:

◆ addNewItemGroupSeparator()

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:

◆ delete()

ilObjRepositorySettings::delete ( )

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

         {
                 // DISABLED
                 return false;
         }

◆ deleteNewItemGroup()

static ilObjRepositorySettings::deleteNewItemGroup ( $a_id )

static

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

References $ilDB, and $ilSetting.

Referenced by ilObjRepositorySettingsGUI\deleteNewItemGroup().

         {
                 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 caller graph for this function:

◆ deleteObjectType()

static ilObjRepositorySettings::deleteObjectType ( $a_type )

static

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

References $a_type, and $ilSetting.

Referenced by ilRepUtil\deleteObjectType().

         {
                 global $ilSetting;
                 
                 // see ilObjRepositorySettingsGUI::saveModules()
                 $ilSetting->delete("obj_dis_creation_".$a_type);
                 $ilSetting->delete("obj_add_new_pos_".$a_type);                                                                                         
                 $ilSetting->delete("obj_add_new_pos_grp_".$a_type);             
         }

Here is the caller graph for this function:

◆ getAllObjTypes()

static ilObjRepositorySettings::getAllObjTypes ( )

staticprotected

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

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

◆ getDefaultNewItemGrouping()

static ilObjRepositorySettings::getDefaultNewItemGrouping ( )

static

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

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

Referenced by ilObjectAddNewItemGUI\parseRepository().

         {
                 global $lng;
                 
                 $res = array();
                                                                 
                 $groups = array(
                         "organisation" => array("fold", "sess", "cat", "catr", "crs", "crsr", "grp", "grpr", "itgr", "book", "prg"),
                         "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", "iass"),
                         "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:

◆ getNewItemGroups()

static ilObjRepositorySettings::getNewItemGroups ( )

static

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

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

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:

◆ getNewItemGroupSubItems()

static ilObjRepositorySettings::getNewItemGroupSubItems ( )

static

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

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

Referenced by 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:

◆ updateNewItemGroup()

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:

◆ updateNewItemGroupOrder()

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

◆ NEW_ITEM_GROUP_TYPE_GROUP

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

◆ NEW_ITEM_GROUP_TYPE_SEPARATOR

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

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addNewItemGroup()

◆ addNewItemGroupSeparator()

◆ delete()

◆ deleteNewItemGroup()

◆ deleteObjectType()

◆ getAllObjTypes()

◆ getDefaultNewItemGrouping()

◆ getNewItemGroups()

◆ getNewItemGroupSubItems()

◆ updateNewItemGroup()

◆ updateNewItemGroupOrder()

Field Documentation

◆ NEW_ITEM_GROUP_TYPE_GROUP

◆ NEW_ITEM_GROUP_TYPE_SEPARATOR