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)
	getHistory (?ilDateTime $from=null, ?ilDateTime $to=null, ?int $restricted_session_userid=null, bool $respect_target=true)
	getRoomId ()
	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)
	getChatURL (ilChatroomObjectGUI $gui)
	getTitle ()
	countActiveUsers ()
	getAccessibleRoomIdByTitleMap (int $user_id)
	Fetches and returns a Array<Integer, String> of all accessible repository object chats in the main tree. More...
	getRefIdByRoomId (int $room_id)
	getLastMessages (int $number, ilChatroomUser $chatuser)
	clearMessages ()

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)

Data Fields
const	ROOM_INVITATION = 'invitation_to_room'

Static Protected Member Functions
static	checkPermissions (int $usr_id, int $ref_id, 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'

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

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

                                             : void
    {
        global $DIC;

        $timestamp = 0;
        if (is_array($message)) {
            $timestamp = (int) $message['timestamp'];
        } elseif (is_object($message)) {
            $timestamp = (int) $message->timestamp;
        }

        $id = $DIC->database()->nextId(self::$historyTable);
        $DIC->database()->insert(
            self::$historyTable,
            [
                'hist_id' => [ilDBConstants::T_INTEGER, $id],
                'room_id' => [ilDBConstants::T_INTEGER, $this->roomId],
                'message' => [ilDBConstants::T_TEXT, json_encode($message, JSON_THROW_ON_ERROR)],
                'timestamp' => [ilDBConstants::T_INTEGER, ($timestamp > 0 ? $timestamp : time())],
            ]
        );
    }

Here is the call graph for this function:

banUser()

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

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

References $comment, $DIC, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                                              : void
    {
        global $DIC;

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

byObjectId()

static ilChatroom::byObjectId ( int  $object_id )

static

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

References $DIC, null, and ilDBConstants\T_INTEGER.

Referenced by ilChatroomXMLWriter\__construct(), ilChatroomXMLParser\__construct(), ilChatroomBanGUI\active(), ilObjChatroomGUI\afterImport(), ilChatroomHistoryGUI\byDayExport(), ilObjChatroom\cloneObject(), ilChatroomBanGUI\delete(), ilChatroomViewGUI\executeDefault(), ilChatroomSettingsGUI\general(), ilObjChatroomListGUI\getProperties(), ilChatroomGUIHandler\getRoomByObjectId(), ilChatroomTabGUIFactory\getTabsForCommand(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomViewGUI\joinWithCustomName(), ilChatroomKickGUI\main(), ilChatroomSettingsGUI\saveGeneral(), ilChatroomBanGUI\show(), and ilChatroomViewGUI\toggleAutoMessageDisplayState().

                                                     : ?ilChatroom
    {
        global $DIC;

        $query = 'SELECT * FROM ' . self::$settingsTable . ' WHERE object_id = %s';
        $types = [ilDBConstants::T_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 172 of file class.ilChatroom.php.

References $DIC, ilObjectFactory\getInstanceByObjId(), null, and ilDBConstants\T_INTEGER.

Referenced by ilContactGUI\inviteToChat(), and ilContactGUI\submitInvitation().

                                                                           : ?ilChatroom
    {
        global $DIC;

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

        $types = [ilDBConstants::T_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  $usr_id, int  $ref_id, array  $permissions  )

staticprotected

Parameters

string[]

$permissions

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

References $DIC, ilObjChatroom\_getPublicRefId(), ilObjectAccess\_isOffline(), and ilObject\_lookupObjId().

                                                                                            : bool
    {
        global $DIC;

        $pub_ref_id = ilObjChatroom::_getPublicRefId();

        if ($pub_ref_id === $ref_id) {
            $obj_id = ilObject::_lookupObjId($ref_id);
            foreach ($permissions as $permission) {
                $no_access = !$DIC->rbac()->system()->checkAccessOfUser($usr_id, $permission, $ref_id) || (
                    !$DIC->rbac()->system()->checkAccessOfUser($usr_id, 'write', $ref_id) &&
                    ilObjChatroomAccess::_isOffline($obj_id) &&
                    in_array($permission, ['read', 'visible'], true)
                );

                if ($no_access) {
                    return false;
                }
            }
        } else {
            foreach ($permissions as $permission) {
                if (!$DIC->access()->checkAccessOfUser($usr_id, $permission, '', $ref_id)) {
                    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

string|string[]

$permissions

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

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

                                                                                         : 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

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

References $DIC, and $ref_id.

Referenced by ilObjChatroomAccess\_checkGoto(), ilObjChatroomGUI\_goto(), ilChatroomTabGUIFactory\buildTabs(), ilChatroomSettingsGUI\general(), ilChatroomGUIHandler\hasPermission(), ilObjChatroomGUI\infoScreen(), ilChatroomGUIHandler\redirectIfNoPermission(), ilChatroomAdminViewGUI\saveClientSettings(), ilChatroomSettingsGUI\saveGeneral(), and ilChatroomViewGUI\showRoom().

                                                                                                  : 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

(

)

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

References $DIC, and ilDBConstants\T_INTEGER.

                                   : void
    {
        global $DIC;

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

        $DIC->database()->queryF(
            'DELETE FROM ' . self::$sessionTable . ' WHERE room_id = %s AND disconnected < %s',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [$this->roomId, time()]
        );
    }

connectUser()

ilChatroom::connectUser

(

ilChatroomUser

$user

)

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

References $DIC, $roomId, ilChatroomUser\getUserId(), ilChatroomUser\getUsername(), ilChatroomUser\isProfilePictureVisible(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ilChatroomViewGUI\showRoom().

                                                     : bool
    {
        global $DIC;

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

        $query = 'SELECT user_id FROM ' . self::$userTable . ' WHERE room_id = %s AND user_id = %s';
        $types = [ilDBConstants::T_INTEGER, ilDBConstants::T_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' => [ilDBConstants::T_INTEGER, $this->roomId],
                    'user_id' => [ilDBConstants::T_INTEGER, $user->getUserId()]
                ],
                [
                    'userdata' => [ilDBConstants::T_TEXT, json_encode($userdata, JSON_THROW_ON_ERROR)],
                    'connected' => [ilDBConstants::T_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 674 of file class.ilChatroom.php.

References $DIC, $res, $roomId, and ilDBConstants\T_INTEGER.

                                      : int
    {
        global $DIC;

        $query = 'SELECT COUNT(user_id) cnt FROM ' . self::$userTable . ' WHERE room_id = %s';
        $types = [ilDBConstants::T_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 341 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 349 of file class.ilChatroom.php.

References $DIC, $id, $res, $roomId, getSetting(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by disconnectUser().

                                                   : void
    {
        global $DIC;

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

        $types = [ilDBConstants::T_INTEGER];
        $values = [$this->roomId];
        $res = $DIC->database()->queryF($query, $types, $values);

        if ($row = $DIC->database()->fetchAssoc($res)) {
            $query = 'DELETE FROM ' . self::$userTable . ' WHERE room_id = %s AND ' .
                $DIC->database()->in('user_id', $userIds, false, ilDBConstants::T_INTEGER);

            $types = [ilDBConstants::T_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' => [ilDBConstants::T_INTEGER, $id],
                            'room_id' => [ilDBConstants::T_INTEGER, $this->roomId],
                            'user_id' => [ilDBConstants::T_INTEGER, $row['user_id']],
                            'userdata' => [ilDBConstants::T_TEXT, $row['userdata']],
                            'connected' => [ilDBConstants::T_INTEGER, $row['connected']],
                            'disconnected' => [ilDBConstants::T_INTEGER, time()]
                        ]
                    );
                }
            } while ($row = $DIC->database()->fetchAssoc($res));
        }
    }

Here is the call graph for this function:

Here is the caller 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.

Returns

array<int, string>

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

References $DIC, $res, ILIAS\Repository\int(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                               : 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 = [ilDBConstants::T_INTEGER, ilDBConstants::T_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:

getBannedUsers()

ilChatroom::getBannedUsers

(

)

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

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

                                    : 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 = [ilDBConstants::T_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

)

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

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

Referenced by getSessions().

                                                        : string
    {
        return ilLink::_getStaticLink($gui->getObject()->getRefId(), $gui->getObject()->getType());
    }

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

References $DIC, $roomId, and ilDBConstants\T_INTEGER.

Referenced by ilChatroomViewGUI\showRoom().

                                                             : array
    {
        global $DIC;

        $query = 'SELECT ' . ($only_data ? 'userdata' : '*') . ' FROM ' . self::$userTable . ' WHERE room_id = %s';
        $types = [ilDBConstants::T_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'], true, 512, JSON_THROW_ON_ERROR) : $row;
        }

        return $users;
    }

Here is the caller graph for this function:

getDescription()

ilChatroom::getDescription

(

)

Definition at line 197 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,
		bool	$respect_target = true
	)

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

References $DIC, $message, getRoomId(), null, and ilDBConstants\T_INTEGER.

     : array {
        global $DIC;

        $join = '';

        $query =
            'SELECT historyTable.* ' .
            'FROM ' . self::$historyTable . ' historyTable ' . $join . ' ' .
            'WHERE historyTable.room_id = ' . $this->getRoomId();

        $filter = [];

        if ($from !== null) {
            $filter[] = 'timestamp >= ' . $DIC->database()->quote($from->getUnixTime(), ilDBConstants::T_INTEGER);
        }

        if ($to !== null) {
            $filter[] = 'timestamp <= ' . $DIC->database()->quote($to->getUnixTime(), ilDBConstants::T_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) {
                $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(',', (string) $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 753 of file class.ilChatroom.php.

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

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()->queryF(
            'SELECT *
                        FROM ' . self::$historyTable . '
                        WHERE room_id = %s
                        AND (
                (JSON_VALUE(message, "$.type") = "message" AND (NOT JSON_CONTAINS_PATH(message, "one", "$.target.public") OR JSON_VALUE(message, "$.target.public") <> 0))
                                OR JSON_VALUE(message, "$.target.id") = %s
                                OR JSON_VALUE(message, "$.from.id") = %s
                        )
                        ORDER BY timestamp DESC',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [$this->roomId, $chatuser->getUserId(), $chatuser->getUserId()]
        );

        $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 JSON_VALUE(message, "$.type") = "notice"
                 AND timestamp <= %s AND timestamp >= %s
                 ORDER BY timestamp DESC',
                [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER, ilDBConstants::T_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 555 of file class.ilChatroom.php.

References $DIC, $res, ilChatroomUser\getUserId(), null, and ilDBConstants\T_INTEGER.

                                                        : ?array
    {
        global $DIC;

        $query = 'SELECT * FROM ' . self::$sessionTable . ' WHERE user_id = ' .
            $DIC->database()->quote($user->getUserId(), ilDBConstants::T_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:

getRefIdByRoomId()

ilChatroom::getRefIdByRoomId

(

int

$room_id

)

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

References $DIC, $res, and ilDBConstants\T_INTEGER.

Referenced by getSessions().

                                                  : 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 = [ilDBConstants::T_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 469 of file class.ilChatroom.php.

References $roomId.

Referenced by getBannedUsers(), getHistory(), getSessions(), 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 573 of file class.ilChatroom.php.

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

                                                     : array
    {
        global $DIC;

        $query = 'SELECT * FROM ' . self::$sessionTable
            . ' WHERE room_id = ' .
            $DIC->database()->quote($this->getRoomId(), ilDBConstants::T_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 206 of file class.ilChatroom.php.

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

References $settings.

Referenced by ilChatroomViewGUI\readOnlyChatWindow(), and ilChatroomViewGUI\showRoom().

                                 : array
    {
        return $this->settings;
    }

Here is the caller graph for this function:

getTitle()

ilChatroom::getTitle

(

)

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

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

Referenced by getSessions().

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

initialize()

ilChatroom::initialize

(

array

$rowdata

)

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

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

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

isSubscribed()

ilChatroom::isSubscribed

(

int

$chat_userid

)

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

References $DIC, $res, $roomId, and ilDBConstants\T_INTEGER.

Referenced by ilChatroomViewGUI\showRoom().

                                                  : bool
    {
        global $DIC;

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

        $types = [ilDBConstants::T_INTEGER, ilDBConstants::T_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 512 of file class.ilChatroom.php.

References $DIC, $res, $user_id, getRoomId(), and ilDBConstants\T_INTEGER.

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 = [ilDBConstants::T_INTEGER, ilDBConstants::T_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:

phpTypeToMDBType()

ilChatroom::phpTypeToMDBType ( string  $type )

private

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

References ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by saveSettings().

                                                   : string
    {
        return match ($type) {
            'string' => ilDBConstants::T_TEXT,
            'boolean' => ilDBConstants::T_INTEGER,
            default => $type,
        };
    }

Here is the caller graph for this function:

save()

ilChatroom::save

(

)

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

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

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

Here is the call graph for this function:

saveSettings()

ilChatroom::saveSettings

(

array

$settings

)

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

References $DIC, $roomId, phpTypeToMDBType(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by save().

                                                 : void
    {
        global $DIC;

        $localSettings = [];

        foreach ($this->availableSettings as $setting => $type) {
            if (array_key_exists($setting, $settings)) {
                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] = ilDBConstants::T_TEXT;
            $localSettings['room_type'][1] = 'repository';
        }

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

            $localSettings['room_id'] = [
                ilDBConstants::T_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

mixed

$value

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

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

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

References $DIC, $user_id, getRoomId(), and ilDBConstants\T_INTEGER.

                                       : 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, ilDBConstants::T_INTEGER);
        $types = [ilDBConstants::T_INTEGER];
        $values = [$this->getRoomId()];

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

Here is the call graph for this function:

Field Documentation

$availableSettings

array ilChatroom::$availableSettings

private

Initial value:

= [
        'object_id' => 'integer'

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

$roomId

array int ilChatroom::$roomId = 0

private

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

Referenced by connectUser(), countActiveUsers(), disconnectUsers(), getConnectedUsers(), 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 41 of file class.ilChatroom.php.

Referenced by getSettings().

$settingsTable

string ilChatroom::$settingsTable = 'chatroom_settings'

staticprivate

Definition at line 36 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:

• components/ILIAS/Chatroom/classes/class.ilChatroom.php