ilObjChatroomAccess Class Reference

Access class for chatroom objects. More...

Inheritance diagram for ilObjChatroomAccess:

Collaboration diagram for ilObjChatroomAccess:

Public Member Functions
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	canBeDelivered (ilWACPath $ilWACPath)
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	canBeDelivered (ilWACPath $ilWACPath)
	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	lookupOnline (int $a_obj_id)
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	_isOffline (int $obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...
static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

Static Private Member Functions
static	checkRoomAccess (string $a_permission, int $a_ref_id, int $a_obj_id, int $a_user_id)

Static Private Attributes
static bool	$chat_enabled = null

Detailed Description

Access class for chatroom objects.

Author

Jan Posselt <jposselt at databay.de>

Version

$Id$ \

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

Member Function Documentation

_checkAccess()

ilObjChatroomAccess::_checkAccess	(	string	$cmd,
		string	$permission,
		int	$ref_id,
		int	$obj_id,
		?int	$user_id = null
	)

Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess)

Please do not check any preconditions handled by ilConditionHandler here. Also don't do any RBAC checks.

Reimplemented from ilObjectAccess.

Definition at line 56 of file class.ilObjChatroomAccess.php.

                                                                                                                 : bool
    {
        if (!$user_id) {
            $user_id = $GLOBALS['DIC']->user()->getId();
        }
 
        return self::checkRoomAccess($permission, $ref_id, $obj_id, (int) $user_id);
    }

References $GLOBALS, $ref_id, $user_id, and checkRoomAccess().

Here is the call graph for this function:

_checkGoto()

static ilObjChatroomAccess::_checkGoto ( string  $target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

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

                                                     : bool
    {
        $t_arr = explode('_', $target);
 
        if (count($t_arr) < 2 || $t_arr[0] !== 'chtr' || ((int) $t_arr[1]) <= 0) {
            return false;
        }
 
        if (ilChatroom::checkUserPermissions('visible', (int) $t_arr[1], false) ||
            ilChatroom::checkUserPermissions('read', (int) $t_arr[1], false)) {
            return true;
        }
 
        return false;
    }

References ilChatroom\checkUserPermissions().

Here is the call graph for this function:

_getCommands()

static ilObjChatroomAccess::_getCommands ( )

static

get commands

this method returns an array of all possible commands/permission combinations

example: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), );

Returns

array{permission?:string, cmd?:string, lang_var?:string, default?:bool}[]

Reimplemented from ilObjectAccess.

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

                                         : array
    {
        $commands = [];
        $commands[] = ['permission' => 'read', 'cmd' => 'view', 'lang_var' => 'enter', 'default' => true];
        $commands[] = ['permission' => 'write', 'cmd' => 'settings-general', 'lang_var' => 'settings'];
 
        return $commands;
    }

Referenced by ilObjChatroomListGUI\init().

Here is the caller graph for this function:

canBeDelivered()

ilObjChatroomAccess::canBeDelivered

(

ilWACPath

$ilWACPath

)

Reimplemented from ilObjectAccess.

Definition at line 101 of file class.ilObjChatroomAccess.php.

                                                        : bool
    {
        return false;
    }

checkRoomAccess()

static ilObjChatroomAccess::checkRoomAccess ( string  $a_permission, int  $a_ref_id, int  $a_obj_id, int  $a_user_id  )

staticprivate

Definition at line 65 of file class.ilObjChatroomAccess.php.

                                                                                                               : bool
    {
        global $DIC;
 
        if (self::$chat_enabled === null) {
            $chatSetting = new ilSetting('chatroom');
            self::$chat_enabled = (bool) $chatSetting->get('chat_enabled', '0');
        }
 
        $hasWriteAccess = $DIC->rbac()->system()->checkAccessOfUser($a_user_id, 'write', $a_ref_id);
        if ($hasWriteAccess) {
            return true;
        }
 
        switch ($a_permission) {
            case 'read':
            case 'visible':
                $is_online = self::lookupOnline($a_obj_id);
                if (!$is_online) {
                    $DIC->access()->addInfoItem(
                        ilAccessInfo::IL_NO_OBJECT_ACCESS,
                        $DIC->language()->txt('offline')
                    );
                    return false;
                }
                break;
        }
 
        return self::$chat_enabled;
    }

References $chat_enabled, $DIC, ilAccessInfo\IL_NO_OBJECT_ACCESS, and lookupOnline().

Referenced by _checkAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

lookupOnline()

static ilObjChatroomAccess::lookupOnline ( int  $a_obj_id )

static

Definition at line 96 of file class.ilObjChatroomAccess.php.

                                                      : bool
    {
        return !ilObject::lookupOfflineStatus($a_obj_id);
    }

References ilObject\lookupOfflineStatus().

Referenced by checkRoomAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$chat_enabled

bool ilObjChatroomAccess::$chat_enabled = null

staticprivate

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

Referenced by checkRoomAccess().

---

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

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