ilObjRepositorySettings Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjRepositorySettings:

Collaboration diagram for ilObjRepositorySettings:

Public Member Functions
	__construct (int $a_id, bool $a_call_by_reference=true)
	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...
Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $desc)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	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. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects 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 (int $a_id, array $a_titles)
static	deleteNewItemGroup (int $a_id)
static	getNewItemGroups ()
static	updateNewItemGroupOrder (array $a_order)
static	getNewItemGroupSubItems ()
static	getDefaultNewItemGrouping ()
static	deleteObjectType (string $a_type)
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

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
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Static Protected Member Functions
static	getAllObjTypes ()

Additional Inherited Members
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
int	$id
bool	$referenced
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
bool	$offline = false
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilObjRepositorySettings

Author

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

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

Constructor & Destructor Documentation

__construct()

ilObjRepositorySettings::__construct	(	int	$id,
		bool	$reference = true
	)

Parameters

int	$id	reference_id or object_id
bool	$reference	bool treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

Definition at line 29 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 64 of file class.ilObjRepositorySettings.php.

                                                           : bool
    {
        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, $ilDB, and ILIAS\Repository\int().

Referenced by ilObjRepositorySettingsGUI\saveNewItemGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

addNewItemGroupSeparator()

static ilObjRepositorySettings::addNewItemGroupSeparator ( )

static

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

                                                     : bool
    {
        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, $ilDB, and ILIAS\Repository\int().

Referenced by ilObjRepositorySettingsGUI\addNewItemGroupSeparator().

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

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

Returns

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

Reimplemented from ilObject.

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

                            : bool
    {
        // DISABLED
        return false;
    }

deleteNewItemGroup()

static ilObjRepositorySettings::deleteNewItemGroup ( int  $a_id )

static

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

                                                        : bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();
 
        // move subitems to unassigned
        $sub_items = self::getNewItemGroupSubItems();
        $sub_items = $sub_items[$a_id] ?? false;
        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 ( string  $a_type )

static

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

                                                           : void
    {
        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 $DIC, and $ilSetting.

getAllObjTypes()

static ilObjRepositorySettings::getAllObjTypes ( )

staticprotected

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

                                              : array
    {
        global $DIC;
 
        $component_repository = $DIC["component.repository"];
        $objDefinition = $DIC["objDefinition"];
 
        $res = [];
 
        // parse modules
        foreach ($component_repository->getComponents() as $mod) {
            if ($mod->getType() !== ilComponentInfo::TYPE_MODULES) {
                continue;
            }
            $has_repo = false;
            $rep_types = $objDefinition->getRepositoryObjectTypesForComponent(ilComponentInfo::TYPE_MODULES, $mod->getName());
            if (count($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
        $pl_names = $component_repository->getPluginSlotById("robj")->getActivePlugins();
        foreach ($pl_names as $plugin) {
            $res[] = $plugin->getId();
        }
 
        return $res;
    }

References $DIC, XapiProxy\$plugin, $res, and ilComponentInfo\TYPE_MODULES.

getDefaultNewItemGrouping()

static ilObjRepositorySettings::getDefaultNewItemGrouping ( )

static

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

                                                      : array
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        $res = [];
 
        $groups = [
            "organisation" => ["fold", "sess", "cat", "catr", "crs", "crsr", "grp", "grpr", "itgr", "book", "prg", "prgr"],
            "communication" => ["frm", "chtr"],
            "breaker1" => null,
            "content" => ["file", "webr", "feed", "copa", "wiki", "blog", "lm", "htlm", "sahs", 'cmix', 'lti', "lso", "glo", "dcl", "bibl", "mcst", "mep"],
            "breaker2" => null,
            "assessment" => ["exc", "tst", "qpl", "iass"],
            "feedback" => ["poll", "svy", "spl"],
            "templates" => ["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] = [
                    "id" => $grp_id,
                    "titles" => [$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((string) $pos, 4, "0", STR_PAD_LEFT) .
                        str_pad((string) ($idx + 1), 4, "0", STR_PAD_LEFT);
                }
            } else {
                $title = "COL_SEP";
 
                $res["groups"][$grp_id] = [
                    "id" => $grp_id,
                    "titles" => [$lng->getUserLanguage() => $title],
                    "pos" => $pos,
                    "type" => self::NEW_ITEM_GROUP_TYPE_SEPARATOR,
                    "title" => $title
                ];
            }
        }
 
        return $res;
    }

References $DIC, ilObject\$lng, $res, ilObject\$title, ilLanguage\getUserLanguage(), NEW_ITEM_GROUP_TYPE_GROUP, NEW_ITEM_GROUP_TYPE_SEPARATOR, and ilLanguage\txt().

Referenced by ilObjectAddNewItemGUI\parseRepository().

Here is the call graph for this function:

Here is the caller graph for this function:

getNewItemGroups()

static ilObjRepositorySettings::getNewItemGroups ( )

static

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

                                             : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $lng = $DIC->language();
        $ilUser = $DIC->user();
 
        $def_lng = $lng->getDefaultLanguage();
        $usr_lng = $ilUser->getLanguage();
 
        $res = [];
 
        $set = $ilDB->query("SELECT * FROM il_new_item_grp ORDER BY pos");
        while ($row = $ilDB->fetchAssoc($set)) {
            if ((int) $row["type"] === self::NEW_ITEM_GROUP_TYPE_GROUP) {
                $row["titles"] = unserialize($row["titles"], ["allowed_classes" => false]);
 
                $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, ilObject\$title, ilLanguage\getDefaultLanguage(), and ilLanguage\txt().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getNewItemGroupSubItems()

static ilObjRepositorySettings::getNewItemGroupSubItems ( )

static

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

                                                    : array
    {
        global $DIC;
 
        $ilSetting = $DIC->settings();
 
        $res = [];
 
        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 ( int  $a_id, array  $a_titles  )

static

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

                                                                         : bool
    {
        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 162 of file class.ilObjRepositorySettings.php.

                                                                  : void
    {
        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 26 of file class.ilObjRepositorySettings.php.

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

NEW_ITEM_GROUP_TYPE_SEPARATOR

const ilObjRepositorySettings::NEW_ITEM_GROUP_TYPE_SEPARATOR = 2

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

Referenced by getDefaultNewItemGrouping().

---

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

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