ilExportHTMLStakeholder Class Reference

Inheritance diagram for ilExportHTMLStakeholder:

Collaboration diagram for ilExportHTMLStakeholder:

Public Member Functions
	getId ()
	getOwnerOfNewResources ()
	canBeAccessedByCurrentUser (ResourceIdentification $identification)
	resourceHasBeenDeleted (ResourceIdentification $identification)
	getLocationURIForResourceUsage (ResourceIdentification $identification)
Public Member Functions inherited from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder
	__construct (?int $user_id_of_owner=null)
	setOwner (int $user_id_of_owner)
	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
ilDBInterface	$database = null
Protected Attributes inherited from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder
int	$default_owner
int	$current_user

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

Detailed Description

Definition at line 22 of file class.ilExportHTMLStakeholder.php.

Member Function Documentation

canBeAccessedByCurrentUser()

ilExportHTMLStakeholder::canBeAccessedByCurrentUser

(

ResourceIdentification

$identification

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

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

References $DIC, $ref_id, ilObject\_getAllReferences(), null, 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()

ilExportHTMLStakeholder::getId

(

)

Returns

string not longer than 64 characters

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 27 of file class.ilExportHTMLStakeholder.php.

                           : string
    {
        return 'exp_html';
    }

getLocationURIForResourceUsage()

ilExportHTMLStakeholder::getLocationURIForResourceUsage

(

ResourceIdentification

$identification

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

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

References $ref_id, ilObject\_getAllReferences(), initDB(), null, 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);
        }
        return null;
    }

Here is the call graph for this function:

getOwnerOfNewResources()

ilExportHTMLStakeholder::getOwnerOfNewResources

(

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

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

References ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder\$default_owner.

                                            : int
    {
        return $this->default_owner;
    }

initDB()

ilExportHTMLStakeholder::initDB ( )

private

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

References $DIC, and null.

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()

ilExportHTMLStakeholder::resolveObjectId ( ResourceIdentification  $identification )

private

Definition at line 78 of file class.ilExportHTMLStakeholder.php.

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

Referenced by canBeAccessedByCurrentUser(), and getLocationURIForResourceUsage().

                                                                            : ?int
    {
        $this->initDB();
        $r = $this->database->queryF(
            "SELECT object_id FROM export_files_html WHERE rid = %s;",
            ['text'],
            [$identification->serialize()]
        );
        $d = $this->database->fetchObject($r);

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

Here is the call graph for this function:

Here is the caller graph for this function:

resourceHasBeenDeleted()

ilExportHTMLStakeholder::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 57 of file class.ilExportHTMLStakeholder.php.

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

        return true;
    }

Field Documentation

$database

ilDBInterface ilExportHTMLStakeholder::$database = null

protected

Definition at line 24 of file class.ilExportHTMLStakeholder.php.

---

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

• components/ILIAS/Export/HTML/class.ilExportHTMLStakeholder.php