ilLTIConsumerAccess Class Reference

Collaboration diagram for ilLTIConsumerAccess:

Public Member Functions
	__construct (ilObjLTIConsumer $object)
	ilLTIConsumerAccess constructor. More...
	hasWriteAccess ()
	hasOutcomesAccess ()
	hasEditPermissionsAccess ()
	hasLearningProgressAccess ()
	hasStatementsAccess ()
	hasHighscoreAccess ()

Static Public Member Functions
static	getInstance (ilObjLTIConsumer $object)
static	hasCustomProviderCreationAccess ()

Data Fields
const	GLOBAL_ADMIN_ROLE_ID = 2

Protected Member Functions
	checkAccess ($permission)

Protected Attributes
	$object

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilLTIConsumerAccess::__construct

(

ilObjLTIConsumer

$object

)

ilLTIConsumerAccess constructor.

Parameters

ilObjLTIConsumer

$object

Definition at line 26 of file class.ilLTIConsumerAccess.php.

    {
        $this->object = $object;
    }

References $object.

Member Function Documentation

checkAccess()

ilLTIConsumerAccess::checkAccess (   $permission )

protected

Parameters

$permission

Returns

bool

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

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        return $DIC->access()->checkAccess(
            $permission,
            '',
            $this->object->getRefId(),
            $this->object->getType(),
            $this->object->getId()
        );
    }

References $DIC.

Referenced by hasEditPermissionsAccess(), hasOutcomesAccess(), and hasWriteAccess().

Here is the caller graph for this function:

getInstance()

static ilLTIConsumerAccess::getInstance ( ilObjLTIConsumer  $object )

static

Parameters

ilObjLTIConsumer

$object

Returns

ilLTIConsumerAccess

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

    {
        return new self($object);
    }

References $object.

Referenced by ilLTIConsumerScoringGUI\__construct(), and ilLTIConsumerXapiStatementsGUI\__construct().

Here is the caller graph for this function:

hasCustomProviderCreationAccess()

static ilLTIConsumerAccess::hasCustomProviderCreationAccess ( )

static

Returns

bool

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

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        return $DIC->rbac()->system()->checkAccess(
            'add_consume_provider',
            ilObjLTIAdministration::lookupLTISettingsRefId()
        );
    }

References $DIC, and ilObjLTIAdministration\lookupLTISettingsRefId().

Referenced by ilObjLTIConsumerGUI\afterSave(), ilObjLTIConsumerGUI\initCreationForms(), and ilObjLTIConsumerGUI\saveCustom().

Here is the call graph for this function:

Here is the caller graph for this function:

hasEditPermissionsAccess()

ilLTIConsumerAccess::hasEditPermissionsAccess

(

)

Definition at line 64 of file class.ilLTIConsumerAccess.php.

    {
        return $this->checkAccess('edit_permission');
    }

References checkAccess().

Here is the call graph for this function:

hasHighscoreAccess()

ilLTIConsumerAccess::hasHighscoreAccess

(

)

Returns

bool

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

    {
        if (!$this->object->getUseXapi()) {
            return false;
        }
        
        if ($this->object->getHighscoreEnabled()) {
            return true;
        }
        
        return $this->hasOutcomesAccess();
    }

References hasOutcomesAccess().

Here is the call graph for this function:

hasLearningProgressAccess()

ilLTIConsumerAccess::hasLearningProgressAccess

(

)

Returns

bool

Definition at line 72 of file class.ilLTIConsumerAccess.php.

    {
        return ilLearningProgressAccess::checkAccess($this->object->getRefId());
    }

References ilLearningProgressAccess\checkAccess().

Here is the call graph for this function:

hasOutcomesAccess()

ilLTIConsumerAccess::hasOutcomesAccess

(

)

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

    {
        if ($this->checkAccess('read_outcomes')) {
            return true;
        }
        
        return false;
    }

References checkAccess().

Referenced by hasHighscoreAccess(), and hasStatementsAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

hasStatementsAccess()

ilLTIConsumerAccess::hasStatementsAccess

(

)

Returns

bool

Definition at line 80 of file class.ilLTIConsumerAccess.php.

    {
        if (!$this->object->getUseXapi()) {
            return false;
        }
        
        if ($this->object->isStatementsReportEnabled()) {
            return true;
        }
        
        return $this->hasOutcomesAccess();
    }

References hasOutcomesAccess().

Here is the call graph for this function:

hasWriteAccess()

ilLTIConsumerAccess::hasWriteAccess

(

)

Definition at line 48 of file class.ilLTIConsumerAccess.php.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        return $this->checkAccess('write');
    }

References $DIC, and checkAccess().

Here is the call graph for this function:

Field Documentation

$object

ilLTIConsumerAccess::$object

protected

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

Referenced by __construct(), and getInstance().

GLOBAL_ADMIN_ROLE_ID

const ilLTIConsumerAccess::GLOBAL_ADMIN_ROLE_ID = 2

Definition at line 16 of file class.ilLTIConsumerAccess.php.

---

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

• Modules/LTIConsumer/classes/class.ilLTIConsumerAccess.php