ilObjFileStakeholder Class Reference

Class ilObjFileStakeholder. More...

Inheritance diagram for ilObjFileStakeholder:

Collaboration diagram for ilObjFileStakeholder:

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

Class ilObjFileStakeholder.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Member Function Documentation

canBeAccessedByCurrentUser()

ilObjFileStakeholder::canBeAccessedByCurrentUser

(

ResourceIdentification

$identification

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 41 of file class.ilObjFileStakeholder.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) {
            if ($DIC->access()->checkAccessOfUser($this->current_user, 'read', '', $ref_id)) {
                return true;
            }
        }

        return false;
    }

Here is the call graph for this function:

getId()

ilObjFileStakeholder::getId

(

)

Returns

string not longer than 64 characters

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

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

                           : string
    {
        return 'file_obj';
    }

getLocationURIForResourceUsage()

ilObjFileStakeholder::getLocationURIForResourceUsage

(

ResourceIdentification

$identification

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 88 of file class.ilObjFileStakeholder.php.

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

                                                                                          : ?string
    {
        $this->initDB();
        $r = $this->database->queryF(
            "SELECT file_id FROM file_data WHERE rid = %s",
            ['text'],
            [$identification->serialize()]
        );
        $d = $this->database->fetchObject($r);
        if ($d !== null && property_exists($d, 'file_id') && $d->file_id !== null) {
            $references = ilObject::_getAllReferences($d->file_id);
            $ref_id = array_shift($references);

            return ilLink::_getLink($ref_id, 'file');
        }
        return null;
    }

Here is the call graph for this function:

getOwnerOfNewResources()

ilObjFileStakeholder::getOwnerOfNewResources

(

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 36 of file class.ilObjFileStakeholder.php.

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

                                            : int
    {
        return $this->default_owner;
    }

initDB()

ilObjFileStakeholder::initDB ( )

private

Definition at line 106 of file class.ilObjFileStakeholder.php.

References $DIC.

Referenced by getLocationURIForResourceUsage(), and resolveObjectId().

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

Here is the caller graph for this function:

resolveObjectId()

ilObjFileStakeholder::resolveObjectId ( ResourceIdentification  $identification )

private

Definition at line 60 of file class.ilObjFileStakeholder.php.

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

Referenced by canBeAccessedByCurrentUser(), and resourceHasBeenDeleted().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

resourceHasBeenDeleted()

ilObjFileStakeholder::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 73 of file class.ilObjFileStakeholder.php.

References resolveObjectId().

                                                                                  : bool
    {
        $object_id = $this->resolveObjectId($identification);
        try {
            $this->database->manipulateF(
                "UPDATE object_data SET offline = 1 WHERE obj_id = %s",
                ['text'],
                [$object_id]
            );
        } catch (Throwable) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$database

ilDBInterface ilObjFileStakeholder::$database = null

protected

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

---

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

• components/ILIAS/File/classes/class.ilObjFileStakeholder.php