Inheritance diagram for ilObjChatroom:

Collaboration diagram for ilObjChatroom:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor.
	getPersonalInformation (ilChatroomUser $user)
	Prepares and returns $userInfo using given $user object.
	initDefaultRoles ()
	type $rbacadmin type $rbacreview ilDB $ilDB
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ...
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)
	read ($a_force_db=false)
	read object data from db into object
	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
	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)
	_lookupOwner ($a_id)
	lookup object owner
	_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
	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!!
	createRoleFolder ()
	creates a local role folder
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	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 ()
	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.

Static Public Member Functions
static	_getPublicRefId ()
static	_getPublicObjId ()
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
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, $show_path=true)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies.
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies.

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 128
	max length of object title
	$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 ilObjChatroom.

Author: Jan Posselt <jposselt at databay.de>

Version: $Id$

Definition at line 15 of file class.ilObjChatroom.php.

Constructor & Destructor Documentation

ilObjChatroom::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor.

Parameters

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

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

References ilObject\ilObject().

        {
                $this->type = 'chtr';
                $this->ilObject($a_id, $a_call_by_reference);
        }

Here is the call graph for this function:

Member Function Documentation

static ilObjChatroom::_getPublicObjId ( )

static

Definition at line 51 of file class.ilObjChatroom.php.

References $ilDB, and $row.

Referenced by ilObjChatroomListGUI\__construct().

                                                 {
                global $ilDB;
                $rset = $ilDB->query('SELECT object_id FROM chatroom_settings WHERE room_type=' . $ilDB->quote( 'default' ,'text'));
                if ($row = $ilDB->fetchAssoc($rset)) {
                        return $row['object_id'];
                }
                return 0;
        }

Here is the caller graph for this function:

static ilObjChatroom::_getPublicRefId ( )

static

Definition at line 46 of file class.ilObjChatroom.php.

Referenced by ilUsersOnlineBlockGUI\__showChatInvitation(), ilUsersOnlineBlockGUI\fillRow(), and ilChatroomViewTask\forcePublicRoom().

                                                 {
                $settings = new ilSetting('chatroom');
                return $settings->get('public_room_ref', 0);
        }

Here is the caller graph for this function:

ilObjChatroom::cloneObject	(	$a_target_id,
		$a_copy_id = `0`,
		$a_omit_tree = `false`
	)

Clone object permissions, put in tree ...

public

Parameters

int	target id
int	copy id for class.ilCopyWizardOptions()

Returns: object new object

Reimplemented from ilObject.

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

References ilRbacLog\add(), ilChatroom\byObjectId(), ilRbacLog\CREATE_OBJECT, ilRbacLog\gatherFaPa(), and ilObject\getId().

                                                                                      {
                global $rbacreview;
                require_once 'Modules/Chatroom/classes/class.ilChatroom.php';
                $original_room = ilChatroom::byObjectId($this->getId());
                $newObj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
                
                
                
                $objId = $newObj->getId();
                
                
                $original_settings = $original_room->getSettings();
                $room = new ilChatroom();
                $original_settings['object_id'] = $objId;
                
                $room->saveSettings($original_settings);
                // rbac log
                include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                $rbac_log_roles = $rbacreview->getParentRoleIds( $newObj->getRefId(), false );
                $rbac_log = ilRbacLog::gatherFaPa( $newObj->getRefId(), array_keys( $rbac_log_roles ), true );
                ilRbacLog::add( ilRbacLog::CREATE_OBJECT, $newObj->getRefId(), $rbac_log );
                
                return $newObj;
        }

Here is the call graph for this function:

ilObjChatroom::getPersonalInformation ( ilChatroomUser $user )

Prepares and returns $userInfo using given $user object.

Parameters

ilChatroomUser $user

Returns: stdClass

Definition at line 36 of file class.ilObjChatroom.php.

References ilChatroomUser\getUserId(), and ilChatroomUser\getUsername().

        {
                $userInfo = new stdClass();
                $userInfo->username = $user->getUsername();
                $userInfo->id = $user->getUserId();
                return $userInfo;
        }

Here is the call graph for this function:

ilObjChatroom::initDefaultRoles ( )

type $rbacadmin type $rbacreview ilDB $ilDB

Returns: type

Reimplemented from ilObject.

Definition at line 67 of file class.ilObjChatroom.php.

References $ilDB, $res, ilObject\createRoleFolder(), ilObject\getId(), and ilObject\getRefId().

        {
                global $rbacadmin,$rbacreview,$ilDB;
                // Create a local role folder
                $rolf_obj = $this->createRoleFolder();
                // CREATE Moderator role
                $role_obj = $rolf_obj->createRole("il_chat_moderator_".$this->getRefId(), "Moderator of chat obj_no.".$this->getId());
                $roles[] = $role_obj->getId();
                
                // SET PERMISSION TEMPLATE OF NEW LOCAL ADMIN ROLE
                $statement = $ilDB->queryF('
                        SELECT obj_id FROM object_data 
                        WHERE type = %s 
                        AND title = %s',
                        array('text', 'text'),
                        array('rolt', 'il_chat_moderator'));
                
                //$res = $statement->fetchRow(DB_FETCHMODE_OBJECT);
                $res = $ilDB->fetchAssoc($statement);
                
                if ($res) {
                        $rbacadmin->copyRoleTemplatePermissions($res['obj_id'],ROLE_FOLDER_ID,$rolf_obj->getRefId(),$role_obj->getId());
                        // SET OBJECT PERMISSIONS OF COURSE OBJECT
                        $ops = $rbacreview->getOperationsOfRole($role_obj->getId(),"chtr",$rolf_obj->getRefId());
                        $rbacadmin->grantPermission($role_obj->getId(),$ops,$this->getRefId());
                }
                return $roles ? $roles : array();
        }

Here is the call graph for this function:

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

Modules/Chatroom/classes/class.ilObjChatroom.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation