ilChatroom Class Reference

Class ilChatroom. More...

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 (string $name, $value)
	Sets given name and value as setting into $this->settings array. More...
	getDescription ()
	getSetting (string $name)
	save ()
	saveSettings (array $settings)
	addHistoryEntry ($message)
	connectUser (ilChatroomUser $user)
	getConnectedUsers (bool $only_data=true)
	disconnectUser (int $user_id)
	disconnectUsers (array $userIds)
	getSettings ()
	isSubscribed (int $chat_userid)
	isAllowedToEnterPrivateRoom (int $chat_userid, int $proom_id)
	getHistory (ilDateTime $from=null, ilDateTime $to=null, int $restricted_session_userid=null, ?int $proom_id=0, bool $respect_target=true)
	getRoomId ()
	getPrivateRoomSessions (ilDateTime $from, ilDateTime $to, int $user_id, int $room_id)
	saveFileUploadToDb (int $user_id, string $filename, string $type)
	banUser (int $user_id, int $actor_id, string $comment='')
	unbanUser ($user_id)
	Deletes entry from banTable matching roomId and given $user_id and returns the number of affected rows. More...
	isUserBanned (int $user_id)
	getBannedUsers ()
	getLastSession (ilChatroomUser $user)
	getSessions (ilChatroomUser $user)
	addPrivateRoom (string $title, ilChatroomUser $owner, array $settings)
	closePrivateRoom (int $id)
	isOwnerOfPrivateRoom (int $user_id, int $proom_id)
	getChatURL (ilChatroomObjectGUI $gui, int $scope_id=0)
	getTitle ()
	inviteUserToPrivateRoomByLogin (string $login, int $proom_id)
	inviteUserToPrivateRoom (int $user_id, int $proom_id)
	getActivePrivateRooms (int $userid)
	listUsersInPrivateRoom (int $private_room_id)
	subscribeUserToPrivateRoom (int $room_id, int $user_id)
	userIsInPrivateRoom (int $room_id, int $user_id)
	unsubscribeUserFromPrivateRoom (int $room_id, int $user_id)
	countActiveUsers ()
	getPrivateRooms ()
	getPrivilegedUsersForPrivateRoom (int $subRoomId)
	getUniquePrivateRoomTitle (string $title)
	getAccessibleRoomIdByTitleMap (int $user_id)
	Fetches and returns a Array<Integer, String> of all accessible repository object chats in the main tree. More...
	getPrivateSubRooms (int $parent_room, int $user_id)
	getRefIdByRoomId (int $room_id)
	getLastMessages (int $number, ilChatroomUser $chatuser)
	clearMessages (int $sub_room)

Static Public Member Functions
static	checkUserPermissions ($permissions, int $ref_id, bool $send_info=true)
	Checks user permissions by given array and ref_id. More...
static	checkPermissionsOfUser (int $usr_id, $permissions, int $ref_id)
	Checks user permissions in question for a given user id in relation to a given ref_id. More...
static	byObjectId (int $object_id)
static	byRoomId (int $room_id, bool $initObject=false)
static	findDeletablePrivateRooms ()
static	lookupPrivateRoomTitle (int $proom_id)

Data Fields
const	ROOM_INVITATION = 'invitation_to_room'

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

Private Member Functions
	phpTypeToMDBType (string $type)

Private Attributes
array	$settings = []
array	$availableSettings
array int	$roomId = 0
ilObjChatroom	$object = null

Static Private Attributes
static string	$settingsTable = 'chatroom_settings'
static string	$historyTable = 'chatroom_history'
static string	$userTable = 'chatroom_users'
static string	$sessionTable = 'chatroom_sessions'
static string	$banTable = 'chatroom_bans'
static string	$privateRoomsTable = 'chatroom_prooms'
static string	$privateSessionsTable = 'chatroom_psessions'
static string	$uploadTable = 'chatroom_uploads'
static string	$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 33 of file class.ilChatroom.php.

Member Function Documentation

addHistoryEntry()

ilChatroom::addHistoryEntry

(

$message

)

Parameters

string | array | stdClass

$message

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

References $DIC, $id, $message, $timestamp, and ILIAS\Repository\int().

                                             : void
    {
        global $DIC;

        $subRoom = 0;
        $timestamp = 0;
        if (is_array($message)) {
            $subRoom = (int) ($message['sub'] ?? 0);
            $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,
            [
                'hist_id' => ['integer', $id],
                'room_id' => ['integer', $this->roomId],
                'sub_room' => ['integer', $subRoom],
                'message' => ['text', json_encode($message, JSON_THROW_ON_ERROR)],
                'timestamp' => ['integer', ($timestamp > 0 ? $timestamp : time())],
            ]
        );
    }

Here is the call graph for this function:

addPrivateRoom()

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

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

References $DIC, and ilChatroomUser\getUserId().

                                                                                         : int
    {
        global $DIC;

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

        return $nextId;
    }

Here is the call graph for this function:

banUser()

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

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

References $comment, and $DIC.

                                                                              : void
    {
        global $DIC;

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

byObjectId()

static ilChatroom::byObjectId ( int  $object_id )

static

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

References $DIC, and $query.

Referenced by ilChatroomXMLWriter\__construct(), ilChatroomXMLParser\__construct(), ilChatroomBanGUI\active(), ilChatroomHistoryGUI\byDay(), ilChatroomHistoryGUI\bySession(), ilObjChatroom\cloneObject(), ilChatroomPrivateRoomGUI\create(), ilChatroomBanGUI\delete(), ilChatroomPrivateRoomGUI\delete(), ilChatroomPrivateRoomGUI\enter(), ilChatroomKickGUI\executeDefault(), ilChatroomViewGUI\executeDefault(), ilChatroomSettingsGUI\general(), ilObjChatroomListGUI\getProperties(), ilChatroomGUIHandler\getRoomByObjectId(), ilChatroomTabGUIFactory\getTabsForCommand(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomViewGUI\invitePD(), ilChatroomViewGUI\joinWithCustomName(), ilChatroomPrivateRoomGUI\leave(), ilChatroomPrivateRoomGUI\listUsers(), ilChatroomViewGUI\lostConnection(), ilChatroomKickGUI\main(), ilChatroomCreateGUI\save(), ilChatroomBanGUI\show(), ilChatroomKickGUI\sub(), and ilChatroomViewGUI\toggleAutoMessageDisplayState().

                                                     : ?ilChatroom
    {
        global $DIC;

        $query = 'SELECT * FROM ' . self::$settingsTable . ' WHERE object_id = %s';
        $types = ['integer'];
        $values = [$object_id];
        $rset = $DIC->database()->queryF($query, $types, $values);

        if ($row = $DIC->database()->fetchAssoc($rset)) {
            $room = new self();
            $room->initialize($row);
            return $room;
        }

        return null;
    }

Here is the caller graph for this function:

byRoomId()

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

static

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

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

Referenced by ilContactGUI\submitInvitation().

                                                                           : ?ilChatroom
    {
        global $DIC;

        $query = 'SELECT * FROM ' . self::$settingsTable . ' WHERE room_id = %s';

        $types = ['integer'];
        $values = [$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((int) $row['object_id']);
            }

            return $room;
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkPermissions()

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

staticprotected

Parameters

int	$usrId
int	$refId
	string[]	$permissions

Returns

bool

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

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

                                                                                          : bool
    {
        global $DIC;

        $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) {
                                $DIC->access()->addInfoItem(
                                    ilAccessInfo::IL_NO_OBJECT_ACCESS,
                                    $DIC->language()->txt('offline')
                                );
                            }

                            if (!$active && !$visible) {
                                return false;
                            }
                            break;

                        case 'read':
                            if (!$active) {
                                $DIC->access()->addInfoItem(
                                    ilAccessInfo::IL_NO_OBJECT_ACCESS,
                                    $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 ( int  $usr_id,   $permissions, int  $ref_id  )

static

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

Parameters

int	$usr_id
	string|string[]	$permissions
int	$ref_id

Returns

bool

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

Referenced by ilObjChatroomGUI\executeCommand(), and ilContactGUI\submitInvitation().

                                                                                         : bool
    {
        if (!is_array($permissions)) {
            $permissions = [$permissions];
        }

        return self::checkPermissions($usr_id, $ref_id, $permissions);
    }

Here is the caller graph for this function:

checkUserPermissions()

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

static

Checks user permissions by given array and ref_id.

Parameters

	string|string[]	$permissions
int	$ref_id
bool	$send_info

Returns

bool

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

References $DIC, and $ref_id.

Referenced by ilObjChatroomAccess\_checkGoto(), ilObjChatroomGUI\_goto(), ilChatroomTabGUIFactory\buildTabs(), ilChatroomInfoGUI\executeDefault(), ilChatroomSettingsGUI\general(), ilChatroomGUIHandler\hasPermission(), ilChatroomGUIHandler\redirectIfNoPermission(), ilChatroomAdminViewGUI\saveClientSettings(), ilChatroomViewGUI\showRoom(), ilChatroomKickGUI\sub(), and ilChatroomAdminSmileyGUI\view().

                                                                                                  : bool
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();

        if (!is_array($permissions)) {
            $permissions = [$permissions];
        }

        $hasPermissions = self::checkPermissions($DIC->user()->getId(), $ref_id, $permissions);
        if (!$hasPermissions && $send_info) {
            $main_tpl->setOnScreenMessage('failure', $DIC->language()->txt('permission_denied'), true);

            return false;
        }

        return $hasPermissions;
    }

Here is the caller graph for this function:

clearMessages()

ilChatroom::clearMessages

(

int

$sub_room

)

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

References $DIC.

                                                : void
    {
        global $DIC;

        $DIC->database()->queryF(
            'DELETE FROM ' . self::$historyTable . ' WHERE room_id = %s AND sub_room = %s',
            ['integer', 'integer'],
            [$this->roomId, $sub_room]
        );

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

closePrivateRoom()

ilChatroom::closePrivateRoom

(

int

$id

)

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

References $DIC.

                                             : void
    {
        global $DIC;

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

connectUser()

ilChatroom::connectUser

(

ilChatroomUser

$user

)

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

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

Referenced by ilChatroomViewGUI\showRoom().

                                                     : bool
    {
        global $DIC;

        $userdata = [
            'login' => $user->getUsername(),
            'id' => $user->getUserId()
        ];

        $query = 'SELECT user_id FROM ' . self::$userTable . ' WHERE room_id = %s AND user_id = %s';
        $types = ['integer', 'integer'];
        $values = [$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,
                [
                    'room_id' => ['integer', $this->roomId],
                    'user_id' => ['integer', $user->getUserId()]
                ],
                [
                    'userdata' => ['text', json_encode($userdata, JSON_THROW_ON_ERROR)],
                    'connected' => ['integer', time()],
                ]
            );

            return true;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

countActiveUsers()

ilChatroom::countActiveUsers

(

)

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

References $DIC, $query, $res, and $roomId.

                                      : int
    {
        global $DIC;

        $query = 'SELECT COUNT(user_id) cnt FROM ' . self::$userTable . ' WHERE room_id = %s';
        $types = ['integer'];
        $values = [$this->roomId];
        $res = $DIC->database()->queryF($query, $types, $values);

        if ($row = $DIC->database()->fetchAssoc($res)) {
            return (int) $row['cnt'];
        }

        return 0;
    }

disconnectUser()

ilChatroom::disconnectUser

(

int

$user_id

)

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

References disconnectUsers().

                                                : void
    {
        $this->disconnectUsers([$user_id]);
    }

Here is the call graph for this function:

disconnectUsers()

ilChatroom::disconnectUsers

(

array

$userIds

)

Parameters

int[]

$userIds

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

References $DIC, $id, $query, $res, $roomId, and getSetting().

Referenced by disconnectUser().

                                                   : void
    {
        global $DIC;

        $query = 'SELECT * FROM ' . self::$userTable . ' WHERE room_id = %s AND ' .
            $DIC->database()->in('user_id', $userIds, false, 'integer');

        $types = ['integer'];
        $values = [$this->roomId];
        $res = $DIC->database()->queryF($query, $types, $values);

        if ($row = $DIC->database()->fetchAssoc($res)) {
            $query = 'SELECT proom_id FROM ' . self::$privateRoomsTable . ' WHERE parent_id = %s';
            $rset_prooms = $DIC->database()->queryF($query, ['integer'], [$this->roomId]);

            $prooms = [];

            while ($row_prooms = $DIC->database()->fetchAssoc($rset_prooms)) {
                $prooms[] = $row_prooms['proom_id'];
            }

            $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, ['integer'], [time()]);

            $query = 'DELETE FROM ' . self::$userTable . ' WHERE room_id = %s AND ' .
                $DIC->database()->in('user_id', $userIds, false, 'integer');

            $types = ['integer'];
            $values = [$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,
                        [
                            'sess_id' => ['integer', $id],
                            'room_id' => ['integer', $this->roomId],
                            'user_id' => ['integer', $row['user_id']],
                            'userdata' => ['text', $row['userdata']],
                            'connected' => ['integer', $row['connected']],
                            'disconnected' => ['integer', time()]
                        ]
                    );
                }
            } while ($row = $DIC->database()->fetchAssoc($res));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findDeletablePrivateRooms()

static ilChatroom::findDeletablePrivateRooms ( )

static

Returns

array{proom_id: int, room_id: int, object_id: int}[]

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

References $DIC, $query, and ILIAS\Repository\int().

                                                      : array
    {
        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,
            ['integer'],
            [time() + 60 * 5]
        );

        $rooms = [];

        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 = [];
        while ($row = $DIC->database()->fetchAssoc($rset)) {
            $rooms[] = [
                'proom_id' => (int) $row['proom_id'],
                'room_id' => (int) $row['room_id'],
                'object_id' => (int) $row['object_id']
            ];
        }

        return $rooms;
    }

Here is the call graph for this function:

getAccessibleRoomIdByTitleMap()

ilChatroom::getAccessibleRoomIdByTitleMap

(

int

$user_id

)

Fetches and returns a Array<Integer, String> of all accessible repository object chats in the main tree.

Parameters

int

$user_id

Returns

array<int, string>

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

References $DIC, $query, $res, and ILIAS\Repository\int().

                                                               : array
    {
        global $DIC;

        $query = "
                        SELECT room_id, od.title, objr.ref_id
                        FROM object_data od
                        INNER JOIN  " . self::$settingsTable . "
                                ON object_id = od.obj_id
                        INNER JOIN object_reference objr
                                ON objr.obj_id = od.obj_id
                                AND objr.deleted IS NULL
                        INNER JOIN tree
                                ON tree.child = objr.ref_id
                                AND tree.tree = %s
                        WHERE od.type = %s
       ";

        $types = ['integer', 'text'];
        $values = [1, 'chtr'];
        $res = $DIC->database()->queryF($query, $types, $values);

        $rooms = [];
        while ($row = $DIC->database()->fetchAssoc($res)) {
            if (self::checkPermissionsOfUser($user_id, 'read', (int) $row['ref_id'])) {
                $rooms[(int) $row['room_id']] = $row['title'];
            }
        }

        return $rooms;
    }

Here is the call graph for this function:

getActivePrivateRooms()

ilChatroom::getActivePrivateRooms

(

int

$userid

)

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

References $DIC, $query, $roomId, and listUsersInPrivateRoom().

Referenced by ilChatroomViewGUI\showRoom().

                                                      : array
    {
        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 = ['integer', 'integer', 'integer'];
        $values = [$userid, $this->roomId, $userid];
        $rset = $DIC->database()->queryF($query, $types, $values);
        $rooms = [];
        while ($row = $DIC->database()->fetchAssoc($rset)) {
            $row['active_users'] = $this->listUsersInPrivateRoom((int) $row['id']);
            $row['owner'] = $row['rowner'];
            $rooms[$row['proom_id']] = $row;
        }

        return $rooms;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBannedUsers()

ilChatroom::getBannedUsers

(

)

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

References $DIC, $query, $res, getRoomId(), and ILIAS\Repository\int().

                                    : array
    {
        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 = ['integer'];
        $values = [$this->getRoomId()];
        $res = $DIC->database()->queryF($query, $types, $values);
        $result = [];

        while ($row = $DIC->database()->fetchAssoc($res)) {
            if ($row['user_id'] > 0) {
                $user = new ilObjUser((int) $row['user_id']);
                $userdata = [
                    'user_id' => $user->getId(),
                    'firstname' => $user->getFirstname(),
                    'lastname' => $user->getLastname(),
                    'login' => $user->getLogin(),
                    'timestamp' => (int) $row['timestamp'],
                    'actor_id' => (int) $row['actor_id'],
                    'remark' => $row['remark']
                ];

                $result[] = $userdata;
            }
        }

        return $result;
    }

Here is the call graph for this function:

getChatURL()

ilChatroom::getChatURL	(	ilChatroomObjectGUI	$gui,
		int	$scope_id = 0
	)

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

References $url, ilLink\_getStaticLink(), and ilObjectGUI\getObject().

Referenced by isOwnerOfPrivateRoom().

                                                                           : string
    {
        $url = '';
        if ($scope_id) {
            $url = ilLink::_getStaticLink($gui->getObject()->getRefId(), $gui->getObject()->getType(), true, '_' . $scope_id);
        } else {
            $url = ilLink::_getStaticLink($gui->getObject()->getRefId(), $gui->getObject()->getType());
        }

        return $url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getConnectedUsers()

ilChatroom::getConnectedUsers

(

bool

$only_data = true

)

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

References $DIC, $query, and $roomId.

Referenced by ilChatroomViewGUI\showRoom().

                                                             : array
    {
        global $DIC;

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

        while ($row = $DIC->database()->fetchAssoc($rset)) {
            $users[] = $only_data ? json_decode($row['userdata'], false, 512, JSON_THROW_ON_ERROR) : $row;
        }

        return $users;
    }

Here is the caller graph for this function:

getDescription()

ilChatroom::getDescription

(

)

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

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

                                    : string
    {
        if (!$this->object) {
            $this->object = ilObjectFactory::getInstanceByObjId((int) $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,
		int	$restricted_session_userid = null,
		?int	$proom_id = 0,
		bool	$respect_target = true
	)

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

References $DIC, Vendor\Package\$e, $message, $query, and getRoomId().

     : array {
        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 = [];

        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 ' . implode(' AND ', $filter);
        }
        $query .= ' ORDER BY timestamp ASC';

        $rset = $DIC->database()->query($query);
        $result = [];

        while ($row = $DIC->database()->fetchAssoc($rset)) {
            try {
                $message = json_decode($row['message'], false, 512, JSON_THROW_ON_ERROR);
            } catch (JsonException $e) {
                $message = null;
            } finally {
                if ($message === null) {
                    $message = json_decode('{}', false, 512, JSON_THROW_ON_ERROR);
                }
            }

            $row['message'] = $message;
            $row['message']->timestamp = $row['timestamp'];
            if (
                $respect_target &&
                property_exists($row['message'], 'target') &&
                $row['message']->target !== null &&
                !$row['message']->target->public && (
                    !isset($row['recipients']) ||
                    !in_array($DIC->user()->getId(), explode(',', $row['recipients']), false)
                )
            ) {
                continue;
            }

            $result[] = $row;
        }
        return $result;
    }

Here is the call graph for this function:

getLastMessages()

ilChatroom::getLastMessages	(	int	$number,
		ilChatroomUser	$chatuser
	)

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

References Vendor\Package\$a, Vendor\Package\$b, $DIC, $results, $roomId, ilChatroomUser\getUserId(), and ILIAS\Repository\int().

Referenced by ilChatroomViewGUI\showRoom().

                                                                          : array
    {
        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 = [];
        while (($row = $DIC->database()->fetchAssoc($rset)) && $result_count < $number) {
            $tmp = json_decode($row['message'], false, 512, JSON_THROW_ON_ERROR);
            if (property_exists($tmp, 'target') && $tmp->target instanceof stdClass && (int) $tmp->target->public === 0) {
                if (in_array($chatuser->getUserId(), [(int) $tmp->target->id, (int) $tmp->from->id], true)) {
                    $results[] = $tmp;
                    ++$result_count;
                }
            } else {
                $results[] = $tmp;
                ++$result_count;
            }
        }

        if ($results !== []) {
            $rset = $DIC->database()->queryF(
                'SELECT *
                FROM ' . self::$historyTable . '
                WHERE room_id = %s
                AND sub_room = 0
                AND ' . $DIC->database()->like('message', 'text', '%%"type":"notice"%%') . '
                AND timestamp <= %s AND timestamp >= %s
                ORDER BY timestamp DESC',
                ['integer', 'integer', 'integer'],
                [$this->roomId, $results[0]->timestamp, $results[$result_count - 1]->timestamp]
            );

            while (($row = $DIC->database()->fetchAssoc($rset))) {
                $tmp = json_decode($row['message'], false, 512, JSON_THROW_ON_ERROR);
                $results[] = $tmp;
            }
        }

        usort($results, static function (stdClass $a, stdClass $b): int {
            $a_timestamp = strlen((string) $a->timestamp) === 13 ? ((int) substr((string) $a->timestamp, 0, -3)) : $a->timestamp;
            $b_timestamp = strlen((string) $b->timestamp) === 13 ? ((int) substr((string) $b->timestamp, 0, -3)) : $b->timestamp;

            return $b_timestamp - $a_timestamp;
        });

        return $results;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLastSession()

ilChatroom::getLastSession

(

ilChatroomUser

$user

)

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

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

                                                        : ?array
    {
        global $DIC;

        $query = 'SELECT * FROM ' . self::$sessionTable . ' WHERE user_id = ' .
            $DIC->database()->quote($user->getUserId(), 'integer') .
            ' ORDER BY connected DESC';

        $DIC->database()->setLimit(1);
        $res = $DIC->database()->query($query);

        if ($row = $DIC->database()->fetchAssoc($res)) {
            return $row;
        }

        return null;
    }

Here is the call graph for this function:

getPrivateRooms()

ilChatroom::getPrivateRooms

(

)

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

References $DIC, and $query.

                                     : array
    {
        global $DIC;

        $query = 'SELECT * FROM ' . self::$privateRoomsTable . ' WHERE parent_id = %s';
        $rset = $DIC->database()->queryF($query, ['integer'], [$this->roomId]);

        $rooms = [];
        while ($row = $DIC->database()->fetchAssoc($rset)) {
            $rooms[] = $row;
        }

        return $rooms;
    }

getPrivateRoomSessions()

ilChatroom::getPrivateRoomSessions	(	ilDateTime	$from,
		ilDateTime	$to,
		int	$user_id,
		int	$room_id
	)

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

References $DIC, $query, $res, and ilDateTime\getUnixTime().

     : 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';

        $res = $DIC->database()->queryF(
            $query,
            ['integer', 'integer', 'integer', 'integer'],
            [$from->getUnixTime(), $to->getUnixTime(), $user_id, $room_id]
        );
        $result = [];
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $result[] = $row;
        }

        return $result;
    }

Here is the call graph for this function:

getPrivateSubRooms()

ilChatroom::getPrivateSubRooms	(	int	$parent_room,
		int	$user_id
	)

Parameters

int	$parent_room
int	$user_id

Returns

array<int, int>

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

References $DIC, $query, $res, and ILIAS\Repository\int().

                                                                      : array
    {
        global $DIC;

        $query = "
        SELECT      proom_id, parent_id
        FROM        " . self::$privateRoomsTable . "
        WHERE       parent_id = %s
        AND         owner = %s
        AND         closed = 0
        ";

        $types = ['integer', 'integer'];
        $values = [$parent_room, $user_id];
        $res = $DIC->database()->queryF($query, $types, $values);

        $priv_rooms = [];
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $proom_id = (int) $row['proom_id'];
            $priv_rooms[$proom_id] = (int) $row['parent_id'];
        }

        return $priv_rooms;
    }

Here is the call graph for this function:

getPrivilegedUsersForPrivateRoom()

ilChatroom::getPrivilegedUsersForPrivateRoom

(

int

$subRoomId

)

Parameters

int

$subRoomId

Returns

int[]

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

References $DIC, $query, and ILIAS\Repository\int().

                                                                    : array
    {
        global $DIC;

        $query = 'SELECT user_id FROM ' . self::$privateRoomsAccessTable . ' WHERE proom_id = %s';
        $rset = $DIC->database()->queryF($query, ['integer'], [$subRoomId]);

        $userIds = [];
        while ($row = $DIC->database()->fetchAssoc($rset)) {
            $userIds[] = (int) $row['user_id'];
        }

        return $userIds;
    }

Here is the call graph for this function:

getRefIdByRoomId()

ilChatroom::getRefIdByRoomId

(

int

$room_id

)

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

References $DIC, $query, and $res.

Referenced by isOwnerOfPrivateRoom().

                                                  : int
    {
        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 = ['integer'];
        $values = [$room_id];

        $res = $DIC->database()->queryF($query, $types, $values);

        $row = $DIC->database()->fetchAssoc($res);

        return (int) ($row['ref_id'] ?? 0);
    }

Here is the caller graph for this function:

getRoomId()

ilChatroom::getRoomId

(

)

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

References $roomId.

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

                               : int
    {
        return $this->roomId;
    }

Here is the caller graph for this function:

getSessions()

ilChatroom::getSessions

(

ilChatroomUser

$user

)

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

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

                                                     : array
    {
        global $DIC;

        $query = 'SELECT * FROM ' . self::$sessionTable
            . ' WHERE room_id = ' .
            $DIC->database()->quote($this->getRoomId(), 'integer') .
            ' ORDER BY connected DESC';

        $res = $DIC->database()->query($query);

        $result = [];
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $result[] = $row;
        }

        return $result;
    }

Here is the call graph for this function:

getSetting()

ilChatroom::getSetting

(

string

$name

)

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

References $name, and ILIAS\Repository\settings().

Referenced by disconnectUsers(), getDescription(), getTitle(), and ilChatroomViewGUI\showRoom().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getSettings()

ilChatroom::getSettings

(

)

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

References $settings.

                                 : array
    {
        return $this->settings;
    }

getTitle()

ilChatroom::getTitle

(

)

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

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

Referenced by isOwnerOfPrivateRoom().

                              : string
    {
        if (!$this->object) {
            $this->object = ilObjectFactory::getInstanceByObjId((int) $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

(

string

$title

)

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

References $DIC, $i, and $query.

                                                            : string
    {
        global $DIC;

        $query = 'SELECT title FROM ' . self::$privateRoomsTable . ' WHERE parent_id = %s and closed = 0';
        $rset = $DIC->database()->queryF($query, ['integer'], [$this->roomId]);

        $titles = [];
        while ($row = $DIC->database()->fetchAssoc($rset)) {
            $titles[] = $row['title'];
        }

        $suffix = '';
        $i = 0;
        do {
            if (!in_array($title . $suffix, $titles, true)) {
                $title .= $suffix;
                break;
            }

            ++$i;

            $suffix = ' (' . $i . ')';
        } while (true);

        return $title;
    }

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

References $type, ILIAS\Repository\int(), and setSetting().

                                              : void
    {
        $this->roomId = (int) $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	(	int	$user_id,
		int	$proom_id
	)

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

References $DIC.

Referenced by inviteUserToPrivateRoomByLogin().

                                                                        : void
    {
        global $DIC;

        $DIC->database()->replace(
            self::$privateRoomsAccessTable,
            [
                'user_id' => ['integer', $user_id],
                'proom_id' => ['integer', $proom_id]
            ],
            []
        );
    }

Here is the caller graph for this function:

inviteUserToPrivateRoomByLogin()

ilChatroom::inviteUserToPrivateRoomByLogin	(	string	$login,
		int	$proom_id
	)

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

References ilObjUser\_lookupId(), ILIAS\Repository\int(), and inviteUserToPrivateRoom().

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

Here is the call graph for this function:

isAllowedToEnterPrivateRoom()

ilChatroom::isAllowedToEnterPrivateRoom	(	int	$chat_userid,
		int	$proom_id
	)

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

References $DIC, $query, and $res.

Referenced by ilChatroomPrivateRoomGUI\exitIfEnterRoomIsNotAllowed(), and ilChatroomViewGUI\showRoom().

                                                                                : bool
    {
        global $DIC;

        $query = 'SELECT COUNT(user_id) cnt FROM ' . self::$privateRoomsAccessTable .
            ' WHERE proom_id = %s AND user_id = %s';

        $types = ['integer', 'integer'];
        $values = [$proom_id, $chat_userid];
        $res = $DIC->database()->queryF($query, $types, $values);

        if (($row = $DIC->database()->fetchAssoc($res)) && (int) $row['cnt'] === 1) {
            return true;
        }

        $query = 'SELECT COUNT(*) cnt FROM ' . self::$privateRoomsTable .
            ' WHERE proom_id = %s AND owner = %s';

        $types = ['integer', 'integer'];
        $values = [$proom_id, $chat_userid];
        $res = $DIC->database()->queryF($query, $types, $values);

        return ($row = $DIC->database()->fetchAssoc($res)) && (int) $row['cnt'] === 1;
    }

Here is the caller graph for this function:

isOwnerOfPrivateRoom()

ilChatroom::isOwnerOfPrivateRoom	(	int	$user_id,
		int	$proom_id
	)

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

References $DIC, $query, $res, ilLanguageFactory\_getLanguageOfUser(), ANONYMOUS_USER_ID, getChatURL(), ilObjectFactory\getInstanceByObjId(), getRefIdByRoomId(), getRoomId(), ilMail\getSalutation(), and getTitle().

Referenced by ilChatroomGUIHandler\canModerate().

                                                                     : bool
    {
        global $DIC;

        $query = 'SELECT proom_id FROM ' . self::$privateRoomsTable . ' WHERE proom_id = %s AND owner = %s';
        $types = ['integer', 'integer'];
        $values = [$proom_id, $user_id];

        $res = $DIC->database()->queryF($query, $types, $values);
        if ($DIC->database()->fetchAssoc($res)) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSubscribed()

ilChatroom::isSubscribed

(

int

$chat_userid

)

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

References $DIC, $query, $res, and $roomId.

Referenced by ilChatroomPrivateRoomGUI\exitIfNoRoomSubscription(), and ilChatroomViewGUI\showRoom().

                                                  : bool
    {
        global $DIC;

        $query = 'SELECT COUNT(user_id) as cnt FROM ' . self::$userTable .
            ' WHERE room_id = %s AND user_id = %s';

        $types = ['integer', 'integer'];
        $values = [$this->roomId, $chat_userid];
        $res = $DIC->database()->queryF($query, $types, $values);

        return ($row = $DIC->database()->fetchAssoc($res)) && (int) $row['cnt'] === 1;
    }

Here is the caller graph for this function:

isUserBanned()

ilChatroom::isUserBanned

(

int

$user_id

)

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

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

Referenced by ilChatroomViewGUI\showRoom().

                                              : bool
    {
        global $DIC;

        $query = 'SELECT COUNT(user_id) cnt FROM ' . self::$banTable . ' WHERE user_id = %s AND room_id = %s';
        $types = ['integer', 'integer'];
        $values = [$user_id, $this->getRoomId()];

        $res = $DIC->database()->queryF($query, $types, $values);

        return ($row = $DIC->database()->fetchAssoc($res)) && $row['cnt'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listUsersInPrivateRoom()

ilChatroom::listUsersInPrivateRoom

(

int

$private_room_id

)

Parameters

int

$private_room_id

Returns

int[]

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

References $DIC, $query, and ILIAS\Repository\int().

Referenced by getActivePrivateRooms().

                                                                : array
    {
        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 = ['integer'];
        $values = [$private_room_id];
        $rset = $DIC->database()->queryF($query, $types, $values);

        $users = [];
        while ($row = $DIC->database()->fetchAssoc($rset)) {
            $users[(int) $row['user_id']] = (int) $row['user_id'];
        }

        return array_values($users);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupPrivateRoomTitle()

static ilChatroom::lookupPrivateRoomTitle ( int  $proom_id )

static

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

References $DIC, and $query.

Referenced by ilContactGUI\inviteToChat().

                                                                : string
    {
        global $DIC;

        $query = 'SELECT title FROM ' . self::$privateRoomsTable . ' WHERE proom_id = %s';
        $types = ['integer'];
        $values = [$proom_id];

        $rset = $DIC->database()->queryF($query, $types, $values);
        if ($row = $DIC->database()->fetchAssoc($rset)) {
            return $row['title'];
        }

        return 'unknown';
    }

Here is the caller graph for this function:

phpTypeToMDBType()

ilChatroom::phpTypeToMDBType ( string  $type )

private

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

References $type.

Referenced by saveSettings().

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

            case 'boolean':
                return 'integer';

            default:
                return $type;
        }
    }

Here is the caller graph for this function:

save()

ilChatroom::save

(

)

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

References saveSettings(), and ILIAS\Repository\settings().

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

Here is the call graph for this function:

saveFileUploadToDb()

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

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

References $DIC.

                                                                                    : void
    {
        global $DIC;

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

saveSettings()

ilChatroom::saveSettings

(

array

$settings

)

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

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

Referenced by save().

                                                 : void
    {
        global $DIC;

        $localSettings = [];

        foreach ($this->availableSettings as $setting => $type) {
            if (isset($settings[$setting])) {
                if ($type === 'boolean') {
                    $settings[$setting] = (bool) $settings[$setting];
                }
                $localSettings[$setting] = [$this->phpTypeToMDBType($type), $settings[$setting]];
            }
        }

        if (!isset($localSettings['room_type']) || !$localSettings['room_type'][1]) {
            $localSettings['room_type'][0] = 'text';
            $localSettings['room_type'][1] = 'repository';
        }

        if ($this->roomId > 0) {
            $DIC->database()->update(
                self::$settingsTable,
                $localSettings,
                ['room_id' => ['integer', $this->roomId]]
            );
        } else {
            $this->roomId = $DIC->database()->nextId(self::$settingsTable);

            $localSettings['room_id'] = [
                'integer', $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	(	string	$name,
			$value
	)

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

Parameters

string	$name
mixed	$value

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

References $name, and ILIAS\Repository\settings().

Referenced by initialize().

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

Here is the call graph for this function:

Here is the caller graph for this function:

subscribeUserToPrivateRoom()

ilChatroom::subscribeUserToPrivateRoom	(	int	$room_id,
		int	$user_id
	)

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

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

Referenced by ilChatroomViewGUI\showRoom().

                                                                          : void
    {
        global $DIC;

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

Here is the call graph for this function:

Here is the caller graph for this function:

unbanUser()

ilChatroom::unbanUser

(

$user_id

)

Deletes entry from banTable matching roomId and given $user_id and returns the number of affected rows.

Parameters

int|int[]

$user_id

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

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

                                       : int
    {
        global $DIC;

        if (!is_array($user_id)) {
            $user_id = [$user_id];
        }

        $query = 'DELETE FROM ' . self::$banTable . ' WHERE room_id = %s AND ' . $DIC->database()->in('user_id', $user_id, false, 'integer');
        $types = ['integer'];
        $values = [$this->getRoomId()];

        return $DIC->database()->manipulateF($query, $types, $values);
    }

Here is the call graph for this function:

unsubscribeUserFromPrivateRoom()

ilChatroom::unsubscribeUserFromPrivateRoom	(	int	$room_id,
		int	$user_id
	)

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

References $DIC.

                                                                              : void
    {
        global $DIC;

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

userIsInPrivateRoom()

ilChatroom::userIsInPrivateRoom	(	int	$room_id,
		int	$user_id
	)

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

References $DIC, and $query.

Referenced by subscribeUserToPrivateRoom().

                                                                   : bool
    {
        global $DIC;

        $query = 'SELECT proom_id id FROM ' . self::$privateSessionsTable .
            ' WHERE user_id = %s AND proom_id = %s AND disconnected = 0';
        $types = ['integer', 'integer'];
        $values = [$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

array ilChatroom::$availableSettings

private

Initial value:

= [
        'object_id' => 'integer'

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

$banTable

string ilChatroom::$banTable = 'chatroom_bans'

staticprivate

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

$historyTable

string ilChatroom::$historyTable = 'chatroom_history'

staticprivate

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

$object

ilObjChatroom ilChatroom::$object = null

private

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

$privateRoomsAccessTable

string ilChatroom::$privateRoomsAccessTable = 'chatroom_proomaccess'

staticprivate

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

$privateRoomsTable

string ilChatroom::$privateRoomsTable = 'chatroom_prooms'

staticprivate

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

$privateSessionsTable

string ilChatroom::$privateSessionsTable = 'chatroom_psessions'

staticprivate

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

$roomId

array int ilChatroom::$roomId = 0

private

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

Referenced by connectUser(), countActiveUsers(), disconnectUsers(), getActivePrivateRooms(), getConnectedUsers(), getLastMessages(), getRoomId(), isSubscribed(), and saveSettings().

$sessionTable

string ilChatroom::$sessionTable = 'chatroom_sessions'

staticprivate

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

$settings

array ilChatroom::$settings = []

private

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

Referenced by getSettings().

$settingsTable

string ilChatroom::$settingsTable = 'chatroom_settings'

staticprivate

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

$uploadTable

string ilChatroom::$uploadTable = 'chatroom_uploads'

staticprivate

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

$userTable

string ilChatroom::$userTable = 'chatroom_users'

staticprivate

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

ROOM_INVITATION

const ilChatroom::ROOM_INVITATION = 'invitation_to_room'

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

---

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

• Modules/Chatroom/classes/class.ilChatroom.php