ilExcInstructionFilesStakeholder Class Reference

Inheritance diagram for ilExcInstructionFilesStakeholder:

Collaboration diagram for ilExcInstructionFilesStakeholder:

Public Member Functions
	__construct (int $owner=6)
	ilObjFileStakeholder constructor. More...
	getId ()
	getOwnerOfNewResources ()
	canBeAccessedByCurrentUser (ResourceIdentification $identification)
	resourceHasBeenDeleted (ResourceIdentification $identification)
	getLocationURIForResourceUsage (ResourceIdentification $identification)
Public Member Functions inherited from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder
	getFullyQualifiedClassName ()
	isResourceInUse (ResourceIdentification $identification)
	canBeAccessedByCurrentUser (ResourceIdentification $identification)
	resourceHasBeenDeleted (ResourceIdentification $identification)
	getOwnerOfResource (ResourceIdentification $identification)
	getConsumerNameForPresentation ()
	getLocationURIForResourceUsage (ResourceIdentification $identification)
Public Member Functions inherited from ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder
	__construct ()
	Constructor must not have any parameters. More...

Protected Attributes
int	$owner = 6
ilDBInterface	$database = null

Private Member Functions
	resolveObjectId (ResourceIdentification $identification)
	initDB ()

Private Attributes
int	$current_user

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

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

Constructor & Destructor Documentation

__construct()

ilExcInstructionFilesStakeholder::__construct

(

int

$owner = 6

)

ilObjFileStakeholder constructor.

Definition at line 37 of file class.ilExcInstructionFilesStakeholder.php.

References $DIC, $owner, ANONYMOUS_USER_ID, and ILIAS\Repository\int().

    {
        global $DIC;
        $this->current_user = (int) ($DIC->isDependencyAvailable('user')
            ? $DIC->user()->getId()
            : (defined('ANONYMOUS_USER_ID') ? ANONYMOUS_USER_ID : 6));
        $this->owner = $owner;
    }

Here is the call graph for this function:

Member Function Documentation

canBeAccessedByCurrentUser()

ilExcInstructionFilesStakeholder::canBeAccessedByCurrentUser

(

ResourceIdentification

$identification

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 56 of file class.ilExcInstructionFilesStakeholder.php.

References $DIC, $ref_id, ilObject\_getAllReferences(), and resolveObjectId().

                                                                                      : bool
    {
        global $DIC;

        $object_id = $this->resolveObjectId($identification);
        if ($object_id === null) {
            return true;
        }

        $ref_ids = ilObject2::_getAllReferences($object_id);
        foreach ($ref_ids as $ref_id) {
            // one must have read permissions on the exercise to see the instruction files
            if ($DIC->access()->checkAccessOfUser($this->current_user, 'read', '', $ref_id)) {
                return true;
            }
        }

        return false;
    }

Here is the call graph for this function:

getId()

ilExcInstructionFilesStakeholder::getId

(

)

Returns

string not longer than 64 characters

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

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

                           : string
    {
        return 'exc_instruction_files';
    }

getLocationURIForResourceUsage()

ilExcInstructionFilesStakeholder::getLocationURIForResourceUsage

(

ResourceIdentification

$identification

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

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

References $ref_id, ilObject\_getAllReferences(), initDB(), and resolveObjectId().

                                                                                          : ?string
    {
        $this->initDB();
        $object_id = $this->resolveObjectId($identification);
        if ($object_id !== null) {
            $references = ilObject::_getAllReferences($object_id);
            $ref_id = array_shift($references);

            // we currently deliver the goto-url of the exercise in which the resource is used. if possible, you could deliver a more speficic url wo the assignment as well.
            return ilLink::_getLink($ref_id, 'exc');
        }
        return null;
    }

Here is the call graph for this function:

getOwnerOfNewResources()

ilExcInstructionFilesStakeholder::getOwnerOfNewResources

(

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 51 of file class.ilExcInstructionFilesStakeholder.php.

References $owner.

                                            : int
    {
        return $this->owner;
    }

initDB()

ilExcInstructionFilesStakeholder::initDB ( )

private

Definition at line 110 of file class.ilExcInstructionFilesStakeholder.php.

References $DIC.

Referenced by getLocationURIForResourceUsage(), and resolveObjectId().

                             : void
    {
        global $DIC;
        if ($this->database === null) {
            $this->database = $DIC->database();
        }
    }

Here is the caller graph for this function:

resolveObjectId()

ilExcInstructionFilesStakeholder::resolveObjectId ( ResourceIdentification  $identification )

private

Definition at line 97 of file class.ilExcInstructionFilesStakeholder.php.

References Vendor\Package\$d, $r, initDB(), and ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Referenced by canBeAccessedByCurrentUser(), and getLocationURIForResourceUsage().

                                                                            : ?int
    {
        $this->initDB();
        $r = $this->database->queryF(
            "SELECT exc_id, rcid FROM il_resource_rca JOIN exc_assignment ON exc_assignment.if_rcid = il_resource_rca.rcid WHERE il_resource_rca.rid = %s;",
            ['text'],
            [$identification->serialize()]
        );
        $d = $this->database->fetchObject($r);

        return (isset($d->exc_id) ? (int) $d->exc_id : null);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resourceHasBeenDeleted()

ilExcInstructionFilesStakeholder::resourceHasBeenDeleted

(

ResourceIdentification

$identification

)

Returns

bool true: if the Stakeholder could handle the deletion; false: if the Stakeholder could not handle the deletion of the resource.

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 76 of file class.ilExcInstructionFilesStakeholder.php.

                                                                                  : bool
    {
        // at this place we could handle de deletion of a resource. not needed for instruction files IMO.

        return true;
    }

Field Documentation

$current_user

int ilExcInstructionFilesStakeholder::$current_user

private

Definition at line 31 of file class.ilExcInstructionFilesStakeholder.php.

$database

ilDBInterface ilExcInstructionFilesStakeholder::$database = null

protected

Definition at line 32 of file class.ilExcInstructionFilesStakeholder.php.

$owner

int ilExcInstructionFilesStakeholder::$owner = 6

protected

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

Referenced by __construct(), and getOwnerOfNewResources().

---

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

• Modules/Exercise/InstructionFile/class.ilExcInstructionFilesStakeholder.php