ilChatroomUser Class Reference

Class ilChatroomUser. More...

Collaboration diagram for ilChatroomUser:

Public Member Functions
	__construct (private readonly ilObjUser $user, private readonly ilChatroom $room)
	enabledBroadcastTyping ()
	getUserId ()
	Returns Ilias User ID. More...
	getUsername ()
	Returns username from Object or SESSION. More...
	setUsername (string $username)
	Sets and stores given username in SESSION. More...
	isProfilePictureVisible ()
	setProfilePictureVisible (bool $show_it)
	getChatNameSuggestions ()
	Returns an array of chat-name suggestions. More...
	buildAnonymousName ()
	buildFullname ()
	buildShortname ()
	Returns first letter of users firstname, followed by dot lastname. More...
	buildLogin ()
	buildUniqueUsername (string $username)

Static Public Member Functions
static	getUserInformation (array $usrIds, ?int $roomId=null)

Private Attributes
string	$username = ''
bool	$profile_picture_visible = null

Detailed Description

Class ilChatroomUser.

Author

Andreas Kordosz akord.nosp@m.osz@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$ \

Definition at line 27 of file class.ilChatroomUser.php.

Constructor & Destructor Documentation

__construct()

ilChatroomUser::__construct	(	private readonly ilObjUser	$user,
		private readonly ilChatroom	$room
	)

Definition at line 32 of file class.ilChatroomUser.php.

    {
    }

Member Function Documentation

buildAnonymousName()

ilChatroomUser::buildAnonymousName

(

)

Definition at line 132 of file class.ilChatroomUser.php.

Referenced by getChatNameSuggestions().

                                        : string
    {
        return str_replace(
            '#',
            (string) random_int(0, 10000),
            $this->room->getSetting('autogen_usernames')
        );
    }

Here is the caller graph for this function:

buildFullname()

ilChatroomUser::buildFullname

(

)

Definition at line 141 of file class.ilChatroomUser.php.

References ILIAS\Repository\user().

Referenced by getChatNameSuggestions().

                                   : string
    {
        $tmp = $this->user->getPref('public_profile');
        $this->user->setPref('public_profile', 'y');
        $public_name = $this->user->getPublicName();
        $this->user->setPref('public_profile', $tmp);

        return $public_name;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildLogin()

ilChatroomUser::buildLogin

(

)

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

References ILIAS\Repository\user().

Referenced by getChatNameSuggestions().

                                : string
    {
        return $this->user->getLogin();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildShortname()

ilChatroomUser::buildShortname

(

)

Returns first letter of users firstname, followed by dot lastname.

Definition at line 154 of file class.ilChatroomUser.php.

References ILIAS\Repository\user().

Referenced by getChatNameSuggestions().

                                    : string
    {
        $firstname = $this->user->getFirstname();

        return $firstname[0] . '. ' . $this->user->getLastname();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildUniqueUsername()

ilChatroomUser::buildUniqueUsername

(

string

$username

)

Definition at line 166 of file class.ilChatroomUser.php.

References $DIC, and $username.

                                                         : string
    {
        global $DIC;

        $username = htmlspecialchars(trim($username));
        $usernames = [];
        $uniqueName = $username;

        $rset = $DIC->database()->query(
            'SELECT * FROM chatroom_users WHERE ' .
            $DIC->database()->like('userdata', 'text', '%"login":"' . $username . '%') .
            ' AND room_id = ' . $DIC->database()->quote($this->room->getRoomId(), 'integer')
        );

        while (($row = $DIC->database()->fetchAssoc($rset))) {
            $json = json_decode($row['userdata'], true, 512, JSON_THROW_ON_ERROR);
            $usernames[] = $json['login'];
        }

        for ($index = 1, $indexMax = count($usernames); $index <= $indexMax; $index++) {
            if (in_array($uniqueName, $usernames, true)) {
                $uniqueName = sprintf('%s_%d', $username, $index);
            }
        }

        return $uniqueName;
    }

enabledBroadcastTyping()

ilChatroomUser::enabledBroadcastTyping

(

)

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

References ILIAS\Repository\user(), and ilUtil\yn2tf().

Referenced by ilChatroomViewGUI\showRoom().

                                            : bool
    {
        return ilUtil::yn2tf((string) $this->user->getPref('chat_broadcast_typing'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChatNameSuggestions()

ilChatroomUser::getChatNameSuggestions

(

)

Returns an array of chat-name suggestions.

Returns

array<string, string>

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

References buildAnonymousName(), buildFullname(), buildLogin(), buildShortname(), and ILIAS\Repository\user().

Referenced by ilChatroomViewGUI\showNameSelection().

                                            : array
    {
        $options = [];

        if ($this->user->isAnonymous()) {
            $options['anonymousName'] = $this->buildAnonymousName();
        } else {
            $options['fullname'] = $this->buildFullname();
            $options['shortname'] = $this->buildShortname();
            $options['login'] = $this->buildLogin();
        }

        return $options;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserId()

ilChatroomUser::getUserId

(

)

Returns Ilias User ID.

If user is anonymous, a random negative User ID is created, stored in SESSION, and returned.

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

References $user_id, ilSession\get(), ilSession\set(), and ILIAS\Repository\user().

Referenced by ilChatroom\connectUser(), ilChatroom\getLastMessages(), ilChatroom\getLastSession(), ilObjChatroom\getPersonalInformation(), and ilChatroomViewGUI\showRoom().

                               : int
    {
        $user_id = $this->user->getId();

        if ($this->user->isAnonymous()) {
            $session = ilSession::get('chat');
            if (isset($session[$this->room->getRoomId()]['user_id'])) {
                return $session[$this->room->getRoomId()]['user_id'];
            }

            $user_id = random_int(-99999, -20);

            $session[$this->room->getRoomId()]['user_id'] = $user_id;
            ilSession::set('chat', $session);
        }

        return $user_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserInformation()

static ilChatroomUser::getUserInformation ( array  $usrIds, ?int  $roomId = null  )

static

Parameters

int[]

$usrIds

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

References $DIC, $res, and null.

                                                                                 : array
    {
        global $DIC;

        $users = [];

        $query = '
                        SELECT userdata
                        FROM chatroom_users WHERE ' . $DIC->database()->in('user_id', $usrIds, false, 'integer');

        if (null !== $roomId) {
            $query .= ' AND room_id = ' . $DIC->database()->quote($roomId, 'integer');
        }

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

        return $users;
    }

getUsername()

ilChatroomUser::getUsername

(

)

Returns username from Object or SESSION.

If no Username is set, the login name will be returned.

Definition at line 68 of file class.ilChatroomUser.php.

References $username, ilSession\get(), and ILIAS\Repository\user().

Referenced by ilChatroom\connectUser(), ilObjChatroom\getPersonalInformation(), and ilChatroomViewGUI\showRoom().

                                 : string
    {
        if ($this->username) {
            return $this->username;
        }

        $session = ilSession::get('chat');
        if (
            is_array($session) &&
            isset($session[$this->room->getRoomId()]['username']) &&
            $session[$this->room->getRoomId()]['username']
        ) {
            return $session[$this->room->getRoomId()]['username'];
        }

        return $this->user->getPublicName();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isProfilePictureVisible()

ilChatroomUser::isProfilePictureVisible

(

)

Definition at line 98 of file class.ilChatroomUser.php.

References $profile_picture_visible, ilSession\get(), and null.

Referenced by ilChatroom\connectUser(), and ilChatroomViewGUI\showRoom().

                                             : bool
    {
        if ($this->profile_picture_visible === null) {
            $this->profile_picture_visible = ilSession::get('chat')[$this->room->getRoomId()]['profile-picture-visible'] ?? false;
        }
        return $this->profile_picture_visible;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setProfilePictureVisible()

ilChatroomUser::setProfilePictureVisible

(

bool

$show_it

)

Definition at line 106 of file class.ilChatroomUser.php.

References ilSession\get(), and ilSession\set().

                                                           : void
    {
        $session = ilSession::get('chat');
        $session[$this->room->getRoomId()]['profile-picture-visible'] = $show_it;
        ilSession::set('chat', $session);
    }

Here is the call graph for this function:

setUsername()

ilChatroomUser::setUsername

(

string

$username

)

Sets and stores given username in SESSION.

Definition at line 89 of file class.ilChatroomUser.php.

References $username, ilSession\get(), and ilSession\set().

                                                 : void
    {
        $this->username = htmlspecialchars($username);

        $session = ilSession::get('chat');
        $session[$this->room->getRoomId()]['username'] = $this->username;
        ilSession::set('chat', $session);
    }

Here is the call graph for this function:

Field Documentation

$profile_picture_visible

bool ilChatroomUser::$profile_picture_visible = null

private

Definition at line 30 of file class.ilChatroomUser.php.

Referenced by isProfilePictureVisible().

$username

string ilChatroomUser::$username = ''

private

Definition at line 29 of file class.ilChatroomUser.php.

Referenced by buildUniqueUsername(), getUsername(), and setUsername().

---

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

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