ilTermsOfServiceUserHasGlobalRoleCriterion Class Reference

Class ilTermsOfServiceUserHasGlobalRoleCriterion. More...

Inheritance diagram for ilTermsOfServiceUserHasGlobalRoleCriterion:

Collaboration diagram for ilTermsOfServiceUserHasGlobalRoleCriterion:

Public Member Functions
	__construct (ilRbacReview $rbacReview, ilObjectDataCache $objectCache)
	ilTermsOfServiceUserHasGlobalRoleCriterion constructor. More...
	getTypeIdent ()
	Returns a unique id of the criterion type. Returns string More...
	hasUniqueNature ()
	Returns whether or not a criterion is unique by it's nature.Example: "User Language". A user account can only have one profile language . Returns bool More...
	evaluate (ilObjUser $user, ilTermsOfServiceCriterionConfig $config)
	Parameters ilObjUser $user ilTermsOfServiceCriterionConfig $config Returns bool More...
	ui (ilLanguage $lng)
	Parameters ilLanguage $lng Returns ilTermsOfServiceCriterionTypeGUI More...
	getTypeIdent ()
	Returns a unique id of the criterion type. More...
	hasUniqueNature ()
	Returns whether or not a criterion is unique by it's nature. More...
	evaluate (ilObjUser $user, ilTermsOfServiceCriterionConfig $config)
	ui (ilLanguage $lng)

Protected Attributes
	$rbacReview
	$objectCache

Detailed Description

Class ilTermsOfServiceUserHasGlobalRoleCriterion.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

__construct()

ilTermsOfServiceUserHasGlobalRoleCriterion::__construct	(	ilRbacReview	$rbacReview,
		ilObjectDataCache	$objectCache
	)

ilTermsOfServiceUserHasGlobalRoleCriterion constructor.

Parameters

ilRbacReview	$rbacReview
ilObjectDataCache	$objectCache

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

    {
        $this->rbacReview = $rbacReview;
        $this->objectCache = $objectCache;
    }

References $objectCache, and $rbacReview.

Member Function Documentation

evaluate()

ilTermsOfServiceUserHasGlobalRoleCriterion::evaluate	(	ilObjUser	$user,
		ilTermsOfServiceCriterionConfig	$config
	)

Parameters

ilObjUser	$user
ilTermsOfServiceCriterionConfig	$config

Returns

bool

Implements ilTermsOfServiceCriterionType.

Definition at line 46 of file class.ilTermsOfServiceUserHasGlobalRoleCriterion.php.

                                                                                       : bool
    {
        $roleId = $config['role_id'] ?? 0;
 
        if (!is_numeric($roleId) || $roleId < 1 || is_float($roleId)) {
            return false;
        }
 
        if (!$this->rbacReview->isGlobalRole($roleId)) {
            return false;
        }
 
        $result = $this->rbacReview->isAssigned($user->getId(), $roleId);
 
        return $result;
    }

References $config, $result, and ilObject\getId().

Referenced by ilTermsOfServiceUserHasGlobalRoleCriterionTest\testEvaluationFailsIfConfiguredRoleIsNotAGlobalRole(), ilTermsOfServiceUserHasGlobalRoleCriterionTest\testEvaluationFailsIfUserIsNotAssignedToConfiguredGlobalRole(), and ilTermsOfServiceUserHasGlobalRoleCriterionTest\testEvaluationSucceedsIfUserIsAssignedToDefinedGlobalRole().

Here is the call graph for this function:

Here is the caller graph for this function:

getTypeIdent()

ilTermsOfServiceUserHasGlobalRoleCriterion::getTypeIdent

(

)

Returns a unique id of the criterion type.

Returns

string

Implements ilTermsOfServiceCriterionType.

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

                                   : string
    {
        return 'usr_global_role';
    }

hasUniqueNature()

ilTermsOfServiceUserHasGlobalRoleCriterion::hasUniqueNature

(

)

Returns whether or not a criterion is unique by it's nature.Example: "User Language". A user account can only have one profile language .

Returns

bool

Implements ilTermsOfServiceCriterionType.

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

                                      : bool
    {
        return false;
    }

ui()

ilTermsOfServiceUserHasGlobalRoleCriterion::ui

(

ilLanguage

$lng

)

Parameters

ilLanguage

$lng

Returns

ilTermsOfServiceCriterionTypeGUI

Implements ilTermsOfServiceCriterionType.

Definition at line 66 of file class.ilTermsOfServiceUserHasGlobalRoleCriterion.php.

                                        : ilTermsOfServiceCriterionTypeGUI
    {
        return new ilTermsOfServiceUserHasGlobalRoleCriterionGUI($this, $lng, $this->rbacReview, $this->objectCache);
    }

References $lng.

Field Documentation

$objectCache

ilTermsOfServiceUserHasGlobalRoleCriterion::$objectCache

protected

Definition at line 14 of file class.ilTermsOfServiceUserHasGlobalRoleCriterion.php.

Referenced by __construct().

$rbacReview

ilTermsOfServiceUserHasGlobalRoleCriterion::$rbacReview

protected

Definition at line 11 of file class.ilTermsOfServiceUserHasGlobalRoleCriterion.php.

Referenced by __construct().

---

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

• Services/TermsOfService/classes/Criteria/class.ilTermsOfServiceUserHasGlobalRoleCriterion.php