ILIAS\ResourceStorage\Manager\ContainerManager Class Reference

Inheritance diagram for ILIAS\ResourceStorage\Manager\ContainerManager:

Collaboration diagram for ILIAS\ResourceStorage\Manager\ContainerManager:

Public Member Functions
	containerFromUpload (UploadResult $result, ResourceStakeholder $stakeholder, ?string $revision_title=null)
	containerFromStream (FileStream $stream, ResourceStakeholder $stakeholder, ?string $revision_title=null)
	createDirectoryInsideContainer (ResourceIdentification $container, string $path_inside_container)
	removePathInsideContainer (ResourceIdentification $container, string $path_inside_container)
	addUploadToContainer (ResourceIdentification $container, UploadResult $result, string $parent_path_inside_container,)
	addStreamToContainer (ResourceIdentification $container, FileStream $stream, string $path_inside_container,)
Public Member Functions inherited from ILIAS\ResourceStorage\Manager\BaseManager
	__construct (protected ResourceBuilder $resource_builder, protected CollectionBuilder $collection_builder, protected RepositoryPreloader $preloader)
	Manager constructor. More...
	publish (ResourceIdentification $rid)
	@description Publish a resource. More...
	unpublish (ResourceIdentification $rid)
	@description Unpublish a resource. More...
	find (string $identification)
	getResource (ResourceIdentification $i)
	remove (ResourceIdentification $identification, ResourceStakeholder $stakeholder)
	clone (ResourceIdentification $identification)
	appendNewRevision (ResourceIdentification $identification, UploadResult $result, ResourceStakeholder $stakeholder, ?string $revision_title=null, bool $draft=false)
	@description Append a new revision from an UploadResult. More...
	replaceWithUpload (ResourceIdentification $identification, UploadResult $result, ResourceStakeholder $stakeholder, ?string $revision_title=null)
	appendNewRevisionFromStream (ResourceIdentification $identification, FileStream $stream, ResourceStakeholder $stakeholder, ?string $revision_title=null, bool $draft=false)
	@description Append a new revision from a stream. More...
	replaceWithStream (ResourceIdentification $identification, FileStream $stream, ResourceStakeholder $stakeholder, ?string $revision_title=null)
	getCurrentRevision (ResourceIdentification $identification)
	getCurrentRevisionIncludingDraft (ResourceIdentification $identification)
	updateRevision (Revision $revision)
	rollbackRevision (ResourceIdentification $identification, int $revision_number)
	removeRevision (ResourceIdentification $identification, int $revision_number)

Private Member Functions
	normalizePath (string $path_inside_container)

Additional Inherited Members
Protected Member Functions inherited from ILIAS\ResourceStorage\Manager\BaseManager
	checkZIP (bool|string $mimetype)
	newStreamBased (FileStream $stream, ResourceStakeholder $stakeholder, ResourceType $type, ?string $revision_title=null)

Detailed Description

Author

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

Definition at line 32 of file ContainerManager.php.

Member Function Documentation

addStreamToContainer()

ILIAS\ResourceStorage\Manager\ContainerManager::addStreamToContainer	(	ResourceIdentification	$container,
		FileStream	$stream,
		string	$path_inside_container
	)

Definition at line 109 of file ContainerManager.php.

     : bool {
        $path_inside_container = $this->normalizePath($path_inside_container);
        if (empty($path_inside_container)) {
            return false;
        }
        return $this->resource_builder->addStreamToContainer(
            $this->getResource($container),
            $stream,
            $path_inside_container
        );
    }

addUploadToContainer()

ILIAS\ResourceStorage\Manager\ContainerManager::addUploadToContainer	(	ResourceIdentification	$container,
		UploadResult	$result,
		string	$parent_path_inside_container
	)

Definition at line 96 of file ContainerManager.php.

     : bool {
        $parent_path_inside_container = $this->normalizePath($parent_path_inside_container);
        return $this->resource_builder->addUploadToContainer(
            $this->getResource($container),
            $result,
            $parent_path_inside_container
        );
    }

containerFromStream()

ILIAS\ResourceStorage\Manager\ContainerManager::containerFromStream	(	FileStream	$stream,
		ResourceStakeholder	$stakeholder,
		?string	$revision_title = null
	)

Definition at line 53 of file ContainerManager.php.

     : ResourceIdentification {
        // check if stream is a ZIP
        $this->checkZIP(mime_content_type($stream->getMetadata()['uri']));
 
        return $this->newStreamBased(
            $stream,
            $stakeholder,
            ResourceType::CONTAINER,
            $revision_title
        );
    }

containerFromUpload()

ILIAS\ResourceStorage\Manager\ContainerManager::containerFromUpload	(	UploadResult	$result,
		ResourceStakeholder	$stakeholder,
		?string	$revision_title = null
	)

Definition at line 42 of file ContainerManager.php.

     : ResourceIdentification {
        // check if stream is a ZIP
        $this->checkZIP(mime_content_type($result->getMimeType()));
 
        return $this->upload($result, $stakeholder, $revision_title);
    }

createDirectoryInsideContainer()

ILIAS\ResourceStorage\Manager\ContainerManager::createDirectoryInsideContainer	(	ResourceIdentification	$container,
		string	$path_inside_container
	)

Definition at line 69 of file ContainerManager.php.

     : bool {
        $path_inside_container = $this->normalizePath($path_inside_container);
        if (empty($path_inside_container)) {
            return false;
        }
        return $this->resource_builder->createDirectoryInsideContainer(
            $this->getResource($container),
            $path_inside_container
        );
    }

normalizePath()

ILIAS\ResourceStorage\Manager\ContainerManager::normalizePath ( string  $path_inside_container )

private

Definition at line 34 of file ContainerManager.php.

                                                                 : string
    {
        // Paths inside a ZIP container must be relative (no leading slash).
        // Some extraction tools (e.g. Windows Explorer) hide entries whose
        // names start with "/". See Mantis 0045580 / 0047237.
        return rtrim(ltrim($path_inside_container, './'), '/');
    }

removePathInsideContainer()

ILIAS\ResourceStorage\Manager\ContainerManager::removePathInsideContainer	(	ResourceIdentification	$container,
		string	$path_inside_container
	)

Definition at line 83 of file ContainerManager.php.

     : bool {
        if (empty($path_inside_container)) {
            return false;
        }
        return $this->resource_builder->removePathInsideContainer(
            $this->getResource($container),
            $path_inside_container
        );
    }

---

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

• components/ILIAS/ResourceStorage/src/Manager/ContainerManager.php