ilObjChatroomAccess Class Reference

Access class for chatroom objects. More...

Inheritance diagram for ilObjChatroomAccess:

Collaboration diagram for ilObjChatroomAccess:

Public Member Functions
	_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")
	{Checks wether 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. Parameters string $a_cmd command (not permission!) string $a_permission permission int $a_ref_id reference id int $a_obj_id object id int $a_user_id user id (if not provided, current user is taken) Returns boolean true, if everything is ok } More...
	canBeDelivered (ilWACPath $ilWACPath)
	Parameters ilWACPath $ilWACPath Returns bool More...
Public Member Functions inherited from ilObjectAccess
	_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")
	Checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	_checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_id)
	check condition More...
	canBeDelivered (ilWACPath $ilWACPath)
	Parameters ilWACPath $ilWACPath Returns bool More...
	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	_getCommands ()
	{get commandsthis method returns an array of all possible commands/permission combinationsexample: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), );} More...
static	_checkGoto ($a_target)
	{check whether goto script will succeed} More...
static	checkRoomAccess ($a_permission, $a_ref_id, $a_obj_id, $a_user_id)
static	isActivated ($refId, $objId, &$a_visible_flag=null)
static	lookupOnline ($a_obj_id)
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto ($a_target)
	check whether goto script will succeed More...
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...
static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Static Private Attributes
static	$chat_enabled = null

Detailed Description

Access class for chatroom objects.

Author

Jan Posselt <jposselt at databay.de>

Version

$Id$

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

Member Function Documentation

_checkAccess()

ilObjChatroomAccess::_checkAccess	(		$a_cmd,
			$a_permission,
			$a_ref_id,
			$a_obj_id,
			$a_user_id = ""
	)

{Checks wether 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.

Parameters

string	$a_cmd	command (not permission!)
string	$a_permission	permission
int	$a_ref_id	reference id
int	$a_obj_id	object id
int	$a_user_id	user id (if not provided, current user is taken)

Returns

boolean true, if everything is ok

}

Reimplemented from ilObjectAccess.

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

    {
        if ($a_user_id == '') {
            $a_user_id = $GLOBALS['DIC']->user()->getId();
        }
 
        return self::checkRoomAccess($a_permission, $a_ref_id, $a_obj_id, $a_user_id);
    }

References $GLOBALS, and checkRoomAccess().

Here is the call graph for this function:

_checkGoto()

static ilObjChatroomAccess::_checkGoto (   $a_target )

static

{check whether goto script will succeed}

Reimplemented from ilObjectAccess.

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

    {
        if (is_string($a_target)) {
            $t_arr = explode("_", $a_target);
 
            if (count($t_arr) < 2 || $t_arr[0] != 'chtr' || ((int) $t_arr[1]) <= 0) {
                return false;
            }
 
            if (
                ilChatroom::checkUserPermissions('visible', $t_arr[1], false) ||
                ilChatroom::checkUserPermissions('read', $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 commandsthis method returns an array of all possible commands/permission combinationsexample: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), );}

Reimplemented from ilObjectAccess.

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

    {
        $commands = array();
        $commands[] = array("permission" => "read", "cmd" => "view", "lang_var" => "enter", "default" => true);
        $commands[] = array("permission" => "write", "cmd" => "settings-general", "lang_var" => "settings");
 
        // alex 3 Oct 2012: this leads to a blank screen, i guess it is a copy/paste bug from files
        //$commands[] = array("permission" => "write", "cmd" => "versions", "lang_var" => "versions");
 
        return $commands;
    }

Referenced by ilObjChatroomListGUI\init().

Here is the caller graph for this function:

canBeDelivered()

ilObjChatroomAccess::canBeDelivered

(

ilWACPath

$ilWACPath

)

Parameters

ilWACPath

$ilWACPath

Returns

bool

Reimplemented from ilObjectAccess.

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

    {
        if (preg_match("/chatroom\\/smilies\\//ui", $ilWACPath->getPath())) {
            return true;
        }
 
        return false;
    }

References ilWACPath\getPath().

Here is the call graph for this function:

checkRoomAccess()

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

static

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

    {
        if (self::$chat_enabled === null) {
            $chatSetting = new ilSetting('chatroom');
            self::$chat_enabled = (boolean) $chatSetting->get('chat_enabled');
        }
 
        if ($GLOBALS['DIC']->rbac()->system()->checkAccessOfUser($a_user_id, 'write', $a_ref_id)) {
            return true;
        }
 
        switch ($a_permission) {
            case 'visible':
                $visible = null;
 
                $active = self::isActivated($a_ref_id, $a_obj_id, $visible);
                $hasWriteAccess = $GLOBALS['DIC']->rbac()->system()->checkAccessOfUser($a_user_id, 'write', $a_ref_id);
 
                if (!$active) {
                    $GLOBALS['DIC']->access()->addInfoItem(IL_NO_OBJECT_ACCESS, $GLOBALS['DIC']->language()->txt('offline'));
                }
 
                if (!$hasWriteAccess && !$active && !$visible) {
                    return false;
                }
                break;
 
            case 'read':
                $hasWriteAccess = $GLOBALS['DIC']->rbac()->system()->checkAccessOfUser($a_user_id, 'write', $a_ref_id);
                if ($hasWriteAccess) {
                    return true;
                }
 
                $active = self::isActivated($a_ref_id, $a_obj_id);
                if (!$active) {
                    $GLOBALS['DIC']->access()->addInfoItem(IL_NO_OBJECT_ACCESS, $GLOBALS['DIC']->language()->txt('offline'));
                    return false;
                }
                break;
        }
 
        return self::$chat_enabled;
    }

References $chat_enabled, $GLOBALS, IL_NO_OBJECT_ACCESS, isActivated(), and language().

Referenced by _checkAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

isActivated()

static ilObjChatroomAccess::isActivated (   $refId,   $objId, &  $a_visible_flag = null  )

static

Parameters

int	$refId
int	$objId
null	$a_visible_flag

Returns

bool

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

    {
        if (!self::lookupOnline($objId)) {
            $a_visible_flag = false;
            return false;
        }
 
        $a_visible_flag = true;
 
        require_once 'Services/Object/classes/class.ilObjectActivation.php';
        $item = ilObjectActivation::getItem($refId);
        switch ($item['timing_type']) {
            case ilObjectActivation::TIMINGS_ACTIVATION:
                if (time() < $item['timing_start'] || time() > $item['timing_end']) {
                    $a_visible_flag = $item['visible'];
                    return false;
                }
 
                // no break
            default:
                return true;
        }
    }

References $objId, $refId, ilObjectActivation\getItem(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by ilChatroom\checkPermissions(), and checkRoomAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

lookupOnline()

static ilObjChatroomAccess::lookupOnline (   $a_obj_id )

static

Parameters

int

$a_obj_id

Returns

bool

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

    {
        global $DIC;
 
        $res = $DIC->database()->query("SELECT online_status FROM chatroom_settings WHERE object_id = " . $DIC->database()->quote($a_obj_id, 'integer'));
        $row = $DIC->database()->fetchAssoc($res);
 
        return (bool) $row['online_status'];
    }

References $DIC, and $res.

Field Documentation

$chat_enabled

ilObjChatroomAccess::$chat_enabled = null

staticprivate

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

Referenced by checkRoomAccess().

---

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

• Modules/Chatroom/classes/class.ilObjChatroomAccess.php