ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjChatroom Class Reference

Class ilObjChatroom. More...

+ Inheritance diagram for ilObjChatroom:
+ Collaboration diagram for ilObjChatroom:

Public Member Functions

 __construct ($a_id=0, $a_call_by_reference=true)
 Constructor. More...
 
 getPersonalInformation (ilChatroomUser $user)
 Prepares and returns $userInfo using given $user object. More...
 
 initDefaultRoles ()
 @global type $rbacadmin @global type $rbacreview @global ilDB $ilDB More...
 
 cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
 Clone object permissions, put in tree ... More...
 
- Public Member Functions inherited from ilObject
 ilObject ($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 ($a_force_db=false)
 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...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date @access public More...
 
 getLastUpdateDate ()
 get last update date @access public More...
 
 getDiskUsage ()
 
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class) 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...
 
 _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
 _lookupOwner ($a_id)
 lookup object owner More...
 
 _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
 _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
 _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
 _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
 _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
 _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
 _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type 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...
 
 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 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...
 
 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. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
 Clone object permissions, put in tree ... More...
 
 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...
 
 _lookupCreationDate ($a_id)
 Lookup creation date. 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 _getPublicRefId ()
 
static _getPublicObjId ()
 
- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _lookupImportId ($a_obj_id)
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupObjId ($a_id)
 
static setDeletedDates ($a_ref_ids)
 Set deleted date @global type $ilDB. More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id 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 _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item. 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 hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course. More...
 

Additional Inherited Members

- Data Fields inherited from ilObject
const TITLE_LENGTH = 255
 max length of object title More...
 
const DESC_LENGTH = 128
 
 $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 More...
 

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

◆ __construct()

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

Constructor.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

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

25 {
26 $this->type = 'chtr';
27 $this->ilObject($a_id, $a_call_by_reference);
28 }
ilObject($a_id=0, $a_reference=true)
Constructor @access public.

References ilObject\ilObject().

+ Here is the call graph for this function:

Member Function Documentation

◆ _getPublicObjId()

static ilObjChatroom::_getPublicObjId ( )
static

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

51 {
52 global $ilDB;
53
54 $rset = $ilDB->query('SELECT object_id FROM chatroom_settings WHERE room_type=' . $ilDB->quote( 'default' ,'text'));
55 if ($row = $ilDB->fetchAssoc($rset)) {
56 return $row['object_id'];
57 }
58 return 0;
59 }
global $ilDB

References $ilDB, and $row.

Referenced by ilObjChatroomListGUI\__construct().

+ Here is the caller graph for this function:

◆ _getPublicRefId()

static ilObjChatroom::_getPublicRefId ( )
static

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

46 {
47 $settings = new ilSetting('chatroom');
48 return $settings->get('public_room_ref', 0);
49 }
ILIAS Setting Class.

Referenced by ilAwarenessChatFeatureProvider\__construct(), ilUsersOnlineBlockGUI\__showChatInvitation(), ilUsersOnlineBlockGUI\fillRow(), and ilChatroomAdminViewTask\forcePublicRoom().

+ Here is the caller graph for this function:

◆ cloneObject()

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

Clone object permissions, put in tree ...

@access public

Parameters
inttarget id
intcopy id for class.ilCopyWizardOptions()
Returns
object new object

Reimplemented from ilObject.

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

79 {
80 global $rbacreview;
81 require_once 'Modules/Chatroom/classes/class.ilChatroom.php';
82 $original_room = ilChatroom::byObjectId($this->getId());
83
84 $newObj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
85
86
87
88 $objId = $newObj->getId();
89
90
91
92 $original_settings = $original_room->getSettings();
93 $room = new ilChatroom();
94
95 $original_settings['object_id'] = $objId;
96
97 $room->saveSettings($original_settings);
98
99 // rbac log
100 include_once "Services/AccessControl/classes/class.ilRbacLog.php";
101 $rbac_log_roles = $rbacreview->getParentRoleIds( $newObj->getRefId(), false );
102 $rbac_log = ilRbacLog::gatherFaPa( $newObj->getRefId(), array_keys( $rbac_log_roles ), true );
103 ilRbacLog::add( ilRbacLog::CREATE_OBJECT, $newObj->getRefId(), $rbac_log );
104
105 return $newObj;
106 }
Class ilChatroom.
static byObjectId($object_id)
Returns ilChatroom object by given $object_id.
getId()
get object id @access public
static add($a_action, $a_ref_id, array $a_diff, $a_source_ref_id=false)
static gatherFaPa($a_ref_id, array $a_role_ids, $a_add_action=false)
const CREATE_OBJECT

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

+ Here is the call graph for this function:

◆ getPersonalInformation()

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.

37 {
38 $userInfo = new stdClass();
39 $userInfo->username = $user->getUsername();
40 $userInfo->id = $user->getUserId();
41
42 return $userInfo;
43 }
getUserId()
Returns Ilias User ID.
getUsername()
Returns username from Object or SESSION.

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

+ Here is the call graph for this function:

◆ initDefaultRoles()

ilObjChatroom::initDefaultRoles ( )

@global type $rbacadmin @global type $rbacreview @global ilDB $ilDB

Returns
type

Reimplemented from ilObject.

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

68 {
69 include_once './Services/AccessControl/classes/class.ilObjRole.php';
71 'il_chat_moderator_'.$this->getRefId(),
72 "Moderator of chat obj_no.".$this->getId(),
73 'il_chat_moderator',
74 $this->getRefId()
75 );
76 return array();
77 }
static createDefaultRole($a_title, $a_description, $a_tpl_name, $a_ref_id)
getRefId()
get reference id @access public

References ilObjRole\createDefaultRole(), ilObject\getId(), and ilObject\getRefId().

+ Here is the call graph for this function:

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