Adds link to chat. More...

Inheritance diagram for ilChatUserActionProvider:

Collaboration diagram for ilChatUserActionProvider:

Public Member Functions
	__construct ()
	Constructor. More...

	getComponentId ()
	Returns string component id as defined in services.xml/module.xml More...

	getActionTypes ()
	Returns array[string] keys must be unique action ids (strings), values should be the names of the actions (from ilLanguage) More...

	collectActionsForTargetUser ($a_target_user)
	Collect all actions. More...

Public Member Functions inherited from ilUserActionProvider
	__construct ()
	Constructor. More...

	setUserId ($a_val)
	Set user id. More...

	getUserId ()
	Get user id. More...

	collectActionsForTargetUser ($a_target_user)
	Collect actions for a target user. More...

	getComponentId ()

	getActionTypes ()

Protected Member Functions
	checkUserChatAccess ($a_user_id)
	Check user chat access. More...

	acceptsMessages ($a_user_id)

Protected Attributes
	$pub_ref_id = 0

	$chat_enabled = false
	Boolean to indicate if the chat is enabled. More...

	$osc_enabled = false
	Boolean to indicate if on screen chat is enabled. More...

Protected Attributes inherited from ilUserActionProvider
	$user_id

	$lng

	$db

Static Protected Attributes
static	$user_access = array()

static	$accepts_messages_cache = array()

Detailed Description

Adds link to chat.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilChatUserActionProvider::__construct ( )

Constructor.

Reimplemented from ilUserActionProvider.

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

        {
                parent::__construct();
 
                include_once 'Modules/Chatroom/classes/class.ilObjChatroom.php';
                $this->pub_ref_id = ilObjChatroom::_getPublicRefId();
 
                $chatSettings = new ilSetting('chatroom');
                $this->chat_enabled = $chatSettings->get('chat_enabled');
                $this->osc_enabled  = $chatSettings->get('enable_osc');
 
                $this->lng->loadLanguageModule('chatroom');
        }

References ilObjChatroom\_getPublicRefId().

Here is the call graph for this function:

Member Function Documentation

◆ acceptsMessages()

ilChatUserActionProvider::acceptsMessages ( $a_user_id )

protected

Parameters

int $a_user_id

Returns: bool

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

        {
                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'));
                }
 
                return self::$accepts_messages_cache[$a_user_id];
        }

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

Referenced by collectActionsForTargetUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkUserChatAccess()

ilChatUserActionProvider::checkUserChatAccess ( $a_user_id )

protected

Check user chat access.

Parameters

int $a_user_id

Returns: bool

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

        {
                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];
        }

References $GLOBALS.

Referenced by collectActionsForTargetUser().

Here is the caller graph for this function:

◆ collectActionsForTargetUser()

ilChatUserActionProvider::collectActionsForTargetUser ( $a_target_user )

Collect all actions.

Parameters

int $a_target_user target user

Returns: ilUserActionCollection collection

Reimplemented from ilUserActionProvider.

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

        {
                $coll = ilUserActionCollection::getInstance();
                include_once("./Services/User/Actions/classes/class.ilUserAction.php");
 
                require_once 'Services/User/classes/class.ilObjUser.php';
 
                if(!$this->chat_enabled)
                {
                        return $coll;
                }
 
                if($this->checkUserChatAccess($this->getUserId()))
                {
                        // no chat with user him/herself
                        if ($a_target_user != $this->getUserId())
                        {
                                if($this->checkUserChatAccess($a_target_user))
                                {
                                        $f = new ilUserAction();
                                        $f->setType("invite");
                                        $f->setText($this->lng->txt('chat_invite_public_room'));
                                        $f->setHref('./ilias.php?baseClass=ilRepositoryGUI&amp;ref_id=' . $this->pub_ref_id . '&amp;usr_id=' . $a_target_user . '&amp;cmd=view-invitePD');
                                        $coll->addAction($f);
                                }
                        }
                }
 
                if($this->osc_enabled)
                {
                        $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(array(
                                        '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(array(
                                        'onscreenchat-inact-userid'   => $a_target_user
                                ));
                        }
                        $coll->addAction($f);
                }
 
                return $coll;
        }

References ilObjUser\_lookupLogin(), acceptsMessages(), checkUserChatAccess(), ilUserActionCollection\getInstance(), and ilUserActionProvider\getUserId().

Here is the call graph for this function:

◆ getActionTypes()

ilChatUserActionProvider::getActionTypes ( )

Returns: array[string] keys must be unique action ids (strings), values should be the names of the actions (from ilLanguage)

Reimplemented from ilUserActionProvider.

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

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

◆ getComponentId()

ilChatUserActionProvider::getComponentId ( )

Returns: string component id as defined in services.xml/module.xml

Reimplemented from ilUserActionProvider.

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

        {
                return "chtr";
        }

Field Documentation

◆ $accepts_messages_cache

ilChatUserActionProvider::$accepts_messages_cache = array()

staticprotected

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

◆ $chat_enabled

ilChatUserActionProvider::$chat_enabled = false

protected

Boolean to indicate if the chat is enabled.

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

◆ $osc_enabled

ilChatUserActionProvider::$osc_enabled = false

protected

Boolean to indicate if on screen chat is enabled.

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

◆ $pub_ref_id

ilChatUserActionProvider::$pub_ref_id = 0

protected

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

◆ $user_access

ilChatUserActionProvider::$user_access = array()

staticprotected

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

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

Services/User/Actions/classes/class.ilChatUserActionProvider.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acceptsMessages()

◆ checkUserChatAccess()

◆ collectActionsForTargetUser()

◆ getActionTypes()

◆ getComponentId()

Field Documentation

◆ $accepts_messages_cache

◆ $chat_enabled

◆ $osc_enabled

◆ $pub_ref_id

◆ $user_access