ilChatUserActionProvider Class Reference

Adds link to chat. More...

Inheritance diagram for ilChatUserActionProvider:

Collaboration diagram for ilChatUserActionProvider:

Public Member Functions
	__construct ()
	Constructor. More...
	getComponentId ()
	getActionTypes ()
	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 ()
	getJsScripts ($a_action_type)
	Get js scripts. More...

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 11 of file class.ilChatUserActionProvider.php.

Constructor & Destructor Documentation

__construct()

ilChatUserActionProvider::__construct

(

)

Constructor.

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

References ilObjChatroom\_getPublicRefId().

    {
        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');
    }

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 95 of file class.ilChatUserActionProvider.php.

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

Referenced by collectActionsForTargetUser().

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

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 82 of file class.ilChatUserActionProvider.php.

References $GLOBALS.

Referenced by collectActionsForTargetUser().

    {
        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

(

$a_target_user

)

Collect all actions.

Parameters

int

$a_target_user

target user

Returns

ilUserActionCollection collection

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

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

    {
        $coll = ilUserActionCollection::getInstance();

        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_invite_public_room'));
                $f->setHref('./ilias.php?baseClass=ilRepositoryGUI&ref_id=' . $this->pub_ref_id . '&usr_id=' . $a_target_user . '&cmd=view-invitePD');
                $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(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;
    }

Here is the call graph for this function:

getActionTypes()

ilChatUserActionProvider::getActionTypes

(

)

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

References array.

    {
        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

(

)

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

    {
        return "chtr";
    }

Field Documentation

$accepts_messages_cache

ilChatUserActionProvider::$accepts_messages_cache = array()

staticprotected

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

$chat_enabled

ilChatUserActionProvider::$chat_enabled = false

protected

Boolean to indicate if the chat is enabled.

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

$osc_enabled

ilChatUserActionProvider::$osc_enabled = false

protected

Boolean to indicate if on screen chat is enabled.

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

$pub_ref_id

ilChatUserActionProvider::$pub_ref_id = 0

protected

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

$user_access

ilChatUserActionProvider::$user_access = array()

staticprotected

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

---

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

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