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 @access public. More...
	delete ()
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor @access 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 @access public More...
	setId ($a_id)
	set object id @access public More...
	setRefId ($a_id)
	set reference id @access public More...
	getRefId ()
	get reference id @access public More...
	getType ()
	get object type @access public More...
	setType ($a_type)
	set object type @access public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title @access public More...
	getUntranslatedTitle ()
	get untranslated object title @access 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...
	setOfflineStatus ($a_status)
	Set offline status. More...
	getOfflineStatus ()
	Get offline status. More...
	supportsOfflineHandling ()
	Check whether object supports offline handling. More...
	getOwner ()
	get object owner More...
	getOwnerName ()
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date @access public More...
	getLastUpdateDate ()
	get last update date @access 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...
	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) @access public More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	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	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. 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, $a_deleted_by)
static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. 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@access public 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	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
	$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 ()

Additional Inherited Members
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

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 @access public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

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

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

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

addNewItemGroup()

static ilObjRepositorySettings::addNewItemGroup ( array  $a_titles )

static

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        // 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;
    }

References $DIC, and $ilDB.

Referenced by ilObjRepositorySettingsGUI\saveNewItemGroup().

Here is the caller graph for this function:

addNewItemGroupSeparator()

static ilObjRepositorySettings::addNewItemGroupSeparator ( )

static

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        // 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;
    }

References $DIC, and $ilDB.

Referenced by ilObjRepositorySettingsGUI\addNewItemGroupSeparator().

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 96 of file class.ilObjRepositorySettings.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();
        
        // 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;
    }

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

Referenced by ilObjRepositorySettingsGUI\deleteNewItemGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteObjectType()

static ilObjRepositorySettings::deleteObjectType (   $a_type )

static

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

    {
        global $DIC;
 
        $ilSetting = $DIC->settings();
        
        // 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);
    }

References $a_type, $DIC, and $ilSetting.

Referenced by ilRepUtil\deleteObjectType().

Here is the caller graph for this function:

getAllObjTypes()

static ilObjRepositorySettings::getAllObjTypes ( )

staticprotected

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

    {
        global $DIC;
 
        $ilPluginAdmin = $DIC["ilPluginAdmin"];
        $objDefinition = $DIC["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;
    }

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

Here is the call graph for this function:

getDefaultNewItemGrouping()

static ilObjRepositorySettings::getDefaultNewItemGrouping ( )

static

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

    {
        global $DIC;
 
        $lng = $DIC->language();
        
        $res = array();
                                
        $groups = array(
            "organisation" => array("fold", "sess", "cat", "catr", "crs", "crsr", "grp", "grpr", "itgr", "book", "prg", "prgr"),
            "communication" => array("frm", "chtr"),
            "breaker1" => null,
            "content" => array("file", "webr", "feed", "copa", "wiki", "blog", "lm", "htlm", "sahs", 'cmix', 'lti', "lso", "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;
    }

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

Referenced by ilObjectAddNewItemGUI\parseRepository().

Here is the caller graph for this function:

getNewItemGroups()

static ilObjRepositorySettings::getNewItemGroups ( )

static

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $lng = $DIC->language();
        $ilUser = $DIC->user();
        
        $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;
    }

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

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

Here is the caller graph for this function:

getNewItemGroupSubItems()

static ilObjRepositorySettings::getNewItemGroupSubItems ( )

static

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

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

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

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

Here is the caller graph for this function:

updateNewItemGroup()

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

static

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

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

References $DIC, and $ilDB.

Referenced by ilObjRepositorySettingsGUI\updateNewItemGroup().

Here is the caller graph for this function:

updateNewItemGroupOrder()

static ilObjRepositorySettings::updateNewItemGroupOrder ( array  $a_order )

static

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        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"));
        }
    }

References $DIC, ilObject\$id, and $ilDB.

Referenced by ilObjRepositorySettingsGUI\saveNewItemGroupOrder().

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