Collaboration diagram for ilChatroom:

Public Member Functions
	initialize (array $rowdata)
	Sets $this->roomId by given array $rowdata and calls setSetting method foreach available setting in $this->availableSettings. More...

	setSetting ($name, $value)
	Sets given name and value as setting into $this->settings array. More...

	getDescription ()

	getSetting ($name)
	Returns setting from $this->settings array by given name. More...

	save ()
	Saves settings using $this->settings. More...

	saveSettings (array $settings)
	Saves settings into settingsTable using given settings array. More...

	addHistoryEntry ($message, $recipient=null, $publicMessage=true)
	Inserts entry into historyTable. More...

	connectUser (ilChatroomUser $user)
	Connects user by inserting userdata into userTable. More...

	getConnectedUsers ($only_data=true)
	Returns an array of connected users. More...

	disconnectUser ($user_id)
	Creates userId array by given $user object and calls disconnectUsers method. More...

	disconnectUsers (array $userIds)
	Disconnects users by deleting userdata from userTable using given userId array. More...

	getSettings ()
	Returns $this->settings array. More...

	isSubscribed ($chat_userid)
	Returns true if entry exists in userTable matching given $chat_userid and $this->roomId. More...

	isAllowedToEnterPrivateRoom ($chat_userid, $proom_id)

	getHistory (ilDateTime $from=null, ilDateTime $to=null, $restricted_session_userid=null, $proom_id=0, $respect_target=true)
	Returns array containing history data selected from historyTable by given ilDateTime, $restricted_session_userid and matching roomId. More...

	getRoomId ()
	Returns roomID from $this->roomId. More...

	getPrivateRoomSessions (ilDateTime $from=null, ilDateTime $to=null, $user_id=0, $room_id=0)

	saveFileUploadToDb ($user_id, $filename, $type)
	Saves information about file uploads in DB. More...

	banUser ($user_id, $actor_id, $comment='')
	Inserts user into banTable, using given $user_id. More...

	unbanUser ($user_id)
	Deletes entry from banTable matching roomId and given $user_id and returns true if sucessful. More...

	isUserBanned ($user_id)
	Returns true if there's an entry in banTable matching roomId and given $user_id. More...

	getBannedUsers ()
	Returns an multidimensional array containing userdata from users having an entry in banTable with matching roomId. More...

	getLastSession (ilChatroomUser $user)
	Returns last session from user. More...

	getSessions (ilChatroomUser $user)
	Returns all session from user Returns all from sessionTable where user_id matches userId from given $user object. More...

	addPrivateRoom ($title, ilChatroomUser $owner, $settings)

	closePrivateRoom ($id)

	isOwnerOfPrivateRoom ($user_id, $proom_id)

	getChatURL ($gui, $scope_id=0)

	getTitle ()

	inviteUserToPrivateRoomByLogin ($login, $proom_id)

	inviteUserToPrivateRoom ($user_id, $proom_id)

	getActivePrivateRooms ($userid)

	listUsersInPrivateRoom ($private_room_id)

	subscribeUserToPrivateRoom ($room_id, $user_id)

	userIsInPrivateRoom ($room_id, $user_id)

	unsubscribeUserFromPrivateRoom ($room_id, $user_id)

	countActiveUsers ()

	getPrivateRooms ()

	getPrivilegedUsersForPrivateRoom ($subRoomId)

	getUniquePrivateRoomTitle ($title)

	getAllRooms ($user_id)
	Fetches and returns the object ids of all rooms accessible by the user with $user_id. More...

	getPrivateSubRooms ($parent_room, $user_id)

	getRefIdByRoomId ($room_id)
	Returns ref_id of given room_id. More...

	getLastMessagesForChatViewer ($number, $chatuser=null)

	getLastMessages ($number, $chatuser=null)

	clearMessages ($sub_room)

Static Public Member Functions
static	checkUserPermissions ($permissions, $ref_id, $send_info=true)
	Checks user permissions by given array and ref_id. More...

static	checkPermissionsOfUser ($usr_id, $permissions, $ref_id)
	Checks user permissions in question for a given user id in relation to a given ref_id. More...

static	byObjectId ($object_id)
	Returns ilChatroom object by given $object_id. More...

static	byRoomId ($room_id, $initObject=false)
	Returns ilChatroom by given $room_id. More...

static	disconnectAllUsersFromAllRooms ()
	Deletes all entrys from userTable. More...

static	findDeletablePrivateRooms ()

static	getUntrashedChatReferences ($filter=array())

static	lookupPrivateRoomTitle ($proom_id)

Static Protected Member Functions
static	checkPermissions ($usrId, $refId, array $permissions)

Private Member Functions
	phpTypeToMDBType ($type)

Private Attributes
	$settings = array()

	$availableSettings

	$roomId

	$object

Static Private Attributes
static	$settingsTable = 'chatroom_settings'

static	$historyTable = 'chatroom_history'

static	$userTable = 'chatroom_users'

static	$sessionTable = 'chatroom_sessions'

static	$banTable = 'chatroom_bans'

static	$privateRoomsTable = 'chatroom_prooms'

static	$privateSessionsTable = 'chatroom_psessions'

static	$uploadTable = 'chatroom_uploads'

static	$privateRoomsAccessTable = 'chatroom_proomaccess'

Detailed Description

Class ilChatroom.

Author: Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version: $Id$

Definition at line 10 of file class.ilChatroom.php.

Member Function Documentation

◆ addHistoryEntry()

ilChatroom::addHistoryEntry	(	$message,
		$recipient = `null`,
		$publicMessage = `true`
	)

Inserts entry into historyTable.

Todo:: $recipient, $publicMessage speichern

Parameters

string	$message
string	$recipient
boolean	$publicMessage

Definition at line 401 of file class.ilChatroom.php.

References $DIC, $id, $message, $timestamp, array, and time.

     {
         global $DIC;
 
         $subRoom   = 0;
         $timestamp = 0;
         if (is_array($message)) {
             $subRoom   = (int) $message['sub'];
             $timestamp = (int) $message['timestamp'];
         } elseif (is_object($message)) {
             $subRoom   = (int) $message->sub;
             $timestamp = (int) $message->timestamp;
         }
 
         $id = $DIC->database()->nextId(self::$historyTable);
         $DIC->database()->insert(
             self::$historyTable,
             array(
                 'hist_id'   => array('integer', $id),
                 'room_id'   => array('integer', $this->roomId),
                 'sub_room'  => array('integer', $subRoom),
                 'message'   => array('text', json_encode($message)),
                 'timestamp' => array('integer', ($timestamp > 0 ? $timestamp : time())),
             )
         );
     }

◆ addPrivateRoom()

ilChatroom::addPrivateRoom	(		$title,
		ilChatroomUser	$owner,
			$settings
	)

Definition at line 909 of file class.ilChatroom.php.

References $DIC, $settings, $title, array, ilChatroomUser\getUserId(), and time.

Referenced by ilChatroomViewGUI\renderFileUploadForm().

     {
         global $DIC;
 
         $nextId = $DIC->database()->nextId(self::$privateRoomsTable);
         $DIC->database()->insert(
             self::$privateRoomsTable,
             array(
                 'proom_id'  => array('integer', $nextId),
                 'parent_id' => array('integer', $this->roomId),
                 'title'     => array('text', $title),
                 'owner'     => array('integer', $owner->getUserId()),
                 'closed'    => array('integer', (isset($settings['closed']) ? $settings['closed'] : 0)),
                 'created'   => array('integer', (isset($settings['created']) ? $settings['created'] : time())),
                 'is_public' => array('integer', $settings['public']),
             )
         );
 
         return $nextId;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ banUser()

ilChatroom::banUser	(	$user_id,
		$actor_id,
		$comment = `''`
	)

Inserts user into banTable, using given $user_id.

Parameters

integer	$user_id
integer	$actor_id
string	$comment

Definition at line 758 of file class.ilChatroom.php.

References $comment, $DIC, array, and time.

     {
         global $DIC;
 
         $DIC->database()->replace(
             self::$banTable,
             array(
                 'room_id' => array('integer', $this->roomId),
                 'user_id' => array('integer', $user_id)
             ),
             array(
                 'actor_id'  => array('integer', $actor_id),
                 'timestamp' => array('integer', time()),
                 'remark'    => array('text', $comment)
             )
         );
     }

◆ byObjectId()

static ilChatroom::byObjectId ( $object_id )

static

Returns ilChatroom object by given $object_id.

Parameters

integer $object_id

Returns: ilChatroom

Definition at line 149 of file class.ilChatroom.php.

References $DIC, $query, $row, and array.

Referenced by ilChatroomHistoryGUI\__construct(), ilChatroomXMLWriter\__construct(), ilChatroomXMLParser\__construct(), ilChatroomBanGUI\active(), ilChatroomServerHandler\cleanupPrivateRooms(), ilObjChatroom\cloneObject(), ilChatroomPrivateRoomGUI\create(), ilChatroomBanGUI\delete(), ilChatroomPrivateRoomGUI\delete(), ilChatroomPrivateRoomGUI\enter(), ilChatroomPostMessageGUI\executeDefault(), ilChatroomInitialGUI\executeDefault(), ilChatroomKickGUI\executeDefault(), ilChatroomBlockGUI\getChatroomSelectionList(), ilObjChatroomListGUI\getProperties(), ilChatroomBlock\getReadableAreas(), ilChatroomGUIHandler\getRoomByObjectId(), ilChatroomTabGUIFactory\getTabsForCommand(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomPrivateRoomGUI\leave(), ilChatroomPrivateRoomGUI\listUsers(), ilChatroomKickGUI\main(), ilChatroomViewGUI\renderFileUploadForm(), ilChatroomCreateGUI\save(), ilChatroomBanGUI\show(), ilChatroomKickGUI\sub(), and ilChatroomUploadFileGUI\uploadFile().

     {
         global $DIC;
 
         $query  = 'SELECT * FROM ' . self::$settingsTable . ' WHERE object_id = %s';
         $types  = array('integer');
         $values = array($object_id);
         $rset   = $DIC->database()->queryF($query, $types, $values);
 
         if ($row = $DIC->database()->fetchAssoc($rset)) {
             $room = new self();
             $room->initialize($row);
             return $room;
         }
     }

Here is the caller graph for this function:

◆ byRoomId()

static ilChatroom::byRoomId	(	$room_id,
		$initObject = `false`
	)

static

Returns ilChatroom by given $room_id.

Parameters

integer $room_id

Returns: ilChatroom

Definition at line 197 of file class.ilChatroom.php.

References $DIC, $query, $row, array, and ilObjectFactory\getInstanceByObjId().

Referenced by ilChatroomServerHandler\disconnectedUsers(), and ilContactGUI\submitInvitation().

     {
         global $DIC;
 
         $query = 'SELECT * FROM ' . self::$settingsTable . ' WHERE room_id = %s';
 
         $types  = array('integer');
         $values = array($room_id);
 
         $rset = $DIC->database()->queryF($query, $types, $values);
 
         if ($row = $DIC->database()->fetchAssoc($rset)) {
             $room = new self();
             $room->initialize($row);
 
             if ($initObject) {
                 $room->object = ilObjectFactory::getInstanceByObjId($row['object_id']);
             }
 
             return $room;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkPermissions()

static ilChatroom::checkPermissions	(		$usrId,
			$refId,
		array	$permissions
	)

staticprotected

Parameters

int	$usrId
int	$refId
array	$permissions

Returns: bool

Definition at line 93 of file class.ilChatroom.php.

References $DIC, $GLOBALS, ilObjChatroom\_getPublicRefId(), ilObject\_lookupObjId(), IL_NO_OBJECT_ACCESS, and ilObjChatroomAccess\isActivated().

     {
         global $DIC;
 
         require_once 'Modules/Chatroom/classes/class.ilObjChatroom.php';
         $pub_ref_id = ilObjChatroom::_getPublicRefId();
 
         foreach ($permissions as $permission) {
             if ($pub_ref_id == $refId) {
                 $hasAccess = $DIC->rbac()->system()->checkAccessOfUser($usrId, $permission, $refId);
                 if ($hasAccess) {
                     $hasWritePermission = $DIC->rbac()->system()->checkAccessOfUser($usrId, 'write', $refId);
                     if ($hasWritePermission) {
                         continue;
                     }
 
                     $visible  = null;
                     $a_obj_id = ilObject::_lookupObjId($refId);
                     $active   = ilObjChatroomAccess::isActivated($refId, $a_obj_id, $visible);
 
                     switch ($permission) {
                         case 'visible':
                             if (!$active) {
                                 $GLOBALS['DIC']->access()->addInfoItem(IL_NO_OBJECT_ACCESS, $GLOBALS['DIC']->language()->txt('offline'));
                             }
 
                             if (!$active && !$visible) {
                                 return false;
                             }
                             break;
 
                         case 'read':
                             if (!$active) {
                                 $GLOBALS['DIC']->access()->addInfoItem(IL_NO_OBJECT_ACCESS, $GLOBALS['DIC']->language()->txt('offline'));
                                 return false;
                             }
                             break;
                     }
                 }
             } else {
                 $hasAccess = $DIC->access()->checkAccessOfUser($usrId, $permission, '', $refId);
             }
 
             if (!$hasAccess) {
                 return false;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ checkPermissionsOfUser()

static ilChatroom::checkPermissionsOfUser	(	$usr_id,
		$permissions,
		$ref_id
	)

static

Checks user permissions in question for a given user id in relation to a given ref_id.

Parameters

integer	$usr_id
array \| string	$permissions
integer	$ref_id

Returns: bool

Definition at line 78 of file class.ilChatroom.php.

References array.

Referenced by ilContactGUI\submitInvitation().

     {
         if (!is_array($permissions)) {
             $permissions = array($permissions);
         }
 
         return self::checkPermissions($usr_id, $ref_id, $permissions);
     }

Here is the caller graph for this function:

◆ checkUserPermissions()

static ilChatroom::checkUserPermissions	(	$permissions,
		$ref_id,
		$send_info = `true`
	)

static

Checks user permissions by given array and ref_id.

Parameters

string \| array	$permissions
integer	$ref_id
bool	$send_info

Returns: bool

Definition at line 52 of file class.ilChatroom.php.

References $DIC, array, and ilUtil\sendFailure().

Referenced by ilChatroomInfoGUI\__construct(), ilChatroomSettingsGUI\__construct(), ilObjChatroomGUI\_goto(), ilChatroomTabGUIFactory\buildTabs(), ilChatroomAdminViewGUI\clientsettings(), ilChatroomInitialGUI\executeDefault(), ilChatroomBlockGUI\getChatroomSelectionList(), ilChatroomBlock\getReadableAreas(), ilChatroomGUIHandler\hasPermission(), ilChatroomGUIHandler\redirectIfNoPermission(), ilChatroomAdminViewGUI\serversettings(), ilChatroomKickGUI\sub(), and ilChatroomAdminSmileyGUI\view().

     {
         global $DIC;
 
         if (!is_array($permissions)) {
             $permissions = array($permissions);
         }
 
         $hasPermissions = self::checkPermissions($DIC->user()->getId(), $ref_id, $permissions);
         if (!$hasPermissions && $send_info) {
             ilUtil::sendFailure($DIC->language()->txt('permission_denied'), true);
 
             return false;
         }
 
         return $hasPermissions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearMessages()

ilChatroom::clearMessages ( $sub_room )

Definition at line 1439 of file class.ilChatroom.php.

References $DIC, array, and time.

     {
         global $DIC;
 
         $DIC->database()->queryF(
             'DELETE FROM ' . self::$historyTable . ' WHERE room_id = %s AND sub_room = %s',
             array('integer', 'integer'),
             array($this->roomId, (int) $sub_room)
         );
 
         if ($sub_room) {
             $DIC->database()->queryF(
                 'DELETE FROM ' . self::$privateSessionsTable . ' WHERE proom_id = %s AND disconnected < %s',
                 array('integer', 'integer'),
                 array($sub_room, time())
             );
         } else {
             $DIC->database()->queryF(
                 'DELETE FROM ' . self::$sessionTable . ' WHERE room_id = %s AND disconnected < %s',
                 array('integer', 'integer'),
                 array($this->roomId, time())
             );
         }
     }

◆ closePrivateRoom()

ilChatroom::closePrivateRoom ( $id )

Definition at line 930 of file class.ilChatroom.php.

References $DIC, $id, array, and time.

     {
         global $DIC;
 
         $DIC->database()->manipulateF(
             'UPDATE ' . self::$privateRoomsTable . ' SET closed = %s WHERE proom_id = %s',
             array('integer', 'integer'),
             array(time(), $id)
         );
     }

◆ connectUser()

ilChatroom::connectUser ( ilChatroomUser $user )

Connects user by inserting userdata into userTable.

Checks if user is already connected by using the given $user object for selecting the userId from userTable. If no entry is found, matching userId and roomId, the userdata is inserted into the userTable to connect the user.

Parameters

ilChatroomUser $user

Returns: boolean

Definition at line 437 of file class.ilChatroom.php.

References $DIC, $query, $userdata, array, ilChatroomUser\getUserId(), ilChatroomUser\getUsername(), and time.

     {
         global $DIC;
 
         $userdata = array(
             'login' => $user->getUsername(),
             'id'    => $user->getUserId()
         );
 
         $query  = 'SELECT user_id FROM ' . self::$userTable . ' WHERE room_id = %s AND user_id = %s';
         $types  = array('integer', 'integer');
         $values = array($this->roomId, $user->getUserId());
 
         if (!$DIC->database()->fetchAssoc($DIC->database()->queryF($query, $types, $values))) {
             // Notice: Using replace instead of insert looks strange, because we actually know whether the selected data exists or not
             // But we occasionally found some duplicate key errors although the data set should not exist when the following code is reached
             $DIC->database()->replace(
                 self::$userTable,
                 array(
                     'room_id' => array('integer', $this->roomId),
                     'user_id' => array('integer', $user->getUserId())
                 ),
                 array(
                     'userdata'  => array('text', json_encode($userdata)),
                     'connected' => array('integer', time()),
                 )
             );
 
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

◆ countActiveUsers()

ilChatroom::countActiveUsers ( )

Definition at line 1192 of file class.ilChatroom.php.

References $DIC, $query, $row, and array.

     {
         global $DIC;
 
         $query = 'SELECT count(user_id) as cnt FROM ' . self::$userTable .
             ' WHERE room_id = %s';
 
         $types  = array('integer');
         $values = array($this->roomId);
         $rset   = $DIC->database()->queryF($query, $types, $values);
 
         if ($rset && ($row = $DIC->database()->fetchAssoc($rset)) && $row['cnt'] == 1) {
             return $row['cnt'];
         }
 
         return 0;
     }

◆ disconnectAllUsersFromAllRooms()

static ilChatroom::disconnectAllUsersFromAllRooms ( )

static

Deletes all entrys from userTable.

Todo:: nicht nur löschen, auch in Session Tabelle nachpflegen

Definition at line 223 of file class.ilChatroom.php.

References $DIC, and time.

Referenced by ilChatroomServerHandler\serverStarted().

     {
         global $DIC;
 
         $DIC->database()->manipulate('DELETE FROM ' . self::$userTable);
         $DIC->database()->manipulate('UPDATE ' . self::$privateRoomsTable . ' SET closed = ' . $DIC->database()->quote(time(), 'integer') . ' WHERE closed = 0 OR closed IS NULL');
         $DIC->database()->manipulate('UPDATE ' . self::$privateSessionsTable . ' SET disconnected = ' . $DIC->database()->quote(time(), 'integer') . ' WHERE disconnected = 0');
     }

Here is the caller graph for this function:

◆ disconnectUser()

ilChatroom::disconnectUser ( $user_id )

Creates userId array by given $user object and calls disconnectUsers method.

Parameters

int $user_id

Definition at line 500 of file class.ilChatroom.php.

References array, and disconnectUsers().

     {
         $this->disconnectUsers(array($user_id));
     }

Here is the call graph for this function:

◆ disconnectUsers()

ilChatroom::disconnectUsers ( array $userIds )

Disconnects users by deleting userdata from userTable using given userId array.

Deletes entrys from userTable, matching roomId and userId if existing and inserts userdata and disconnection time into sessionTable.

Parameters

array $userIds

Definition at line 511 of file class.ilChatroom.php.

References $DIC, $id, $query, $row, array, getSetting(), and time.

Referenced by disconnectUser().

     {
         global $DIC;
 
         $query = 'SELECT * FROM ' . self::$userTable . ' WHERE room_id = %s AND ' .
             $DIC->database()->in('user_id', $userIds, false, 'integer');
 
         $types  = array('integer');
         $values = array($this->roomId);
         $rset   = $DIC->database()->queryF($query, $types, $values);
 
         if ($row = $DIC->database()->fetchAssoc($rset)) {
             $query       = 'SELECT proom_id FROM ' . self::$privateRoomsTable . ' WHERE parent_id = %s';
             $rset_prooms = $DIC->database()->queryF($query, array('integer'), array($this->roomId));
 
             $prooms = array();
 
             while ($row_prooms = $DIC->database()->fetchAssoc($rset_prooms)) {
                 $prooms[] = $row_prooms['proom_id'];
             }
 
             if (true || $this->getSetting('enable_history')) {
                 $query = 'UPDATE ' . self::$privateSessionsTable . ' SET disconnected = %s WHERE ' . $DIC->database()->in('user_id', $userIds, false, 'integer') . ' AND ' . $DIC->database()->in('proom_id', $prooms, false, 'integer');
                 $DIC->database()->manipulateF($query, array('integer'), array(time()));
             } else {
                 $query = 'DELETE FROM ' . self::$privateSessionsTable . ' WHERE ' . $DIC->database()->in('user_id', $userIds, false, 'integer') . ' AND ' . $DIC->database()->in('proom_id', $prooms, false, 'integer');
                 $DIC->database()->manipulate($query);
             }
 
             $query = 'DELETE FROM ' . self::$userTable . ' WHERE room_id = %s AND ' .
                 $DIC->database()->in('user_id', $userIds, false, 'integer');
 
             $types  = array('integer');
             $values = array($this->roomId);
             $DIC->database()->manipulateF($query, $types, $values);
 
             do {
                 if ($this->getSetting('enable_history')) {
                     $id = $DIC->database()->nextId(self::$sessionTable);
                     $DIC->database()->insert(
                         self::$sessionTable,
                         array(
                             'sess_id'      => array('integer', $id),
                             'room_id'      => array('integer', $this->roomId),
                             'user_id'      => array('integer', $row['user_id']),
                             'userdata'     => array('text', $row['userdata']),
                             'connected'    => array('integer', $row['connected']),
                             'disconnected' => array('integer', time())
                         )
                     );
                 }
             } while ($row = $DIC->database()->fetchAssoc($rset));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findDeletablePrivateRooms()

static ilChatroom::findDeletablePrivateRooms ( )

static

Definition at line 235 of file class.ilChatroom.php.

References $DIC, $query, $row, array, and time.

Referenced by ilChatroomServerHandler\cleanupPrivateRooms().

     {
         global $DIC;
 
         $query = '
                         SELECT private_rooms.proom_id id, MIN(disconnected) min_disconnected, MAX(disconnected) max_disconnected
                         FROM ' . self::$privateSessionsTable . ' private_sessions
                         INNER JOIN ' . self::$privateRoomsTable . ' private_rooms
                                 ON private_sessions.proom_id = private_rooms.proom_id
                         WHERE closed = 0
                         GROUP BY private_rooms.proom_id
                         HAVING MIN(disconnected) > 0 AND MAX(disconnected) < %s';
         $rset  = $DIC->database()->queryF(
             $query,
             array('integer'),
             array(time() + 60 * 5)
         );
 
         $rooms = array();
 
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $rooms[$row['id']] = $row['id'];
         }
 
         $query = 'SELECT DISTINCT proom_id, room_id, object_id FROM ' . self::$privateRoomsTable
             . ' INNER JOIN ' . self::$settingsTable . ' ON parent_id = room_id '
             . ' WHERE ' . $DIC->database()->in('proom_id', $rooms, false, 'integer');
 
         $rset  = $DIC->database()->query($query);
         $rooms = array();
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $rooms[] = array(
                 'proom_id'  => $row['proom_id'],
                 'room_id'   => $row['room_id'],
                 'object_id' => $row['object_id']
             );
         }
 
         return $rooms;
     }

Here is the caller graph for this function:

◆ getActivePrivateRooms()

ilChatroom::getActivePrivateRooms ( $userid )

Definition at line 1091 of file class.ilChatroom.php.

References $DIC, $query, $row, $userid, array, and listUsersInPrivateRoom().

     {
         global $DIC;
 
         $query  = '
                         SELECT roomtable.title, roomtable.proom_id, accesstable.user_id id, roomtable.owner rowner
                         FROM ' . self::$privateRoomsTable . ' roomtable
                         LEFT JOIN ' . self::$privateRoomsAccessTable . ' accesstable
                         ON roomtable.proom_id = accesstable.proom_id
                         AND accesstable.user_id = %s
                         WHERE parent_id = %s
                         AND (closed = 0 OR closed IS NULL)
                         AND (accesstable.user_id IS NOT NULL OR roomtable.owner = %s)';
         $types  = array('integer', 'integer', 'integer');
         $values = array($userid, $this->roomId, $userid);
         $rset   = $DIC->database()->queryF($query, $types, $values);
         $rooms  = array();
 
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $row['active_users']     = $this->listUsersInPrivateRoom($row['id']);
             $row['owner']            = $row['rowner'];
             $rooms[$row['proom_id']] = $row;
         }
 
         return $rooms;
     }

Here is the call graph for this function:

◆ getAllRooms()

ilChatroom::getAllRooms ( $user_id )

Fetches and returns the object ids of all rooms accessible by the user with $user_id.

Parameters

integer $user_id

Returns: array

Definition at line 1281 of file class.ilChatroom.php.

References $DIC, $query, $res, $row, and array.

     {
         global $DIC;
 
         $query = "
        SELECT      room_id, od.title
        FROM        object_data od
 
        INNER JOIN  " . self::$settingsTable . "
            ON      object_id = od.obj_id
 
        INNER JOIN  " . self::$privateRoomsTable . " prt
            ON      prt.owner = %s
 
        WHERE       od.type = 'chtr'
        ";
 
         $types  = array('integer');
         $values = array($user_id);
 
         $res = $DIC->database()->queryF($query, $types, $values);
 
         $rooms = array();
 
         while ($row = $DIC->database()->fetchAssoc($res)) {
             $room_id         = $row['room_id'];
             $rooms[$room_id] = $row['title'];
         }
 
         return $rooms;
     }

◆ getBannedUsers()

ilChatroom::getBannedUsers ( )

Returns an multidimensional array containing userdata from users having an entry in banTable with matching roomId.

Returns: array

Definition at line 827 of file class.ilChatroom.php.

References $DIC, $query, $result, $row, $userdata, array, and getRoomId().

     {
         global $DIC;
 
         $query  = 'SELECT chb.* FROM ' . self::$banTable . ' chb INNER JOIN usr_data ud ON chb.user_id = ud.usr_id WHERE chb.room_id = %s ';
         $types  = array('integer');
         $values = array($this->getRoomId());
         $rset   = $DIC->database()->queryF($query, $types, $values);
         $result = array();
 
         if ($rset) {
             while ($row = $DIC->database()->fetchAssoc($rset)) {
                 if ($row['user_id'] > 0) {
                     $user     = new ilObjUser($row['user_id']);
                     $userdata = array(
                         'user_id'   => $user->getId(),
                         'firstname' => $user->getFirstname(),
                         'lastname'  => $user->getLastname(),
                         'login'     => $user->getLogin(),
                         'timestamp' => $row['timestamp'],
                         'actor_id'  => $row['actor_id'],
                         'remark'    => $row['remark']
                     );
 
                     $result[] = $userdata;
                 }
             }
         }
 
         return $result;
     }

Here is the call graph for this function:

◆ getChatURL()

ilChatroom::getChatURL	(	$gui,
		$scope_id = `0`
	)

Parameters

	$gui
integer	$scope_id

Returns: string

Definition at line 1028 of file class.ilChatroom.php.

References $url, and ilLink\_getStaticLink().

Referenced by isOwnerOfPrivateRoom().

     {
         include_once 'Services/Link/classes/class.ilLink.php';
 
         $url = '';
 
         if (is_object($gui)) {
             if ($scope_id) {
                 $url = ilLink::_getStaticLink($gui->object->getRefId(), $gui->object->getType(), true, '_' . $scope_id);
             } else {
                 $url = ilLink::_getStaticLink($gui->object->getRefId(), $gui->object->getType());
             }
         }
 
         return $url;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConnectedUsers()

ilChatroom::getConnectedUsers ( $only_data = true )

Returns an array of connected users.

Returns an array of user objects containing all users having an entry in userTable, matching the roomId.

Parameters

bool $only_data

Returns: array

Definition at line 478 of file class.ilChatroom.php.

References $DIC, $query, $row, $users, and array.

     {
         global $DIC;
 
         $query  = 'SELECT ' . ($only_data ? 'userdata' : '*') . ' FROM ' . self::$userTable . ' WHERE room_id = %s';
         $types  = array('integer');
         $values = array($this->roomId);
         $rset   = $DIC->database()->queryF($query, $types, $values);
         $users  = array();
 
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $users[] = $only_data ? json_decode($row['userdata']) : $row;
         }
 
         return $users;
     }

◆ getDescription()

ilChatroom::getDescription ( )

Definition at line 317 of file class.ilChatroom.php.

References ilObjectFactory\getInstanceByObjId(), and getSetting().

     {
         if (!$this->object) {
             $this->object = ilObjectFactory::getInstanceByObjId($this->getSetting('object_id'));
         }
 
         return $this->object->getDescription();
     }

Here is the call graph for this function:

◆ getHistory()

ilChatroom::getHistory	(	ilDateTime	$from = `null`,
		ilDateTime	$to = `null`,
			$restricted_session_userid = `null`,
			$proom_id = `0`,
			$respect_target = `true`
	)

Returns array containing history data selected from historyTable by given ilDateTime, $restricted_session_userid and matching roomId.

Parameters

ilDateTime	$from
ilDateTime	$to
integer	$restricted_session_userid
bool	$respect_target

Returns: array

Definition at line 637 of file class.ilChatroom.php.

References $DIC, $from, $message, $query, $result, $row, array, and getRoomId().

     {
         global $DIC;
 
         $join = '';
 
         if ($proom_id) {
             $join .=
                 'INNER JOIN ' . self::$privateSessionsTable . ' pSessionTable ' .
                 'ON pSessionTable.user_id = ' . $DIC->database()->quote($restricted_session_userid, 'integer') . ' ' .
                 'AND pSessionTable.proom_id = historyTable.sub_room ' .
                 'AND timestamp >= pSessionTable.connected ' .
                 'AND timestamp <= pSessionTable.disconnected ';
         }
 
         $query =
             'SELECT historyTable.* ' .
             'FROM ' . self::$historyTable . ' historyTable ' . $join . ' ' .
             'WHERE historyTable.room_id = ' . $this->getRoomId();
 
         if ($proom_id !== null) {
             $query .= ' AND historyTable.sub_room = ' . $DIC->database()->quote($proom_id, 'integer');
         }
 
         $filter = array();
 
         if ($from != null) {
             $filter[] = 'timestamp >= ' . $DIC->database()->quote($from->getUnixTime(), 'integer');
         }
 
         if ($to != null) {
             $filter[] = 'timestamp <= ' . $DIC->database()->quote($to->getUnixTime(), 'integer');
         }
 
         if ($filter) {
             $query .= ' AND ' . join(' AND ', $filter);
         }
         $query .= ' ORDER BY timestamp ASC';
 
         $rset   = $DIC->database()->query($query);
         $result = array();
 
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $message = json_decode($row['message']);
             if ($message === null) {
                 $message = json_decode('{}');
             }
 
             $row['message']            =  $message;
             $row['message']->timestamp = $row['timestamp'];
             if (
                 $respect_target &&
                 $row['message']->target !== null &&
                 !$row['message']->target->public &&
                 !in_array($DIC->user()->getId(), explode(',', $row['recipients']))
             ) {
                 continue;
             }
 
             $result[] = $row;
         }
         return $result;
     }

Here is the call graph for this function:

◆ getLastMessages()

ilChatroom::getLastMessages	(	$number,
		$chatuser = `null`
	)

Definition at line 1377 of file class.ilChatroom.php.

References $DIC, $results, $row, and array.

Referenced by getLastMessagesForChatViewer().

     {
         global $DIC;
 
         // There is currently no way to check if a message is private or not
         // by sql. So we fetch twice as much as we need and hope that there
         // are not more than $number private messages.
         $DIC->database()->setLimit($number);
         $rset = $DIC->database()->query(
             'SELECT *
                         FROM ' . self::$historyTable . '
                         WHERE room_id = ' . $DIC->database()->quote($this->roomId, 'integer') . '
                         AND sub_room = 0
                         AND (
                                 (' . $DIC->database()->like('message', 'text', '%"type":"message"%') . ' AND NOT ' . $DIC->database()->like('message', 'text', '%"public":0%') . ')
                                 OR ' . $DIC->database()->like('message', 'text', '%"target":{%"id":"' . $chatuser->getUserId() . '"%') . '
                                 OR ' . $DIC->database()->like('message', 'text', '%"from":{"id":' . $chatuser->getUserId() . '%') . '
                         )
                         ORDER BY timestamp DESC'
         );
 
         $result_count = 0;
         $results      = array();
         while (($row = $DIC->database()->fetchAssoc($rset)) && $result_count < $number) {
             $tmp = json_decode($row['message']);
             if ($chatuser !== null && $tmp->target != null && $tmp->target->public == 0) {
                 if ($chatuser->getUserId() == $tmp->target->id || $chatuser->getUserId() == $tmp->from->id) {
                     $results[] = $tmp;
                     ++$result_count;
                 }
             } else {
                 $results[] = $tmp;
                 ++$result_count;
             }
         }
 
         $rset = $DIC->database()->query(
             'SELECT *
                         FROM ' . self::$historyTable . '
                         WHERE room_id = ' . $DIC->database()->quote($this->roomId, 'integer') . '
                         AND sub_room = 0
                         AND ' . $DIC->database()->like('message', 'text', '%"type":"notice"%') . '
                         AND timestamp <= ' . $DIC->database()->quote($results[0]->timestamp, 'integer') . ' AND timestamp >= ' . $DIC->database()->quote($results[$result_count - 1]->timestamp, 'integer') . '
 
                         ORDER BY timestamp DESC'
         );
 
         while (($row = $DIC->database()->fetchAssoc($rset))) {
             $tmp       = json_decode($row['message']);
             $results[] = $tmp;
         }
 
         \usort($results, function ($a, $b) {
             $a_timestamp = strlen($a->timestamp) == 13 ? substr($a->timestamp, 0, -3) : $a->timestamp;
             $b_timestamp = strlen($b->timestamp) == 13 ? substr($b->timestamp, 0, -3) : $b->timestamp;
 
             return $b_timestamp - $a_timestamp;
         });
 
         return $results;
     }

Here is the caller graph for this function:

◆ getLastMessagesForChatViewer()

ilChatroom::getLastMessagesForChatViewer	(	$number,
		$chatuser = `null`
	)

Definition at line 1372 of file class.ilChatroom.php.

References getLastMessages().

Referenced by ilChatroomBlock\getMessages().

     {
         return $this->getLastMessages($number, $chatuser);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastSession()

ilChatroom::getLastSession ( ilChatroomUser $user )

Returns last session from user.

Returns row from sessionTable where user_id matches userId from given $user object.

Parameters

ilChatroomUser $user

Returns: array

Definition at line 866 of file class.ilChatroom.php.

References $DIC, $query, $row, and ilChatroomUser\getUserId().

     {
         global $DIC;
 
         $query = 'SELECT * FROM ' . self::$sessionTable . ' WHERE user_id = ' .
             $DIC->database()->quote($user->getUserId(), 'integer') .
             ' ORDER BY connected DESC';
 
         $DIC->database()->setLimit(1);
         $rset = $DIC->database()->query($query);
 
         if ($row = $DIC->database()->fetchAssoc($rset)) {
             return $row;
         }
     }

Here is the call graph for this function:

◆ getPrivateRooms()

ilChatroom::getPrivateRooms ( )

Definition at line 1210 of file class.ilChatroom.php.

References $DIC, $query, $row, and array.

     {
         global $DIC;
 
         $query = 'SELECT * FROM ' . self::$privateRoomsTable . ' WHERE parent_id = %s';
         $rset  = $DIC->database()->queryF($query, array('integer'), array($this->roomId));
 
         $rooms = array();
 
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $rooms[] = $row;
         }
 
         return $rooms;
     }

◆ getPrivateRoomSessions()

ilChatroom::getPrivateRoomSessions	(	ilDateTime	$from = `null`,
		ilDateTime	$to = `null`,
			$user_id = `0`,
			$room_id = `0`
	)

Definition at line 710 of file class.ilChatroom.php.

References $DIC, $from, $query, $result, $row, and array.

     {
         global $DIC;
 
         $query = 'SELECT proom_id, title FROM ' . self::$privateRoomsTable . ' WHERE proom_id IN (
                         SELECT proom_id FROM ' . self::$privateSessionsTable . ' WHERE connected >= %s AND disconnected <= %s AND user_id = %s
 
                 ) AND parent_id = %s';
 
         $rset   = $DIC->database()->queryF($query, array('integer', 'integer', 'integer', 'integer'), array($from->getUnixTime(), $to->getUnixTime(), $user_id, $room_id));
         $result = array();
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $result[] = $row;
         }
         return $result;
     }

◆ getPrivateSubRooms()

ilChatroom::getPrivateSubRooms	(	$parent_room,
		$user_id
	)

Definition at line 1313 of file class.ilChatroom.php.

References $DIC, $query, $res, $row, and array.

     {
         global $DIC;
 
         $query = "
        SELECT      proom_id, parent_id
        FROM        chatroom_prooms
        WHERE       parent_id = %s
        AND     owner = %s
        AND     closed = 0
        ";
 
         $types  = array('integer', 'integer');
         $values = array($parent_room, $user_id);
 
         $res = $DIC->database()->queryF($query, $types, $values);
 
         $priv_rooms = array();
 
         while ($row = $DIC->database()->fetchAssoc($res)) {
             $proom_id              = $row['proom_id'];
             $priv_rooms[$proom_id] = $row['parent_id'];
         }
 
         return $priv_rooms;
     }

◆ getPrivilegedUsersForPrivateRoom()

ilChatroom::getPrivilegedUsersForPrivateRoom ( $subRoomId )

Parameters

int $subRoomId

Returns: int[]

Definition at line 1230 of file class.ilChatroom.php.

References $DIC, $query, $row, and array.

     {
         global $DIC;
 
         $query = 'SELECT user_id FROM ' . self::$privateRoomsAccessTable . ' WHERE proom_id = %s';
         $rset  = $DIC->database()->queryF($query, array('integer'), array($subRoomId));
 
         $userIds = array();
 
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $userIds[] = $row['user_id'];
         }
 
         return $userIds;
     }

◆ getRefIdByRoomId()

ilChatroom::getRefIdByRoomId ( $room_id )

Returns ref_id of given room_id.

Parameters

integer $room_id

Returns: integer

Definition at line 1345 of file class.ilChatroom.php.

References $DIC, $query, $res, $row, and array.

     {
         global $DIC;
 
         $query = "
        SELECT      objr.ref_id
        FROM        object_reference    objr
 
        INNER JOIN  chatroom_settings   cs
            ON      cs.object_id = objr.obj_id
 
        INNER JOIN  object_data     od
            ON      od.obj_id = cs.object_id
 
        WHERE       cs.room_id = %s
        ";
 
         $types  = array('integer');
         $values = array($room_id);
 
         $res = $DIC->database()->queryF($query, $types, $values);
 
         $row = $DIC->database()->fetchAssoc($res);
 
         return $row['ref_id'];
     }

◆ getRoomId()

ilChatroom::getRoomId ( )

Returns roomID from $this->roomId.

Returns: integer

Definition at line 705 of file class.ilChatroom.php.

References $roomId.

Referenced by getBannedUsers(), getHistory(), getSessions(), isUserBanned(), ilChatroomViewGUI\renderFileUploadForm(), and unbanUser().

     {
         return $this->roomId;
     }

Here is the caller graph for this function:

◆ getSessions()

ilChatroom::getSessions ( ilChatroomUser $user )

Returns all session from user Returns all from sessionTable where user_id matches userId from given $user object.

Parameters

ilChatroomUser $user

Returns: array

Definition at line 889 of file class.ilChatroom.php.

References $DIC, $query, $result, $row, array, and getRoomId().

     {
         global $DIC;
 
         $query = 'SELECT * FROM ' . self::$sessionTable
             . ' WHERE room_id = ' .
             $DIC->database()->quote($this->getRoomId(), 'integer') .
             ' ORDER BY connected DESC';
 
         $rset = $DIC->database()->query($query);
 
         $result = array();
 
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $result[] = $row;
         }
 
         return $result;
     }

Here is the call graph for this function:

◆ getSetting()

ilChatroom::getSetting ( $name )

Returns setting from $this->settings array by given name.

Parameters

string $name

Returns: mixed

Definition at line 331 of file class.ilChatroom.php.

References $name, and settings().

Referenced by disconnectUsers(), getDescription(), ilChatroomBlock\getMessages(), getTitle(), and ilChatroomViewGUI\renderFileUploadForm().

     {
         return $this->settings[$name];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettings()

ilChatroom::getSettings ( )

Returns $this->settings array.

Returns: array

Definition at line 570 of file class.ilChatroom.php.

References $settings.

     {
         return $this->settings;
     }

◆ getTitle()

ilChatroom::getTitle ( )

Definition at line 1045 of file class.ilChatroom.php.

References ilObjectFactory\getInstanceByObjId(), and getSetting().

Referenced by isOwnerOfPrivateRoom().

     {
         if (!$this->object) {
             $this->object = ilObjectFactory::getInstanceByObjId($this->getSetting('object_id'));
         }
 
         return $this->object->getTitle();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUniquePrivateRoomTitle()

ilChatroom::getUniquePrivateRoomTitle ( $title )

Definition at line 1246 of file class.ilChatroom.php.

References $DIC, $i, $query, $row, $title, and array.

Referenced by ilChatroomViewGUI\renderFileUploadForm().

     {
         global $DIC;
 
         $query = 'SELECT title FROM ' . self::$privateRoomsTable . ' WHERE parent_id = %s and closed = 0';
         $rset  = $DIC->database()->queryF($query, array('integer'), array($this->roomId));
 
         $titles = array();
 
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $titles[] = $row['title'];
         }
 
         $suffix = '';
         $i      = 0;
         do {
             if (!in_array($title . $suffix, $titles)) {
                 $title .= $suffix;
                 break;
             }
 
             ++$i;
 
             $suffix = ' (' . $i . ')';
         } while (true);
 
         return $title;
     }

Here is the caller graph for this function:

◆ getUntrashedChatReferences()

static ilChatroom::getUntrashedChatReferences ( $filter = array() )

static

Definition at line 276 of file class.ilChatroom.php.

References $DIC, $query, $res, $row, and array.

Referenced by ilChatroomBlock\getReadableAreas().

     {
         global $DIC;
 
         // Check for parent because of an invalid parent node for the old public chat (thx @ jposselt ;-)).
         // We cannot find this old public chat and clean this automatically
         $query = '
                         SELECT od.obj_id, od.title, ore.ref_id, od.type, odp.title parent_title
                         FROM object_data od
                         INNER JOIN object_reference ore ON ore.obj_id = od.obj_id
                         INNER JOIN tree t ON t.child = ore.ref_id
                         INNER JOIN tree p ON p.child = t.parent
                         INNER JOIN object_reference orep ON orep.ref_id = p.child
                         INNER JOIN object_data odp ON odp.obj_id = orep.obj_id
                         INNER JOIN object_reference pre ON pre.ref_id = t.parent
                         INNER JOIN object_data pod ON pod.obj_id = pre.obj_id
                 ';
 
         if (isset($filter['last_activity'])) {
             $threshold = $DIC->database()->quote($filter['last_activity'], 'integer');
             $query .= "
                                 INNER JOIN chatroom_settings ON chatroom_settings.object_id = od.obj_id
                                 INNER JOIN chatroom_history ON chatroom_history.room_id = chatroom_settings.room_id AND chatroom_history.timestamp > $threshold
                         ";
         }
 
         $query .= '
                         WHERE od.type = %s AND t.tree > 0 AND ore.deleted IS NULL
                         GROUP BY od.obj_id, od.title, ore.ref_id, od.type, odp.title
                         ORDER BY od.title
                 ';
         $res = $DIC->database()->queryF($query, array('text'), array('chtr'));
 
         $chats = array();
         while ($row = $DIC->database()->fetchAssoc($res)) {
             $chats[] = $row;
         }
 
         return $chats;
     }

Here is the caller graph for this function:

◆ initialize()

ilChatroom::initialize ( array $rowdata )

Sets $this->roomId by given array $rowdata and calls setSetting method foreach available setting in $this->availableSettings.

Parameters

array $rowdata

Definition at line 170 of file class.ilChatroom.php.

References $type, and setSetting().

     {
         $this->roomId = $rowdata['room_id'];
 
         foreach ($this->availableSettings as $setting => $type) {
             if (isset($rowdata[$setting])) {
                 settype($rowdata[$setting], $this->availableSettings[$setting]);
                 $this->setSetting($setting, $rowdata[$setting]);
             }
         }
     }

Here is the call graph for this function:

◆ inviteUserToPrivateRoom()

ilChatroom::inviteUserToPrivateRoom	(	$user_id,
		$proom_id
	)

Parameters

int	$user_id
int	$proom_id

Definition at line 1081 of file class.ilChatroom.php.

References $DIC, and array.

Referenced by inviteUserToPrivateRoomByLogin(), and ilChatroomViewGUI\renderFileUploadForm().

     {
         global $DIC;
 
         $DIC->database()->replace(self::$privateRoomsAccessTable, array(
             'user_id'  => array('integer', $user_id),
             'proom_id' => array('integer', $proom_id)
         ), array());
     }

Here is the caller graph for this function:

◆ inviteUserToPrivateRoomByLogin()

ilChatroom::inviteUserToPrivateRoomByLogin	(	$login,
		$proom_id
	)

Definition at line 1071 of file class.ilChatroom.php.

References ilObjUser\_lookupId(), and inviteUserToPrivateRoom().

     {
         $user_id = ilObjUser::_lookupId($login);
         $this->inviteUserToPrivateRoom($user_id, $proom_id);
     }

Here is the call graph for this function:

◆ isAllowedToEnterPrivateRoom()

ilChatroom::isAllowedToEnterPrivateRoom	(	$chat_userid,
		$proom_id
	)

Definition at line 599 of file class.ilChatroom.php.

References $DIC, $query, $row, and array.

     {
         global $DIC;
 
         $query = 'SELECT count(user_id) cnt FROM ' . self::$privateRoomsAccessTable .
             ' WHERE proom_id = %s AND user_id = %s';
 
         $types  = array('integer', 'integer');
         $values = array($proom_id, $chat_userid);
         $rset   = $DIC->database()->queryF($query, $types, $values);
 
         if ($rset && ($row = $DIC->database()->fetchAssoc($rset)) && $row['cnt'] == 1) {
             return true;
         }
 
         $query = 'SELECT count(*) cnt FROM ' . self::$privateRoomsTable .
             ' WHERE proom_id = %s AND owner = %s';
 
         $types  = array('integer', 'integer');
         $values = array($proom_id, $chat_userid);
         $rset   = $DIC->database()->queryF($query, $types, $values);
 
         if ($rset && ($row = $DIC->database()->fetchAssoc($rset)) && $row['cnt'] == 1) {
             return true;
         }
 
         return false;
     }

◆ isOwnerOfPrivateRoom()

ilChatroom::isOwnerOfPrivateRoom	(	$user_id,
		$proom_id
	)

Definition at line 941 of file class.ilChatroom.php.

References $DIC, $query, ilLanguageFactory\_getLanguageOfUser(), array, ilNotificationConfig\DEFAULT_TTS, getChatURL(), ilObjectFactory\getInstanceByObjId(), ilMail\getSalutation(), getTitle(), and ilNotificationConfig\TTL_LONG.

     {
         global $DIC;
 
         $query  = 'SELECT proom_id FROM ' . self::$privateRoomsTable . ' WHERE proom_id = %s AND owner = %s';
         $types  = array('integer', 'integer');
         $values = array($proom_id, $user_id);
 
         $rset = $DIC->database()->queryF($query, $types, $values);
 
         if ($rset && $DIC->database()->fetchAssoc($rset)) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ isSubscribed()

ilChatroom::isSubscribed ( $chat_userid )

Returns true if entry exists in userTable matching given $chat_userid and $this->roomId.

Parameters

integer $chat_userid

Returns: boolean

Definition at line 581 of file class.ilChatroom.php.

References $DIC, $query, $row, and array.

Referenced by ilChatroomViewGUI\renderFileUploadForm().

     {
         global $DIC;
 
         $query = 'SELECT count(user_id) as cnt FROM ' . self::$userTable .
             ' WHERE room_id = %s AND user_id = %s';
 
         $types  = array('integer', 'integer');
         $values = array($this->roomId, $chat_userid);
         $rset   = $DIC->database()->queryF($query, $types, $values);
 
         if ($rset && ($row = $DIC->database()->fetchAssoc($rset)) && $row['cnt'] == 1) {
             return true;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ isUserBanned()

ilChatroom::isUserBanned ( $user_id )

Returns true if there's an entry in banTable matching roomId and given $user_id.

Parameters

integer $user_id

Returns: boolean

Definition at line 804 of file class.ilChatroom.php.

References $DIC, $query, $row, array, and getRoomId().

     {
         global $DIC;
 
         $query = 'SELECT COUNT(user_id) cnt FROM ' . self::$banTable . ' WHERE user_id = %s AND room_id = %s';
 
         $types  = array('integer', 'integer');
         $values = array($user_id, $this->getRoomId());
 
         $rset = $DIC->database()->queryF($query, $types, $values);
 
         if ($rset && ($row = $DIC->database()->fetchAssoc($rset)) && $row['cnt']) {
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

◆ listUsersInPrivateRoom()

ilChatroom::listUsersInPrivateRoom ( $private_room_id )

Definition at line 1118 of file class.ilChatroom.php.

References $DIC, $query, $row, $users, and array.

Referenced by getActivePrivateRooms().

     {
         global $DIC;
 
         $query  = '
                         SELECT chatroom_users.user_id FROM ' . self::$privateSessionsTable . '
                         INNER JOIN chatroom_users ON chatroom_users.user_id = ' . self::$privateSessionsTable . '.user_id WHERE proom_id = %s AND disconnected = 0
                 ';
         $types  = array('integer');
         $values = array($private_room_id);
         $rset   = $DIC->database()->queryF($query, $types, $values);
 
         $users = array();
 
         while ($row = $DIC->database()->fetchAssoc($rset)) {
             $users[$row['user_id']] = $row['user_id'];
         }
 
         return array_values($users);
     }

Here is the caller graph for this function:

◆ lookupPrivateRoomTitle()

static ilChatroom::lookupPrivateRoomTitle ( $proom_id )

static

Definition at line 1054 of file class.ilChatroom.php.

References $DIC, $query, $row, and array.

Referenced by ilContactGUI\inviteToChat().

     {
         global $DIC;
 
         $query  = 'SELECT title FROM ' . self::$privateRoomsTable . ' WHERE proom_id = %s';
         $types  = array('integer');
         $values = array($proom_id);
 
         $rset = $DIC->database()->queryF($query, $types, $values);
 
         if ($row = $DIC->database()->fetchAssoc($rset)) {
             return $row['title'];
         }
 
         return 'unkown';
     }

Here is the caller graph for this function:

◆ phpTypeToMDBType()

ilChatroom::phpTypeToMDBType ( $type )

private

Definition at line 384 of file class.ilChatroom.php.

References $type.

Referenced by saveSettings().

     {
         switch ($type) {
             case 'string':
                 return 'text';
             default:
                 return $type;
         }
     }

Here is the caller graph for this function:

◆ save()

ilChatroom::save ( )

Saves settings using $this->settings.

Definition at line 339 of file class.ilChatroom.php.

References saveSettings(), and settings().

     {
         $this->saveSettings($this->settings);
     }

Here is the call graph for this function:

◆ saveFileUploadToDb()

ilChatroom::saveFileUploadToDb	(	$user_id,
		$filename,
		$type
	)

Saves information about file uploads in DB.

Parameters

integer	$user_id
string	$filename
string	$type

Definition at line 733 of file class.ilChatroom.php.

References $DIC, $filename, $type, array, and time.

     {
         global $DIC;
 
         $upload_id = $DIC->database()->nextId(self::$uploadTable);
 
         $DIC->database()->insert(
             self::$uploadTable,
             array(
                 'upload_id' => array('integer', $upload_id),
                 'room_id'   => array('integer', $this->roomId),
                 'user_id'   => array('integer', $user_id),
                 'filename'  => array('text', $filename),
                 'filetype'  => array('text', $type),
                 'timestamp' => array('integer', time())
             )
         );
     }

◆ saveSettings()

ilChatroom::saveSettings ( array $settings )

Saves settings into settingsTable using given settings array.

Parameters

array $settings

Definition at line 348 of file class.ilChatroom.php.

References $DIC, $type, array, and phpTypeToMDBType().

Referenced by save().

     {
         global $DIC;
 
         $localSettings = array();
 
         foreach ($this->availableSettings as $setting => $type) {
             if (isset($settings[$setting])) {
                 if ($type == 'boolean') {
                     $settings[$setting] = (boolean) $settings[$setting];
                 }
                 $localSettings[$setting] = array($this->phpTypeToMDBType($type), $settings[$setting]);
             }
         }
 
         if (!$localSettings['room_type'][1]) {
             $localSettings['room_type'][1] = 'repository';
         }
 
         if ($this->roomId) {
             $DIC->database()->update(
                 self::$settingsTable,
                 $localSettings,
                 array('room_id' => array('integer', $this->roomId))
             );
         } else {
             $this->roomId = $DIC->database()->nextId(self::$settingsTable);
 
             $localSettings['room_id'] = array(
                 $this->availableSettings['room_id'], $this->roomId
             );
 
             $DIC->database()->insert(self::$settingsTable, $localSettings);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSetting()

ilChatroom::setSetting	(	$name,
		$value
	)

Sets given name and value as setting into $this->settings array.

Parameters

string	$name
mixed	$value

Definition at line 187 of file class.ilChatroom.php.

References $name, and settings().

Referenced by initialize().

     {
         $this->settings[$name] = $value;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subscribeUserToPrivateRoom()

ilChatroom::subscribeUserToPrivateRoom	(	$room_id,
		$user_id
	)

Definition at line 1139 of file class.ilChatroom.php.

References $DIC, $id, array, time, and userIsInPrivateRoom().

     {
         global $DIC;
 
         if (!$this->userIsInPrivateRoom($room_id, $user_id)) {
             $id = $DIC->database()->nextId(self::$privateSessionsTable);
             $DIC->database()->insert(
                 self::$privateSessionsTable,
                 array(
                     'psess_id'     => array('integer', $id),
                     'proom_id'     => array('integer', $room_id),
                     'user_id'      => array('integer', $user_id),
                     'connected'    => array('integer', time()),
                     'disconnected' => array('integer', 0),
                 )
             );
         }
     }

Here is the call graph for this function:

◆ unbanUser()

ilChatroom::unbanUser ( $user_id )

Deletes entry from banTable matching roomId and given $user_id and returns true if sucessful.

Parameters

mixed $user_id

Returns: boolean

Definition at line 782 of file class.ilChatroom.php.

References $DIC, $query, array, and getRoomId().

     {
         global $DIC;
 
         if (!is_array($user_id)) {
             $user_id = array($user_id);
         }
 
         $query = 'DELETE FROM ' . self::$banTable . ' WHERE room_id = %s AND ' . $DIC->database()->in('user_id', $user_id, false, 'integer');
 
         $types  = array('integer');
         $values = array($this->getRoomId());
 
         return $DIC->database()->manipulateF($query, $types, $values);
     }

Here is the call graph for this function:

◆ unsubscribeUserFromPrivateRoom()

ilChatroom::unsubscribeUserFromPrivateRoom	(	$room_id,
		$user_id
	)

Parameters

integer	$room_id
integer	$user_id

Definition at line 1176 of file class.ilChatroom.php.

References $DIC, array, and time.

     {
         global $DIC;
 
         $DIC->database()->update(
             self::$privateSessionsTable,
             array(
                 'disconnected' => array('integer', time())
             ),
             array(
                 'proom_id' => array('integer', $room_id),
                 'user_id'  => array('integer', $user_id)
             )
         );
     }

◆ userIsInPrivateRoom()

ilChatroom::userIsInPrivateRoom	(	$room_id,
		$user_id
	)

Definition at line 1158 of file class.ilChatroom.php.

References $DIC, $query, and array.

Referenced by subscribeUserToPrivateRoom().

     {
         global $DIC;
 
         $query  = 'SELECT proom_id id FROM ' . self::$privateSessionsTable . ' WHERE user_id = %s AND proom_id = %s AND disconnected = 0';
         $types  = array('integer', 'integer');
         $values = array($user_id, $room_id);
         $rset   = $DIC->database()->queryF($query, $types, $values);
         if ($DIC->database()->fetchAssoc($rset)) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

Field Documentation

◆ $availableSettings

ilChatroom::$availableSettings

private

Initial value:

= array(
        'object_id'              => 'integer',
        'online_status'          => 'integer',
        'allow_anonymous'        => 'boolean',
        'allow_custom_usernames' => 'boolean',
        'enable_history'         => 'boolean',
        'restrict_history'       => 'boolean',
        'autogen_usernames'      => 'string',
        'room_type'              => 'string',
        'allow_private_rooms'    => 'integer',
        'display_past_msgs'      => 'integer',
        'private_rooms_enabled'  => 'boolean'
    )

Definition at line 28 of file class.ilChatroom.php.

◆ $banTable

ilChatroom::$banTable = 'chatroom_bans'

staticprivate

Definition at line 16 of file class.ilChatroom.php.

◆ $historyTable

ilChatroom::$historyTable = 'chatroom_history'

staticprivate

Definition at line 13 of file class.ilChatroom.php.

◆ $object

ilChatroom::$object

private

Definition at line 43 of file class.ilChatroom.php.

◆ $privateRoomsAccessTable

ilChatroom::$privateRoomsAccessTable = 'chatroom_proomaccess'

staticprivate

Definition at line 20 of file class.ilChatroom.php.

◆ $privateRoomsTable

ilChatroom::$privateRoomsTable = 'chatroom_prooms'

staticprivate

Definition at line 17 of file class.ilChatroom.php.

◆ $privateSessionsTable

ilChatroom::$privateSessionsTable = 'chatroom_psessions'

staticprivate

Definition at line 18 of file class.ilChatroom.php.

◆ $roomId

ilChatroom::$roomId

private

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

Referenced by getRoomId().

◆ $sessionTable

ilChatroom::$sessionTable = 'chatroom_sessions'

staticprivate

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

◆ $settings

ilChatroom::$settings = array()

private

Definition at line 21 of file class.ilChatroom.php.

Referenced by addPrivateRoom(), and getSettings().

◆ $settingsTable

ilChatroom::$settingsTable = 'chatroom_settings'

staticprivate

Definition at line 12 of file class.ilChatroom.php.

◆ $uploadTable

ilChatroom::$uploadTable = 'chatroom_uploads'

staticprivate

Definition at line 19 of file class.ilChatroom.php.

◆ $userTable

ilChatroom::$userTable = 'chatroom_users'

staticprivate

Definition at line 14 of file class.ilChatroom.php.

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

Modules/Chatroom/classes/class.ilChatroom.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ addHistoryEntry()

◆ addPrivateRoom()

◆ banUser()

◆ byObjectId()

◆ byRoomId()

◆ checkPermissions()

◆ checkPermissionsOfUser()

◆ checkUserPermissions()

◆ clearMessages()

◆ closePrivateRoom()

◆ connectUser()

◆ countActiveUsers()

◆ disconnectAllUsersFromAllRooms()

◆ disconnectUser()

◆ disconnectUsers()

◆ findDeletablePrivateRooms()

◆ getActivePrivateRooms()

◆ getAllRooms()

◆ getBannedUsers()

◆ getChatURL()

◆ getConnectedUsers()

◆ getDescription()

◆ getHistory()

◆ getLastMessages()

◆ getLastMessagesForChatViewer()

◆ getLastSession()

◆ getPrivateRooms()

◆ getPrivateRoomSessions()

◆ getPrivateSubRooms()

◆ getPrivilegedUsersForPrivateRoom()

◆ getRefIdByRoomId()

◆ getRoomId()

◆ getSessions()

◆ getSetting()

◆ getSettings()

◆ getTitle()

◆ getUniquePrivateRoomTitle()

◆ getUntrashedChatReferences()

◆ initialize()

◆ inviteUserToPrivateRoom()

◆ inviteUserToPrivateRoomByLogin()

◆ isAllowedToEnterPrivateRoom()

◆ isOwnerOfPrivateRoom()

◆ isSubscribed()

◆ isUserBanned()

◆ listUsersInPrivateRoom()

◆ lookupPrivateRoomTitle()

◆ phpTypeToMDBType()

◆ save()

◆ saveFileUploadToDb()

◆ saveSettings()

◆ setSetting()

◆ subscribeUserToPrivateRoom()

◆ unbanUser()

◆ unsubscribeUserFromPrivateRoom()

◆ userIsInPrivateRoom()

Field Documentation

◆ $availableSettings

◆ $banTable

◆ $historyTable

◆ $object

◆ $privateRoomsAccessTable

◆ $privateRoomsTable

◆ $privateSessionsTable

◆ $roomId

◆ $sessionTable

◆ $settings

◆ $settingsTable

◆ $uploadTable

◆ $userTable