ilIndividualAssessmentAccessHandler Class Reference

Deal with ilias rbac-system More...

Inheritance diagram for ilIndividualAssessmentAccessHandler:

Collaboration diagram for ilIndividualAssessmentAccessHandler:

Public Member Functions
	__construct (ilObjIndividualAssessment $iass, ilAccessHandler $handler, ilRbacAdmin $admin, ilRbacReview $review, ilObjUser $usr)
	checkAccessToObj ($operation)
	Can an user perform an operation on some Individual assessment? Parameters string $operation Returns bool More...
	initDefaultRolesForObject (ilObjIndividualAssessment $iass)
	Create default roles at an object. Parameters ilObjIndividualAssessment $iass More...
	assignUserToMemberRole (ilObjUser $usr, ilObjIndividualAssessment $iass)
	Assign a user to the member role at an Individual assessment. Parameters ilObjIndividualAssessment $iass ilObjUser $usr More...
	deassignUserFromMemberRole (ilObjUser $usr, ilObjIndividualAssessment $iass)
	Deasign a user from the member role at an Individual assessment. Parameters ilObjIndividualAssessment $iass ilObjUser $usr More...
	mayViewObject ($use_cache=true)
	User view iass object. More...
	mayEditObject ($use_cache=true)
	User edit iass. More...
	mayEditPermissions ($use_cache=true)
	User edit permissions. More...
	mayEditMembers ($use_cache=true)
	User may edit members. More...
	mayViewUser ($use_cache=true)
	User may view gradings. More...
	mayGradeUser ($use_cache=true)
	User may grade. More...
	mayGradeUserById ($a_user_id)
	User may grade. More...
	filterViewableOrGradeableUsers (array $a_user_ids)
	Filter out users that may be graded or viewed. More...
	mayAmendGradeUser ($use_cache=true)
	User may Amend grading. More...
	isSystemAdmin ()
	Check whether user is system admin. More...

Data Fields
const	DEFAULT_ROLE = 'il_iass_member'

Protected Member Functions
	getRoleTitleByObj (ilObjIndividualAssessment $iass)
	getMemberRoleIdForObj (ilObjIndividualAssessment $iass)
	cacheCheckAccessToObj ($operation)
	Get permission state from cache. More...

Protected Attributes
	$iass
	$handler
	$admin
	$review
	ilRbacReview More...
	$user
	$mass_global_permissions_cache

Detailed Description

Deal with ilias rbac-system

Definition at line 8 of file class.ilIndividualAssessmentAccessHandler.php.

Constructor & Destructor Documentation

__construct()

ilIndividualAssessmentAccessHandler::__construct	(	ilObjIndividualAssessment	$iass,
		ilAccessHandler	$handler,
		ilRbacAdmin	$admin,
		ilRbacReview	$review,
		ilObjUser	$usr
	)

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

References $admin, $handler, $iass, and $review.

    {
        $this->iass = $iass;
        $this->handler = $handler;
        $this->admin = $admin;
        $this->review = $review;
        $this->usr = $usr;
        $this->mass_global_permissions_cache = array();
    }

Member Function Documentation

assignUserToMemberRole()

ilIndividualAssessmentAccessHandler::assignUserToMemberRole	(	ilObjUser	$usr,
		ilObjIndividualAssessment	$iass
	)

Assign a user to the member role at an Individual assessment.

Parameters

ilObjIndividualAssessment	$iass
ilObjUser	$usr

Implements IndividualAssessmentAccessHandler.

Definition at line 83 of file class.ilIndividualAssessmentAccessHandler.php.

References ilObject\getId(), and getMemberRoleIdForObj().

    {
        return $this->admin->assignUser($this->getMemberRoleIdForObj($iass), $usr->getId());
    }

Here is the call graph for this function:

cacheCheckAccessToObj()

ilIndividualAssessmentAccessHandler::cacheCheckAccessToObj (   $operation )

protected

Get permission state from cache.

Parameters

string

$operation

Returns

bool

Definition at line 268 of file class.ilIndividualAssessmentAccessHandler.php.

References checkAccessToObj().

Referenced by mayAmendGradeUser(), mayEditMembers(), mayEditObject(), mayEditPermissions(), mayGradeUser(), mayViewObject(), and mayViewUser().

    {
        $iass_id = $this->iass->getId();
        $user_id = $this->usr->getId();

        if (!isset($this->mass_global_permissions_cache[$iass_id][$user_id][$operation])) {
            $this->mass_global_permissions_cache[$iass_id][$user_id][$operation]
                = $this->checkAccessToObj($operation);
        }

        return $this->mass_global_permissions_cache[$iass_id][$user_id][$operation];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkAccessToObj()

ilIndividualAssessmentAccessHandler::checkAccessToObj

(

$operation

)

Can an user perform an operation on some Individual assessment?

Parameters

string

$operation

Returns

bool

Implements IndividualAssessmentAccessHandler.

Definition at line 55 of file class.ilIndividualAssessmentAccessHandler.php.

Referenced by cacheCheckAccessToObj(), mayAmendGradeUser(), mayEditMembers(), mayEditObject(), mayEditPermissions(), mayGradeUser(), mayViewObject(), and mayViewUser().

    {
        if ($operation == "read_learning_progress") {
            return $this->handler->checkRbacOrPositionPermissionAccess("read_learning_progress", "read_learning_progress", $this->iass->getRefId());
        }
        if ($operation == "edit_learning_progress") {
            return $this->handler->checkRbacOrPositionPermissionAccess("edit_learning_progress", "write_learning_progress", $this->iass->getRefId());
        }

        return $this->handler->checkAccessOfUser($this->usr->getId(), $operation, '', $this->iass->getRefId(), 'iass');
    }

Here is the caller graph for this function:

deassignUserFromMemberRole()

ilIndividualAssessmentAccessHandler::deassignUserFromMemberRole	(	ilObjUser	$usr,
		ilObjIndividualAssessment	$iass
	)

Deasign a user from the member role at an Individual assessment.

Parameters

ilObjIndividualAssessment	$iass
ilObjUser	$usr

Implements IndividualAssessmentAccessHandler.

Definition at line 91 of file class.ilIndividualAssessmentAccessHandler.php.

References ilObject\getId(), and getMemberRoleIdForObj().

    {
        return $this->admin->deassignUser($this->getMemberRoleIdForObj($iass), $usr->getId());
    }

Here is the call graph for this function:

filterViewableOrGradeableUsers()

ilIndividualAssessmentAccessHandler::filterViewableOrGradeableUsers

(

array

$a_user_ids

)

Filter out users that may be graded or viewed.

Parameters

int[]

$a_user_ids

Returns

int[] $a_user_ids

Definition at line 221 of file class.ilIndividualAssessmentAccessHandler.php.

References ilOrgUnitGlobalSettings\getInstance().

                                                                      : array
    {
        $usr_id = $this->usr->getId();
        $obj_id = $this->iass->getId();
        $ref_id = $this->iass->getRefId();
        if (
            $this->handler->checkAccessOfUser($usr_id, "edit_members", '', $ref_id, 'iass')
            || $this->handler->checkAccessOfUser($usr_id, "read_learning_progress", '', $ref_id, 'iass')
            || $this->handler->checkAccessOfUser($usr_id, "write_learning_progress", '', $ref_id, 'iass')
        ) {
            return $a_user_ids;
        }

        $orgu_settings = ilOrgUnitGlobalSettings::getInstance();
        if (!$orgu_settings->isPositionAccessActiveForObject($obj_id)) {
            return [];
        }

        $viewable_users = $this->handler->filterUserIdsByPositionOfCurrentUser("read_learning_progress", $ref_id, $a_user_ids);
        $gradeable_users = $this->handler->filterUserIdsByPositionOfCurrentUser("write_learning_progress", $ref_id, $a_user_ids);

        return array_unique(array_merge($viewable_users, $gradeable_users));
    }

Here is the call graph for this function:

getMemberRoleIdForObj()

ilIndividualAssessmentAccessHandler::getMemberRoleIdForObj ( ilObjIndividualAssessment  $iass )

protected

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

References ilObject\getRefId().

Referenced by assignUserToMemberRole(), and deassignUserFromMemberRole().

    {
        return current($this->review->getLocalRoles($iass->getRefId()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRoleTitleByObj()

ilIndividualAssessmentAccessHandler::getRoleTitleByObj ( ilObjIndividualAssessment  $iass )

protected

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

References ilObject\getRefId().

Referenced by initDefaultRolesForObject().

    {
        return self::DEFAULT_ROLE . '_' . $iass->getRefId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initDefaultRolesForObject()

ilIndividualAssessmentAccessHandler::initDefaultRolesForObject

(

ilObjIndividualAssessment

$iass

)

Create default roles at an object.

Parameters

ilObjIndividualAssessment

$iass

Implements IndividualAssessmentAccessHandler.

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

References ilObjRole\createDefaultRole(), ilObject\getId(), ilObject\getRefId(), and getRoleTitleByObj().

    {
        $role = ilObjRole::createDefaultRole(
            $this->getRoleTitleByObj($iass),
            "Admin of iass obj_no." . $iass->getId(),
            self::DEFAULT_ROLE,
            $iass->getRefId()
        );
    }

Here is the call graph for this function:

isSystemAdmin()

ilIndividualAssessmentAccessHandler::isSystemAdmin

(

)

Check whether user is system admin.

Returns

bool

Implements IndividualAssessmentAccessHandler.

Definition at line 286 of file class.ilIndividualAssessmentAccessHandler.php.

Referenced by mayEditMembers(), mayEditObject(), mayEditPermissions(), mayGradeUser(), mayGradeUserById(), mayViewObject(), and mayViewUser().

    {
        return $this->review->isAssigned($this->usr->getId(), SYSTEM_ROLE_ID);
    }

Here is the caller graph for this function:

mayAmendGradeUser()

ilIndividualAssessmentAccessHandler::mayAmendGradeUser

(

$use_cache = true

)

User may Amend grading.

Parameters

bool

$use_cache

Returns

bool

Definition at line 252 of file class.ilIndividualAssessmentAccessHandler.php.

References cacheCheckAccessToObj(), and checkAccessToObj().

    {
        if ($use_cache) {
            return $this->cacheCheckAccessToObj('amend_grading');
        }

        return $this->checkAccessToObj('amend_grading');
    }

Here is the call graph for this function:

mayEditMembers()

ilIndividualAssessmentAccessHandler::mayEditMembers

(

$use_cache = true

)

User may edit members.

Parameters

bool

$use_cache

Returns

bool

Definition at line 161 of file class.ilIndividualAssessmentAccessHandler.php.

References cacheCheckAccessToObj(), checkAccessToObj(), and isSystemAdmin().

    {
        if ($use_cache) {
            return $this->cacheCheckAccessToObj('edit_members');
        }

        return $this->isSystemAdmin() || $this->checkAccessToObj('edit_members');
    }

Here is the call graph for this function:

mayEditObject()

ilIndividualAssessmentAccessHandler::mayEditObject

(

$use_cache = true

)

User edit iass.

Parameters

bool

$use_cache

Returns

bool

Definition at line 129 of file class.ilIndividualAssessmentAccessHandler.php.

References cacheCheckAccessToObj(), checkAccessToObj(), and isSystemAdmin().

    {
        if ($use_cache) {
            return $this->cacheCheckAccessToObj('write');
        }

        return $this->isSystemAdmin() || $this->checkAccessToObj('write');
    }

Here is the call graph for this function:

mayEditPermissions()

ilIndividualAssessmentAccessHandler::mayEditPermissions

(

$use_cache = true

)

User edit permissions.

Parameters

bool

$use_cache

Returns

bool

Definition at line 145 of file class.ilIndividualAssessmentAccessHandler.php.

References cacheCheckAccessToObj(), checkAccessToObj(), and isSystemAdmin().

    {
        if ($use_cache) {
            return $this->cacheCheckAccessToObj('edit_permission');
        }

        return $this->isSystemAdmin() || $this->checkAccessToObj('edit_permission');
    }

Here is the call graph for this function:

mayGradeUser()

ilIndividualAssessmentAccessHandler::mayGradeUser

(

$use_cache = true

)

User may grade.

Parameters

bool

$use_cache

Returns

bool

Definition at line 193 of file class.ilIndividualAssessmentAccessHandler.php.

References cacheCheckAccessToObj(), checkAccessToObj(), and isSystemAdmin().

Referenced by mayGradeUserById().

    {
        if ($use_cache) {
            return $this->cacheCheckAccessToObj('edit_learning_progress');
        }

        return $this->isSystemAdmin() || $this->checkAccessToObj('edit_learning_progress');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mayGradeUserById()

ilIndividualAssessmentAccessHandler::mayGradeUserById

(

$a_user_id

)

User may grade.

Parameters

int

$a_user_id

Returns

bool

Definition at line 209 of file class.ilIndividualAssessmentAccessHandler.php.

References isSystemAdmin(), and mayGradeUser().

    {
        return $this->isSystemAdmin()
            || ($this->mayGradeUser() && count($this->handler->filterUserIdsByRbacOrPositionOfCurrentUser("edit_learning_progress", "set_lp", $this->iass->getRefId(), [$a_user_id])) > 0);
    }

Here is the call graph for this function:

mayViewObject()

ilIndividualAssessmentAccessHandler::mayViewObject

(

$use_cache = true

)

User view iass object.

Parameters

bool

$use_cache

Returns

bool

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

References cacheCheckAccessToObj(), checkAccessToObj(), and isSystemAdmin().

    {
        if ($use_cache) {
            return $this->cacheCheckAccessToObj('read');
        }

        return $this->isSystemAdmin() || $this->checkAccessToObj('read');
    }

Here is the call graph for this function:

mayViewUser()

ilIndividualAssessmentAccessHandler::mayViewUser

(

$use_cache = true

)

User may view gradings.

Parameters

bool

$use_cache

Returns

bool

Definition at line 177 of file class.ilIndividualAssessmentAccessHandler.php.

References cacheCheckAccessToObj(), checkAccessToObj(), and isSystemAdmin().

    {
        if ($use_cache) {
            return $this->cacheCheckAccessToObj('read_learning_progress');
        }

        return $this->isSystemAdmin() || $this->checkAccessToObj('read_learning_progress');
    }

Here is the call graph for this function:

Field Documentation

$admin

ilIndividualAssessmentAccessHandler::$admin

protected

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

Referenced by __construct().

$handler

ilIndividualAssessmentAccessHandler::$handler

protected

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

Referenced by __construct().

$iass

ilIndividualAssessmentAccessHandler::$iass

protected

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

Referenced by __construct().

$mass_global_permissions_cache

ilIndividualAssessmentAccessHandler::$mass_global_permissions_cache

protected

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

$review

ilIndividualAssessmentAccessHandler::$review

protected

ilRbacReview

Definition at line 28 of file class.ilIndividualAssessmentAccessHandler.php.

Referenced by __construct().

$user

ilIndividualAssessmentAccessHandler::$user

protected

Definition at line 33 of file class.ilIndividualAssessmentAccessHandler.php.

DEFAULT_ROLE

const ilIndividualAssessmentAccessHandler::DEFAULT_ROLE = 'il_iass_member'

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

---

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

• Modules/IndividualAssessment/classes/AccessControl/class.ilIndividualAssessmentAccessHandler.php