ilChatUserActionProvider Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilChatUserActionProvider:

Collaboration diagram for ilChatUserActionProvider:

Public Member Functions
	__construct ()
	getComponentId ()
	getActionTypes ()
	collectActionsForTargetUser (int $a_target_user)
	Collect all actions. More...
Public Member Functions inherited from ilUserActionProvider
	__construct ()
	setUserId (int $a_val)
	getUserId ()
	collectActionsForTargetUser (int $a_target_user)
	Collect actions for a target user. More...
	getComponentId ()
	getActionTypes ()
	getJsScripts (string $a_action_type)

Protected Member Functions
	checkUserChatAccess (int $a_user_id)
	acceptsMessages (int $a_user_id)

Protected Attributes
int	$pub_ref_id = 0
bool	$chat_enabled = false
bool	$osc_enabled = false
ilCtrlInterface	$ctrl
Protected Attributes inherited from ilUserActionProvider
int	$user_id
Language	$lng
ilDBInterface	$db

Static Protected Attributes
static array	$user_access = []
static array	$accepts_messages_cache = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Adds link to chat

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 23 of file class.ilChatUserActionProvider.php.

Constructor & Destructor Documentation

__construct()

ilChatUserActionProvider::__construct

(

)

Definition at line 34 of file class.ilChatUserActionProvider.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilObjChatroom\_getPublicRefId(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

    {
        parent::__construct();

        global $DIC;

        $this->pub_ref_id = ilObjChatroom::_getPublicRefId();

        $chatSettings = new ilSetting('chatroom');
        $this->chat_enabled = (bool) $chatSettings->get('chat_enabled');
        $this->osc_enabled = (bool) $chatSettings->get('enable_osc');

        $this->lng->loadLanguageModule('chatroom');
        $this->ctrl = $DIC->ctrl();
    }

Here is the call graph for this function:

Member Function Documentation

acceptsMessages()

ilChatUserActionProvider::acceptsMessages ( int  $a_user_id )

protected

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

References ilObjUser\_lookupPref(), and ilUtil\yn2tf().

Referenced by collectActionsForTargetUser().

                                                      : bool
    {
        if (!array_key_exists($a_user_id, self::$accepts_messages_cache)) {
            self::$accepts_messages_cache[$a_user_id] = ilUtil::yn2tf(
                ilObjUser::_lookupPref($a_user_id, 'chat_osc_accept_msg') ?? 'n'
            );
        }

        return (bool) self::$accepts_messages_cache[$a_user_id];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkUserChatAccess()

ilChatUserActionProvider::checkUserChatAccess ( int  $a_user_id )

protected

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

References $GLOBALS.

Referenced by collectActionsForTargetUser().

                                                          : bool
    {
        if (!array_key_exists($a_user_id, self::$user_access)) {
            self::$user_access[$a_user_id] = $GLOBALS['DIC']->rbac()->system()->checkAccessOfUser($a_user_id, 'read', $this->pub_ref_id);
        }

        return self::$user_access[$a_user_id];
    }

Here is the caller graph for this function:

collectActionsForTargetUser()

ilChatUserActionProvider::collectActionsForTargetUser

(

int

$a_target_user

)

Collect all actions.

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

References Vendor\Package\$f, ilObjUser\_lookupLogin(), acceptsMessages(), checkUserChatAccess(), ILIAS\Repository\ctrl(), ilUserActionProvider\getUserId(), and ILIAS\Repository\lng().

                                                                   : ilUserActionCollection
    {
        $coll = new ilUserActionCollection();

        if (!$this->chat_enabled) {
            return $coll;
        }

        if ($this->checkUserChatAccess($this->getUserId()) && $a_target_user != $this->getUserId()) {
            if ($this->checkUserChatAccess($a_target_user)) {
                $f = new ilUserAction();
                $f->setType("invite");
                $f->setText($this->lng->txt('chat_user_action_invite_public_room'));
                $this->ctrl->setParameterByClass(ilObjChatroomGUI::class, 'ref_id', $this->pub_ref_id);
                $this->ctrl->setParameterByClass(ilObjChatroomGUI::class, 'user', $a_target_user);
                $f->setHref($this->ctrl->getLinkTargetByClass([ilRepositoryGUI::class, ilObjChatroomGUI::class], 'inviteUsersToPrivateRoom-byId'));
                $coll->addAction($f);
            }
        }

        if ($this->osc_enabled && $a_target_user != $this->getUserId()) {
            $f = new ilUserAction();
            $f->setHref('#');
            $f->setType("invite_osd");
            if ($this->acceptsMessages($a_target_user)) {
                $f->setText($this->lng->txt('chat_osc_start_conversation'));
                $f->setData([
                    'onscreenchat-userid' => $a_target_user,
                    'onscreenchat-username' => ilObjUser::_lookupLogin($a_target_user)
                ]);
            } else {
                $f->setText($this->lng->txt('chat_osc_doesnt_accept_msg'));
                $f->setData([
                    'onscreenchat-inact-userid' => $a_target_user
                ]);
            }
            $coll->addAction($f);
        }

        return $coll;
    }

Here is the call graph for this function:

getActionTypes()

ilChatUserActionProvider::getActionTypes

(

)

Returns

array<string,string>

Definition at line 58 of file class.ilChatUserActionProvider.php.

References ILIAS\Repository\lng().

                                    : array
    {
        return [
            "invite" => $this->lng->txt('chat_user_action_invite_public_room'),
            "invite_osd" => $this->lng->txt('chat_user_action_invite_osd')
        ];
    }

Here is the call graph for this function:

getComponentId()

ilChatUserActionProvider::getComponentId

(

)

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

                                    : string
    {
        return "chtr";
    }

Field Documentation

$accepts_messages_cache

array ilChatUserActionProvider::$accepts_messages_cache = []

staticprotected

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

$chat_enabled

bool ilChatUserActionProvider::$chat_enabled = false

protected

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

$ctrl

ilCtrlInterface ilChatUserActionProvider::$ctrl

protected

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

$osc_enabled

bool ilChatUserActionProvider::$osc_enabled = false

protected

Definition at line 31 of file class.ilChatUserActionProvider.php.

$pub_ref_id

int ilChatUserActionProvider::$pub_ref_id = 0

protected

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

$user_access

array ilChatUserActionProvider::$user_access = []

staticprotected

Definition at line 26 of file class.ilChatUserActionProvider.php.

---

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

• components/ILIAS/User/classes/Actions/class.ilChatUserActionProvider.php