Class ilObjPollAccess. More...

Inheritance diagram for ilObjPollAccess:

Collaboration diagram for ilObjPollAccess:

Public Member Functions

__construct ()

Constructor. More...

_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...

canBeDelivered (ilWACPath $ilWACPath)

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	_lookupOnline ($a_obj_id)
	get status More...

static	_isActivated ($a_ref_id)
	Is activated? More...

static	_getCommands ()
	get commands More...

static	_checkGoto ($a_target)
	check whether goto script will succeed More...

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...

Protected Attributes
	$user

	$lng

	$rbacsystem

	$access

Detailed Description

Class ilObjPollAccess.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id: class.ilObjRootFolderAccess.php 15678 2008-01-06 20:40:55Z akill

Definition at line 15 of file class.ilObjPollAccess.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjPollAccess::__construct ( )

Constructor.

Definition at line 41 of file class.ilObjPollAccess.php.

    {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->access = $DIC->access();
    }

References $DIC, and user().

Here is the call graph for this function:

Member Function Documentation

◆ _checkAccess()

ilObjPollAccess::_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)

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 63 of file class.ilObjPollAccess.php.

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $rbacsystem = $this->rbacsystem;
        $ilAccess = $this->access;
 
        if ($a_user_id == "") {
            $a_user_id = $ilUser->getId();
        }
 
        if (
            $a_cmd == 'preview' &&
            $a_permission == 'read'
        ) {
            return false;
        }
        
        // check "global" online switch
        if (!self::_lookupOnline($a_obj_id) &&
            !$rbacsystem->checkAccessOfUser($a_user_id, 'write', $a_ref_id)) {
            $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
            return false;
        }
        
        return true;
    }

References $access, $ilUser, $lng, $rbacsystem, $user, and IL_NO_OBJECT_ACCESS.

◆ _checkGoto()

static ilObjPollAccess::_checkGoto ( $a_target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

Definition at line 157 of file class.ilObjPollAccess.php.

    {
        global $DIC;
 
        $ilAccess = $DIC->access();
        
        $t_arr = explode("_", $a_target);
        
        if ($t_arr[0] != "poll" || ((int) $t_arr[1]) <= 0) {
            return false;
        }
 
        if ($ilAccess->checkAccess("read", "", $t_arr[1])) {
            return true;
        }
        return false;
    }

References $DIC.

◆ _getCommands()

static ilObjPollAccess::_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"), );

Reimplemented from ilObjectAccess.

Definition at line 143 of file class.ilObjPollAccess.php.

    {
        $commands = array(
            array("permission" => "read", "cmd" => "preview", "lang_var" => "show", "default" => true),
            array("permission" => "write", "cmd" => "render", "lang_var" => "edit"),
            // array("permission" => "write", "cmd" => "export", "lang_var" => "export")
        );
        
        return $commands;
    }

Referenced by ilObjPollListGUI\init().

Here is the caller graph for this function:

◆ _isActivated()

static ilObjPollAccess::_isActivated ( $a_ref_id )

static

Is activated?

Parameters

int	$a_obj_id
int	$a_ref_id

Returns: boolean

Definition at line 113 of file class.ilObjPollAccess.php.

    {
        include_once './Services/Object/classes/class.ilObjectActivation.php';
        $item = ilObjectActivation::getItem($a_ref_id);
        switch ($item['timing_type']) {
            case ilObjectActivation::TIMINGS_ACTIVATION:
                if (time() < $item['timing_start'] or
                   time() > $item['timing_end']) {
                    return false;
                }
                // fallthrough
                
                // no break
            default:
                return true;
        }
    }

References ilObjectActivation\getItem(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by ilPollBlock\hasAnyContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupOnline()

static ilObjPollAccess::_lookupOnline ( $a_obj_id )

static

get status

Definition at line 94 of file class.ilObjPollAccess.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $result = $ilDB->query("SELECT * FROM il_poll" .
            " WHERE id = " . $ilDB->quote($a_obj_id, "integer"));
        $row = $ilDB->fetchAssoc($result);
        return $row["online_status"];
    }

References $DIC, $ilDB, and $result.

Referenced by ilObjPollListGUI\getProperties().

Here is the caller graph for this function:

◆ canBeDelivered()

ilObjPollAccess::canBeDelivered ( ilWACPath $ilWACPath )

Parameters

ilWACPath $ilWACPath

Returns: bool

Reimplemented from ilObjectAccess.

Definition at line 181 of file class.ilObjPollAccess.php.

    {
        $ilAccess = $this->access;
        preg_match("/\\/poll_([\\d]*)\\//uism", $ilWACPath->getPath(), $results);
 
        foreach (ilObject2::_getAllReferences($results[1]) as $ref_id) {
            if ($ilAccess->checkAccess('read', '', $ref_id)) {
                return true;
            }
        }
 
        return false;
    }

References $access, $results, ilObject2\_getAllReferences(), and ilWACPath\getPath().

Here is the call graph for this function:

Field Documentation

◆ $access

ilObjPollAccess::$access

protected

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

Referenced by _checkAccess(), and canBeDelivered().

◆ $lng

ilObjPollAccess::$lng

protected

Definition at line 25 of file class.ilObjPollAccess.php.

Referenced by _checkAccess().

◆ $rbacsystem

ilObjPollAccess::$rbacsystem

protected

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

Referenced by _checkAccess().

◆ $user

ilObjPollAccess::$user

protected

Definition at line 20 of file class.ilObjPollAccess.php.

Referenced by _checkAccess().

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

Modules/Poll/classes/class.ilObjPollAccess.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _checkAccess()

◆ _checkGoto()

◆ _getCommands()

◆ _isActivated()

◆ _lookupOnline()

◆ canBeDelivered()

Field Documentation

◆ $access

◆ $lng

◆ $rbacsystem

◆ $user