ILIAS\File\Capabilities\CapabilityBuilder Class Reference

Collaboration diagram for ILIAS\File\Capabilities\CapabilityBuilder:

Public Member Functions
	__construct (private readonly \ilObjFileInfoRepository $file_info_repository, private readonly \ilAccessHandler $access, private readonly \ilCtrlInterface $ctrl, private readonly ActionRepository $action_repository, private readonly Services $http, private readonly URIBuilder $static_url, private readonly TypeResolver $type_resolver=new CoreTypeResolver(), private readonly \ilWorkspaceAccessHandler $workspace_access_handler=new \ilWorkspaceAccessHandler())
	get (Context $context)

Protected Attributes
array	$cache = []

Private Attributes
array	$checks = []

Detailed Description

Author

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

Definition at line 41 of file CapabilityBuilder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\File\Capabilities\CapabilityBuilder::__construct	(	private readonly \ilObjFileInfoRepository	$file_info_repository,
		private readonly \ilAccessHandler	$access,
		private readonly \ilCtrlInterface	$ctrl,
		private readonly ActionRepository	$action_repository,
		private readonly Services	$http,
		private readonly URIBuilder	$static_url,
		private readonly TypeResolver	$type_resolver = new CoreTypeResolver(),
		private readonly \ilWorkspaceAccessHandler	$workspace_access_handler = new \ilWorkspaceAccessHandler()
	)

Definition at line 49 of file CapabilityBuilder.php.

      {
        $this->checks = [
            new ForcedInfo(),
            new Download(),
            new Edit(),
            new EditContent(),
            new Info(),
            new Manage(),
            new None(),
            new Unzip(),
            new ViewContent(),
        ];
    }

Member Function Documentation

get()

ILIAS\File\Capabilities\CapabilityBuilder::get

(

Context

$context

)

This is the order of priorities when using

See also

CapabilityCollection::getBest() which will return the first unlocked Capability

Definition at line 72 of file CapabilityBuilder.php.

                                         : CapabilityCollection
    {
        if (isset($this->cache[$context->getNode()])) {
            return $this->cache[$context->getNode()];
        }
 
        $capabilities = [
            new Capability(Capabilities::FORCED_INFO_PAGE, ...Permissions::ANY()),
            new Capability(Capabilities::VIEW_EXTERNAL, Permissions::VIEW_CONTENT),
            new Capability(Capabilities::EDIT_EXTERNAL, Permissions::EDIT_CONTENT),
            new Capability(Capabilities::DOWNLOAD, Permissions::READ),
            new Capability(Capabilities::MANAGE_VERSIONS, Permissions::WRITE),
            new Capability(Capabilities::EDIT_SETTINGS, Permissions::WRITE),
            new Capability(Capabilities::INFO_PAGE, ...Permissions::ANY()),
            new Capability(Capabilities::NONE, Permissions::NONE),
            new Capability(Capabilities::UNZIP, Permissions::WRITE),
        ];
 
        if ($this->type_resolver->resolveTypeByObjectId($context->getObjectId()) !== 'file') {
            return new CapabilityCollection($capabilities);
        }
 
        $info = $this->file_info_repository->getByObjectId($context->getObjectId());
        $helpers = new CheckHelpers(
            $this->access,
            $this->ctrl,
            $this->action_repository,
            $this->http,
            $this->static_url,
            $this->workspace_access_handler
        );
 
        $calling_id = $context->getCallingId();
 
        if ($calling_id > 0) {
            $this->ctrl->setParameterByClass(\ilObjFileGUI::class, 'ref_id', $calling_id);
        }
 
        foreach ($capabilities as $capability) {
            foreach ($this->checks as $check) {
                if ($check->canUnlock() === $capability->getCapability()) {
                    $capability = $check->maybeUnlock($capability, $helpers, $info, $context);
                    $capability = $check->maybeBuildURI($capability, $helpers, $context);
                }
            }
        }
        return $this->cache[$context->getNode()] = new CapabilityCollection($capabilities);
    }

References $check, $info, ILIAS\Repository\access(), ILIAS\File\Capabilities\ANY, ILIAS\Repository\ctrl(), and ILIAS\FileDelivery\http().

Referenced by ilFileStaticURLHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$cache

array ILIAS\File\Capabilities\CapabilityBuilder::$cache = []

protected

Definition at line 43 of file CapabilityBuilder.php.

$checks

array ILIAS\File\Capabilities\CapabilityBuilder::$checks = []

private

Definition at line 47 of file CapabilityBuilder.php.

---

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

• components/ILIAS/File/classes/Capabilities/CapabilityBuilder.php