ilObjRoleFolder Class Reference

Class ilObjRoleFolder. More...

Inheritance diagram for ilObjRoleFolder:

Collaboration diagram for ilObjRoleFolder:

Public Member Functions
	ilObjRoleFolder ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	read ($a_force_db=false)
	read object data from db into object
	delete ()
	delete rolefolder and all related data
	createRole ($a_title, $a_desc, $a_import_id=0)
	creates a local role in current rolefolder (this object)
	purge ()
	checks if rolefolder contains any roles.
	isDeleted ()
	checks if role folder is in trash private
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)
	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
	_lookupObjIdByImportId ($a_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)
	_getAllReferences ($a_id)
	get all reference ids of object
	_lookupOwner ($a_id)
	lookup object owner
	_lookupDescription ($a_id)
	lookup object description
	_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
	_lookupObjectId ($a_ref_id)
	lookup object id
	_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
	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
	createRoleFolder ()
	creates a local role folder
	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)
	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.

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
	_exists ($a_id, $a_reference=false)
	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)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
Data Fields inherited from ilObject
	$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

Detailed Description

Class ilObjRoleFolder.

Author

Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Id:

class.ilObjRoleFolder.php 15681 2008-01-07 17:05:41Z akill

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

Member Function Documentation

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 102 of file class.ilObjRoleFolder.php.

References ilObject\getRefId().

        {
                global $rbacadmin, $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:

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

Reimplemented from ilObject.

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

References ilObject\getRefId().

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

                // put here rolefolder specific stuff
                global $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:

ilObjRoleFolder::ilObjRoleFolder	(		$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.

References ilObject\ilObject().

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

Here is the call graph for this function:

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 $q, $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:

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 ilObject\getRefId(), and isDeleted().

        {
                global $rbacreview, $rbacadmin, $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:

ilObjRoleFolder::read

(

$a_force_db = false

)

read object data from db into object

Parameters

boolean

public

Reimplemented from ilObject.

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

References ilObject\getId(), 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