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...

	getConnectedUsers ()
	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)
	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, $comment='')
	Inserts user into banTable, using given $user_id ilDBInterface $ilDB. 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 ilDBInterface $ilDB. 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)
	ilCtrl $ilCtrl More...

	getTitle ()

	inviteUserToPrivateRoomByLogin ($login, $proom_id)

	getActivePrivateRooms ($userid)

	listUsersInPrivateRoom ($private_room_id)

	subscribeUserToPrivateRoom ($room_id, $user_id)

	userIsInPrivateRoom ($room_id, $user_id)

	unsubscribeUserFromPrivateRoom ($room_id, $user_id)
	ilDBInterface $ilDB More...

	countActiveUsers ()

	getUniquePrivateRoomTitle ($title)

	getPrivateSubRooms ($parent_room, $user_id)

	getRefIdByRoomId ($room_id)
	Returns ref_id of given room_id ilDBInterface $ilDB. 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 ilDBInterface $ilDB. More...

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

static	findDeletablePrivateRooms ()

static	lookupPrivateRoomTitle ($proom_id)

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 ilDBInterface $ilDB

Parameters

string	$message
string	$recipient
boolean	$publicMessage

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

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

         {
                 global $ilDB;
 
                 $subRoom = 0;
                 if(is_array($message))
                 {
                         $subRoom = (int)$message['sub'];
                 }
                 else if(is_object($message))
                 {
                         $subRoom = (int)$message->sub;
                 }
 
                 $id = $ilDB->nextId(self::$historyTable);
                 $ilDB->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', time()),
                         )
                 );
         }

Here is the call graph for this function:

◆ addPrivateRoom()

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

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

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

Referenced by ilChatroomViewGUI\renderFileUploadForm().

         {
                 global $ilDB;
 
                 $nextId = $ilDB->nextId(self::$privateRoomsTable);
                 $ilDB->insert(
                         self::$privateRoomsTable,
                         array(
                                 'proom_id'  => array('integer', $nextId),
                                 'parent_id' => array('integer', $this->roomId),
                                 'title'     => array('text', $title),
                                 'owner'     => array('integer', $owner->getUserId()),
                                 'created'   => array('integer', 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,
		$comment = `''`
	)

Inserts user into banTable, using given $user_id ilDBInterface $ilDB.

Parameters

integer	$user_id
string	$comment

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

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

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

◆ byObjectId()

static ilChatroom::byObjectId ( $object_id )

static

Returns ilChatroom object by given $object_id.

ilDBInterface $ilDB

Parameters

integer $object_id

Returns: ilChatroom

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

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

Referenced by ilChatroomHistoryGUI\__construct(), ilChatroomBanGUI\active(), ilChatroomServerHandler\cleanupPrivateRooms(), ilChatroomPrivateRoomGUI\create(), ilObjChatroom\createDefaultRole(), ilChatroomPrivateRoomGUI\delete(), ilChatroomPrivateRoomGUI\enter(), ilChatroomPostMessageGUI\executeDefault(), ilChatroomInitialGUI\executeDefault(), ilChatroomKickGUI\executeDefault(), ilChatroomBanGUI\executeDefault(), ilChatroomBlockGUI\getChatroomSelectionList(), ilChatroomTabGUIFactory\getLabel(), ilChatroomGUIHandler\getRoomByObjectId(), ilObjChatroomListGUI\init(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomPrivateRoomGUI\leave(), ilChatroomPrivateRoomGUI\listUsers(), ilChatroomKickGUI\main(), ilChatroomViewGUI\renderFileUploadForm(), ilChatroomKickGUI\sub(), and ilChatroomUploadFileGUI\uploadFile().

         {
                 global $ilDB;
                 $query  = 'SELECT * FROM ' . self::$settingsTable . ' WHERE object_id = %s';
                 $types  = array('integer');
                 $values = array($object_id);
                 $rset   = $ilDB->queryF($query, $types, $values);
 
                 if($row = $ilDB->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 ilDBInterface $ilDB.

Parameters

integer $room_id

Returns: ilChatroom

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

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

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

         {
                 global $ilDB;
 
                 $query = 'SELECT * FROM ' . self::$settingsTable . ' WHERE room_id = %s';
 
                 $types  = array('integer');
                 $values = array($room_id);
 
                 $rset = $ilDB->queryF($query, $types, $values);
 
                 if($row = $ilDB->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:

◆ 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.

ilRbacSystem $rbacsystem ilLanguage $lng

Parameters

integer	$usr_id
mixed	$permissions
integer	$ref_id

Returns: boolean

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

References $lng, $ref_id, and array.

Referenced by ilChatroomKickGUI\sub(), and ilContactGUI\submitInvitation().

         {
                 global $rbacsystem, $lng;
 
                 if(!is_array($permissions))
                 {
                         $permissions = array($permissions);
                 }
 
                 foreach($permissions as $permission)
                 {
                         if(!$rbacsystem->checkAccessOfUser($usr_id, $permission, $ref_id))
                         {
                                 return false;
                         }
                 }
 
                 return true;
         }

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.

Rbacsystem $rbacsystem

Parameters

mixed	$permissions
integer	$ref_id

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

References $lng, $ref_id, array, and ilUtil\sendFailure().

Referenced by ilChatroomHistoryGUI\__construct(), ilChatroomSettingsGUI\__construct(), ilChatroomAdminViewGUI\clientsettings(), ilChatroomTabGUIFactory\convertLowerCamelCaseToUnderscoreCaseConversion(), ilChatroomPrivateRoomGUI\enter(), ilChatroomPostMessageGUI\executeDefault(), ilChatroomBanGUI\executeDefault(), ilChatroomGUIHandler\redirectIfNoPermission(), ilChatroomViewGUI\renderFileUploadForm(), ilChatroomAdminViewGUI\serversettings(), ilChatroomUploadFileGUI\uploadFile(), and ilChatroomAdminSmileyGUI\view().

         {
                 global $rbacsystem, $lng;
 
                 if(!is_array($permissions))
                 {
                         $permissions = array($permissions);
                 }
 
                 foreach($permissions as $permission)
                 {
                         if(!$rbacsystem->checkAccess($permission, $ref_id))
                         {
                                 if($send_info)
                                 {
                                         ilUtil::sendFailure($lng->txt("permission_denied"), true);
                                 }
                                 return false;
                         }
                 }
 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearMessages()

ilChatroom::clearMessages ( $sub_room )

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

References $ilDB, array, and time.

         {
                 global $ilDB;
 
                 $ilDB->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)
                 {
                         $ilDB->queryF(
                                 'DELETE FROM ' . self::$privateSessionsTable . ' WHERE proom_id = %s AND disconnected < %s',
                                 array('integer', 'integer'),
                                 array($sub_room, time())
                         );
                 }
                 else
                 {
                         $ilDB->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 942 of file class.ilChatroom.php.

References $ilDB, array, and time.

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

◆ countActiveUsers()

ilChatroom::countActiveUsers ( )

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

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

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

◆ disconnectAllUsersFromAllRooms()

static ilChatroom::disconnectAllUsersFromAllRooms ( )

static

Deletes all entrys from userTable.

ilDBInterface $ilDB

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

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

References $ilDB, and time.

Referenced by ilChatroomServerHandler\serverStarted().

         {
                 global $ilDB;
 
                 $ilDB->manipulate('DELETE FROM ' . self::$userTable);
                 $ilDB->manipulate('UPDATE ' . self::$privateRoomsTable . ' SET closed = ' . $ilDB->quote(time(), 'integer') . ' WHERE closed = 0 OR closed IS NULL');
                 $ilDB->manipulate('UPDATE ' . self::$privateSessionsTable . ' SET disconnected = ' . $ilDB->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 492 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. ilDBInterface $ilDB

Parameters

array $userIds

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

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

Referenced by disconnectUser().

         {
                 global $ilDB;
 
                 $query = 'SELECT * FROM ' . self::$userTable . ' WHERE room_id = %s AND ' .
                         $ilDB->in('user_id', $userIds, false, 'integer');
 
                 $types  = array('integer');
                 $values = array($this->roomId);
                 $rset   = $ilDB->queryF($query, $types, $values);
 
                 if($row = $ilDB->fetchAssoc($rset))
                 {
                         $query       = 'SELECT proom_id FROM ' . self::$privateRoomsTable . ' WHERE parent_id = %s';
                         $rset_prooms = $ilDB->queryF($query, array('integer'), array($this->roomId));
 
                         $prooms = array();
 
                         while($row_prooms = $ilDB->fetchAssoc($rset_prooms))
                         {
                                 $prooms[] = $row_prooms['proom_id'];
                         }
 
                         if(true || $this->getSetting('enable_history'))
                         {
                                 $query = 'UPDATE ' . self::$privateSessionsTable . ' SET disconnected = %s WHERE ' . $ilDB->in('user_id', $userIds, false, 'integer') . ' AND ' . $ilDB->in('proom_id', $prooms, false, 'integer');
                                 $ilDB->manipulateF($query, array('integer'), array(time()));
                         }
                         else
                         {
                                 $query = 'DELETE FROM ' . self::$privateSessionsTable . ' WHERE ' . $ilDB->in('user_id', $userIds, false, 'integer') . ' AND ' . $ilDB->in('proom_id', $prooms, false, 'integer');
                                 $ilDB->manipulate($query);
                         }
 
                         $query = 'DELETE FROM ' . self::$userTable . ' WHERE room_id = %s AND ' .
                                 $ilDB->in('user_id', $userIds, false, 'integer');
 
                         $types  = array('integer');
                         $values = array($this->roomId);
                         $ilDB->manipulateF($query, $types, $values);
 
                         do
                         {
                                 if($this->getSetting('enable_history'))
                                 {
                                         $id = $ilDB->nextId(self::$sessionTable);
                                         $ilDB->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 = $ilDB->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 202 of file class.ilChatroom.php.

References $ilDB, $query, $res, $row, array, and time.

Referenced by ilChatroomServerHandler\cleanupPrivateRooms().

         {
                 global $ilDB;
 
                 $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  = $ilDB->queryF(
                         $query,
                         array('integer'),
                         array(time() + 60 * 5)
                 );
 
                 $rooms = array();
 
                 while($row = $ilDB->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 ' . $ilDB->in('proom_id', $rooms, false, 'integer');
 
                 $rset  = $ilDB->query($query);
                 $rooms = array();
                 while($row = $ilDB->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 1134 of file class.ilChatroom.php.

References $ilDB, $query, $row, array, and listUsersInPrivateRoom().

         {
                 global $ilDB;
 
                 $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   = $ilDB->queryF($query, $types, $values);
                 $rooms  = array();
 
                 while($row = $ilDB->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:

◆ getBannedUsers()

ilChatroom::getBannedUsers ( )

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

ilDBInterface $ilDB

Returns: array

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

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

         {
                 global $ilDB;
 
                 $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   = $ilDB->queryF($query, $types, $values);
                 $result = array();
 
                 if($rset)
                 {
                         while($row = $ilDB->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(),
                                                 'remark'    => $row['remark']
                                         );
 
                                         $result[] = $userdata;
                                 }
                                 else
                                 {
                                         //@todo anonymous user
                                 }
                         }
                 }
 
                 return $result;
         }

Here is the call graph for this function:

◆ getChatURL()

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

ilCtrl $ilCtrl

Parameters

<type>	$gui
<type>	$scope_id

Definition at line 1055 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 ( )

Returns an array of connected users.

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

Returns: array

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

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

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

◆ getDescription()

ilChatroom::getDescription ( )

Definition at line 291 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`
	)

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

ilDBInterface $ilDB

Parameters

ilDateTime	$from
ilDateTime	$to
integer	$restricted_session_userid

Returns: array

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

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

         {
                 global $ilDB, $ilUser;
 
                 $join = '';
 
                 if($proom_id)
                 {
                         $join .=
                                 'INNER JOIN ' . self::$privateSessionsTable . ' pSessionTable ' .
                                 'ON pSessionTable.user_id = ' . $ilDB->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();
 
                 $query .= ' AND historyTable.sub_room = ' . $ilDB->quote($proom_id, 'integer');
 
                 $filter = array();
 
                 if($from != null)
                 {
                         $filter[] = 'timestamp >= ' . $ilDB->quote($from->getUnixTime(), 'integer');
                 }
 
                 if($to != null)
                 {
                         $filter[] = 'timestamp <= ' . $ilDB->quote($to->getUnixTime(), 'integer');
                 }
 
                 if($filter)
                         $query .= ' AND ' . join(' AND ', $filter);
                 $query .= ' ORDER BY timestamp ASC';
 
                 $rset   = $ilDB->query($query);
                 $result = array();
 
                 while($row = $ilDB->fetchAssoc($rset))
                 {
                         $message = json_decode($row['message']);
                         if ($message === null) {
                                 $message = json_decode('{}');
                         }
 
                         $row['message']            =  $message;
                         $row['message']->timestamp = $row['timestamp'];
                         if($row['message']->target !== null && !$row['message']->target->public && !in_array($ilUser->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 1397 of file class.ilChatroom.php.

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

Referenced by getLastMessagesForChatViewer().

         {
                 global $ilDB;
 
                 // 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.
                 $ilDB->setLimit($number);
                 $rset = $ilDB->query(
                         'SELECT *
                         FROM ' . self::$historyTable . '
                         WHERE room_id = ' . $ilDB->quote($this->roomId, 'integer') . '
                         AND sub_room = 0
                         AND (
                                 (' . $ilDB->like('message', 'text', '%"type":"message"%') . ' AND NOT ' . $ilDB->like('message', 'text', '%"public":0%') . ')
                                 OR ' . $ilDB->like('message', 'text', '%"target":{%"id":"' . $chatuser->getUserId() . '"%') . '
                                 OR ' . $ilDB->like('message', 'text', '%"from":{"id":' . $chatuser->getUserId() . '%') . '
                         )
                         ORDER BY timestamp DESC'
                 );
                 /*$rset = $ilDB->queryF('SELECT * FROM ' . self::$historyTable . ' WHERE room_id = %s AND sub_room = 0 ORDER BY timestamp DESC', array('integer'), array($this->roomId));*/
 
                 $result_count = 0;
                 $results      = array();
                 while(($row = $ilDB->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 = $ilDB->query(
                         'SELECT *
                         FROM ' . self::$historyTable . '
                         WHERE room_id = ' . $ilDB->quote($this->roomId, 'integer') . '
                         AND sub_room = 0
                         AND ' . $ilDB->like('message', 'text', '%"type":"notice"%') . '
                         AND timestamp <= ' . $ilDB->quote($results[0]->timestamp, 'integer') . ' AND timestamp >= ' . $ilDB->quote($results[$result_count - 1]->timestamp, 'integer') . '
 
                         ORDER BY timestamp DESC'
                 );
 
                 while(($row = $ilDB->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 1392 of file class.ilChatroom.php.

References getLastMessages().

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

Here is the call 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. ilDBInterface $ilDB

Parameters

ilChatroomUser $user

Returns: array

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

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

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

Here is the call graph for this function:

◆ getPrivateRoomSessions()

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

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

References $ilDB, $query, $result, $row, and array.

         {
                 global $ilDB;
 
                 $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   = $ilDB->queryF($query, array('integer', 'integer', 'integer', 'integer'), array($from->getUnixTime(), $to->getUnixTime(), $user_id, $room_id));
                 $result = array();
                 while($row = $ilDB->fetchAssoc($rset))
                 {
                         $result[] = $row;
                 }
                 return $result;
         }

◆ getPrivateSubRooms()

ilChatroom::getPrivateSubRooms	(	$parent_room,
		$user_id
	)

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

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

         {
                 global $ilDB;
 
                 $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 = $ilDB->queryF($query, $types, $values);
 
                 $priv_rooms = array();
 
                 while($row = $ilDB->fetchAssoc($res))
                 {
                         $proom_id              = $row['proom_id'];
                         $priv_rooms[$proom_id] = $row['parent_id'];
                 }
 
                 return $priv_rooms;
         }

◆ getRefIdByRoomId()

ilChatroom::getRefIdByRoomId ( $room_id )

Returns ref_id of given room_id ilDBInterface $ilDB.

Parameters

integer $room_id

Returns: integer

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

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

         {
                 global $ilDB;
 
                 $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 = $ilDB->queryF($query, $types, $values);
 
                 $row = $ilDB->fetchAssoc($res);
 
                 return $row['ref_id'];
         }

◆ getRoomId()

ilChatroom::getRoomId ( )

Returns roomID from $this->roomId.

Returns: integer

Definition at line 703 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.

ilDBInterface $ilDB

Parameters

ilChatroomUser $user

Returns: array

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

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

         {
                 global $ilDB;
 
                 $query = 'SELECT * FROM ' . self::$sessionTable
                         . ' WHERE room_id = ' .
                         $ilDB->quote($this->getRoomId(), 'integer') .
                         ' ORDER BY connected DESC';
 
                 $rset = $ilDB->query($query);
 
                 $result = array();
 
                 while($row = $ilDB->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 306 of file class.ilChatroom.php.

References settings().

Referenced by disconnectUsers(), getDescription(), 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 572 of file class.ilChatroom.php.

References $settings.

         {
                 return $this->settings;
         }

◆ getTitle()

ilChatroom::getTitle ( )

Definition at line 1076 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 1255 of file class.ilChatroom.php.

References $ilDB, $query, $res, $row, $title, and array.

Referenced by ilChatroomViewGUI\renderFileUploadForm().

         {
                 global $ilDB;
 
                 $query = 'SELECT title FROM ' . self::$privateRoomsTable . ' WHERE parent_id = %s and closed = 0';
                 $rset  = $ilDB->queryF($query, array('integer'), array($this->roomId));
 
                 $titles = array();
 
                 while($row = $ilDB->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:

◆ 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 131 of file class.ilChatroom.php.

References 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:

◆ inviteUserToPrivateRoomByLogin()

ilChatroom::inviteUserToPrivateRoomByLogin	(	$login,
		$proom_id
	)

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

References $ilDB, $query, ilObjUser\_lookupId(), and array.

         {
                 global $ilDB;
                 $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 601 of file class.ilChatroom.php.

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

         {
                 //echo call_user_func_array('sprintf', array_merge(array($query), $values));
                 global $ilDB;
 
                 $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   = $ilDB->queryF($query, $types, $values);
 
                 if($rset && ($row = $ilDB->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   = $ilDB->queryF($query, $types, $values);
 
                 if($rset && ($row = $ilDB->fetchAssoc($rset)) && $row['cnt'] == 1)
                         return true;
 
                 return false;
         }

◆ isOwnerOfPrivateRoom()

ilChatroom::isOwnerOfPrivateRoom	(	$user_id,
		$proom_id
	)

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

References $ilDB, $lng, $query, array, ilNotificationConfig\DEFAULT_TTS, getChatURL(), ilObjectFactory\getInstanceByObjId(), getTitle(), and ilNotificationConfig\TTL_LONG.

         {
                 global $ilDB;
 
                 $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 = $ilDB->queryF($query, $types, $values);
 
                 if($rset && $ilDB->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.

ilDBInterface $ilDB

Parameters

integer $chat_userid

Returns: boolean

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

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

Referenced by ilChatroomViewGUI\renderFileUploadForm().

         {
                 global $ilDB;
 
                 $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   = $ilDB->queryF($query, $types, $values);
 
                 if($rset && ($row = $ilDB->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 ilDBInterface $ilDB.

Parameters

integer $user_id

Returns: boolean

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

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

         {
                 global $ilDB;
 
                 $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 = $ilDB->queryF($query, $types, $values);
 
                 if($rset && ($row = $ilDB->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 1162 of file class.ilChatroom.php.

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

Referenced by getActivePrivateRooms().

         {
                 global $ilDB;
 
                 $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   = $ilDB->queryF($query, $types, $values);
 
                 $users = array();
 
                 while($row = $ilDB->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 1086 of file class.ilChatroom.php.

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

Referenced by ilContactGUI\inviteToChat().

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

Here is the caller graph for this function:

◆ phpTypeToMDBType()

ilChatroom::phpTypeToMDBType ( $type )

private

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

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 314 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.

ilDBInterface $ilDB

Parameters

integer	$user_id
string	$filename
string	$type

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

References $filename, $ilDB, array, and time.

         {
                 global $ilDB;
 
                 $upload_id = $ilDB->nextId(self::$uploadTable);
 
                 $ilDB->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.

ilDBInterface $ilDB

Parameters

array $settings

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

References $ilDB, array, and phpTypeToMDBType().

Referenced by save().

         {
                 global $ilDB;
 
                 $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)
                 {
                         $ilDB->update(
                                 self::$settingsTable,
                                 $localSettings,
                                 array('room_id' => array('integer', $this->roomId))
                         );
                 }
                 else
                 {
                         $this->roomId = $ilDB->nextId(self::$settingsTable);
 
                         $localSettings['room_id'] = array(
                                 $this->availableSettings['room_id'], $this->roomId
                         );
 
                         $ilDB->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 150 of file class.ilChatroom.php.

References 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 1184 of file class.ilChatroom.php.

References $ilDB, array, time, and userIsInPrivateRoom().

         {
                 global $ilDB;
 
                 if(!$this->userIsInPrivateRoom($room_id, $user_id))
                 {
                         $id = $ilDB->nextId(self::$privateSessionsTable);
                         $ilDB->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.

ilDBInterface $ilDB

Parameters

mixed $user_id

Returns: boolean

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

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

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

Here is the call graph for this function:

◆ unsubscribeUserFromPrivateRoom()

ilChatroom::unsubscribeUserFromPrivateRoom	(	$room_id,
		$user_id
	)

ilDBInterface $ilDB

Parameters

integer	$room_id
integer	$user_id

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

References $ilDB, array, and time.

         {
                 global $ilDB;
 
                 $ilDB->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 1204 of file class.ilChatroom.php.

References $ilDB, $query, and array.

Referenced by subscribeUserToPrivateRoom().

         {
                 global $ilDB;
 
                 $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   = $ilDB->queryF($query, $types, $values);
                 if($ilDB->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',
                '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 42 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 40 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

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ addHistoryEntry()

◆ addPrivateRoom()

◆ banUser()

◆ byObjectId()

◆ byRoomId()

◆ checkPermissionsOfUser()

◆ checkUserPermissions()

◆ clearMessages()

◆ closePrivateRoom()

◆ countActiveUsers()

◆ disconnectAllUsersFromAllRooms()

◆ disconnectUser()

◆ disconnectUsers()

◆ findDeletablePrivateRooms()

◆ getActivePrivateRooms()

◆ getBannedUsers()

◆ getChatURL()

◆ getConnectedUsers()

◆ getDescription()

◆ getHistory()

◆ getLastMessages()

◆ getLastMessagesForChatViewer()

◆ getLastSession()

◆ getPrivateRoomSessions()

◆ getPrivateSubRooms()

◆ getRefIdByRoomId()

◆ getRoomId()

◆ getSessions()

◆ getSetting()

◆ getSettings()

◆ getTitle()

◆ getUniquePrivateRoomTitle()

◆ initialize()

◆ 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