ILIAS\WOPI\Handler\WOPIStakeholderWrapper Class Reference

Inheritance diagram for ILIAS\WOPI\Handler\WOPIStakeholderWrapper:

Collaboration diagram for ILIAS\WOPI\Handler\WOPIStakeholderWrapper:

Public Member Functions
	init (ResourceStakeholder $stakeholder, int $user_id)
	getId ()
	getOwnerOfNewResources ()
	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\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...
	getId ()
	getConsumerNameForPresentation ()
	getFullyQualifiedClassName ()
	canBeAccessedByCurrentUser (ResourceIdentification $identification)
	isResourceInUse (ResourceIdentification $identification)
	resourceHasBeenDeleted (ResourceIdentification $identification)
	getOwnerOfResource (ResourceIdentification $identification)
	getOwnerOfNewResources ()
	getLocationURIForResourceUsage (ResourceIdentification $identification)

Private Attributes
int	$user_id = null
ResourceStakeholder	$stakeholder = null

Additional Inherited Members
Protected Attributes inherited from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder
int	$default_owner
int	$current_user

Detailed Description

Definition at line 27 of file WOPIStakeholderWrapper.php.

Member Function Documentation

canBeAccessedByCurrentUser()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::canBeAccessedByCurrentUser

(

ResourceIdentification

$identification

)

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 63 of file WOPIStakeholderWrapper.php.

                                                                                      : bool
    {
        return $this->stakeholder->canBeAccessedByCurrentUser($identification);
    }

getConsumerNameForPresentation()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::getConsumerNameForPresentation

(

)

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 81 of file WOPIStakeholderWrapper.php.

                                                    : string
    {
        return $this->stakeholder->getConsumerNameForPresentation();
    }

getFullyQualifiedClassName()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::getFullyQualifiedClassName

(

)

Returns

string not longer than 250 characters

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 51 of file WOPIStakeholderWrapper.php.

                                                : string
    {
        return $this->stakeholder->getFullyQualifiedClassName();
    }

getId()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::getId

(

)

Returns

string not longer than 64 characters

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 40 of file WOPIStakeholderWrapper.php.

                           : string
    {
        return $this->stakeholder->getId();
    }

getLocationURIForResourceUsage()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::getLocationURIForResourceUsage

(

ResourceIdentification

$identification

)

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 86 of file WOPIStakeholderWrapper.php.

                                                                                          : ?string
    {
        return $this->stakeholder->getLocationURIForResourceUsage($identification);
    }

getOwnerOfNewResources()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::getOwnerOfNewResources

(

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 45 of file WOPIStakeholderWrapper.php.

                                            : int
    {
        return $this->user_id ?? $this->stakeholder->getOwnerOfNewResources();
    }

getOwnerOfResource()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::getOwnerOfResource

(

ResourceIdentification

$identification

)

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 75 of file WOPIStakeholderWrapper.php.

                                                                              : int
    {
        return $this->stakeholder->getOwnerOfResource($identification);
    }

init()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::init	(	ResourceStakeholder	$stakeholder,
		int	$user_id
	)

Definition at line 33 of file WOPIStakeholderWrapper.php.

                                                                        : void
    {
        $this->user_id = $user_id;
        $this->setOwner($user_id);
        $this->stakeholder = $stakeholder;
    }

References ILIAS\WOPI\Handler\WOPIStakeholderWrapper\$stakeholder, ILIAS\WOPI\Handler\WOPIStakeholderWrapper\$user_id, and ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder\setOwner().

Here is the call graph for this function:

isResourceInUse()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::isResourceInUse

(

ResourceIdentification

$identification

)

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 57 of file WOPIStakeholderWrapper.php.

                                                                           : bool
    {
        return $this->stakeholder->isResourceInUse($identification);
    }

resourceHasBeenDeleted()

ILIAS\WOPI\Handler\WOPIStakeholderWrapper::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.

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 69 of file WOPIStakeholderWrapper.php.

                                                                                  : bool
    {
        return $this->stakeholder->resourceHasBeenDeleted($identification);
    }

Field Documentation

$stakeholder

ResourceStakeholder ILIAS\WOPI\Handler\WOPIStakeholderWrapper::$stakeholder = null

private

Definition at line 30 of file WOPIStakeholderWrapper.php.

Referenced by ILIAS\WOPI\Handler\WOPIStakeholderWrapper\init().

$user_id

int ILIAS\WOPI\Handler\WOPIStakeholderWrapper::$user_id = null

private

Definition at line 29 of file WOPIStakeholderWrapper.php.

Referenced by ILIAS\WOPI\Handler\WOPIStakeholderWrapper\init().

---

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

• components/ILIAS/WOPI/classes/Handler/WOPIStakeholderWrapper.php