ilObjRoleFolder Class Reference

Class ilObjRoleFolder. More...

Inheritance diagram for ilObjRoleFolder:

Collaboration diagram for ilObjRoleFolder:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	read ()
	delete ()
	delete rolefolder and all related data More...
	createRole ($a_title, $a_desc, $a_import_id=0)
	creates a local role in current rolefolder (this object) More...
	purge ()
	checks if rolefolder contains any roles. More...
	isDeleted ()
	checks if role folder is in trash private More...
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...
	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 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...
	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 ()
	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...

Additional Inherited Members
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)
	only called in ilTree::saveSubTree More...
static	setDeletedDates ($a_ref_ids)
	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 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 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
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Detailed Description

Class ilObjRoleFolder.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilObjRoleFolder::__construct	(		$a_id = 0,
			$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 43 of file class.ilObjRoleFolder.php.

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

Member Function Documentation

createRole()

ilObjRoleFolder::createRole	(		$a_title,
			$a_desc,
			$a_import_id = 0
	)

creates a local role in current rolefolder (this object)

public

Parameters

string	title
string	description

Returns

object role object

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

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, and ilObject\getRefId().

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
        
        include_once("./Services/AccessControl/classes/class.ilObjRole.php");
        $roleObj = new ilObjRole();
        $roleObj->setTitle($a_title);
        $roleObj->setDescription($a_desc);
        //echo "aaa-1-";
        if ($a_import_id != "") {
            //echo "aaa-2-".$a_import_id."-";
            $roleObj->setImportId($a_import_id);
        }
        $roleObj->create();
            
        // ...and put the role into local role folder...
        $rbacadmin->assignRoleToFolder($roleObj->getId(), $this->getRefId(), "y");

        return $roleObj;
    }

Here is the call graph for this function:

delete()

ilObjRoleFolder::delete

(

)

delete rolefolder and all related data

public

Returns

boolean true if all object data were removed; false if only a references were removed

Definition at line 66 of file class.ilObjRoleFolder.php.

References $DIC, ilObject\$rbacreview, and ilObject\getRefId().

    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }

        // put here rolefolder specific stuff
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        
        $roles = $rbacreview->getRolesOfRoleFolder($this->getRefId());
        
        // FIRST DELETE ALL LOCAL/BASE ROLES OF FOLDER
        foreach ($roles as $role_id) {
            $roleObj = &$this->ilias->obj_factory->getInstanceByObjId($role_id);
            $roleObj->setParent($this->getRefId());
            $roleObj->delete();
            unset($roleObj);
        }
        
        // always call parent delete function at the end!!
        return true;
    }

Here is the call graph for this function:

isDeleted()

ilObjRoleFolder::isDeleted

(

)

checks if role folder is in trash private

Returns

integer return negative tree if in trash, otherwise false

Definition at line 162 of file class.ilObjRoleFolder.php.

References $row, and ilObject\getRefId().

Referenced by purge().

    {
        $q = "SELECT tree FROM tree WHERE child= " . $this->ilias->db->quote($this->getRefId()) . " ";
        $row = $this->ilias->db->getRow($q);
        
        if ($row->tree < 0) {
            return $row->tree;
        }
        
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

purge()

ilObjRoleFolder::purge

(

)

checks if rolefolder contains any roles.

if not the rolefolder is deleted public

Returns

boolean true if rolefolder is deleted

Definition at line 129 of file class.ilObjRoleFolder.php.

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, ilObject\$tree, ilObject\getRefId(), and isDeleted().

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        $rbacadmin = $DIC['rbacadmin'];
        $tree = $DIC['tree'];

        $local_roles = $rbacreview->getRolesOfRoleFolder($this->getRefId());
            
        if (count($local_roles) == 0) {
            $rbacadmin->revokePermission($this->getRefId());
            
            if ($tree_id = $this->isDeleted()) {
                $deleted_tree = new ilTree($tree_id, -(int) $tree_id);
                $deleted_tree->deleteTree($deleted_tree->getNodeData($this->getRefId()));
            } else {
                $tree->deleteTree($tree->getNodeData($this->getRefId()));
            }

            $this->delete();
            
            return true;
        }
        
        return false;
    }

Here is the call graph for this function:

read()

ilObjRoleFolder::read

(

)

Definition at line 49 of file class.ilObjRoleFolder.php.

References ilObject\getDescription(), ilObject\getId(), ilObject\getTitle(), ilObject\setDescription(), and ilObject\setTitle().

    {
        parent::read();
        
        if ($this->getId() != ROLE_FOLDER_ID) {
            $this->setDescription($this->lng->txt("obj_" . $this->getType() . "_local_desc") . $this->getTitle() . $this->getDescription());
            $this->setTitle($this->lng->txt("obj_" . $this->getType() . "_local"));
        }
    }

Here is the call graph for this function:

---

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

• Services/AccessControl/classes/class.ilObjRoleFolder.php