Inheritance diagram for ILIAS\ResourceStorage\Manager\BaseManager:

Collaboration diagram for ILIAS\ResourceStorage\Manager\BaseManager:

Public Member Functions
	__construct (ResourceBuilder $resource_builder, CollectionBuilder $collection_builder, RepositoryPreloader $preloader)
	Manager constructor. More...

	publish (ResourceIdentification $rid)
	Publish a resource. More...

	unpublish (ResourceIdentification $rid)
	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)
	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)
	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)

Protected Member Functions
	checkZIP (bool\|string $mimetype)

	newStreamBased (FileStream $stream, ResourceStakeholder $stakeholder, ResourceType $type, string $revision_title=null)

Protected Attributes
ResourceBuilder	$resource_builder

CollectionBuilder	$collection_builder

RepositoryPreloader	$preloader

Detailed Description

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

Definition at line 40 of file BaseManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\ResourceStorage\Manager\BaseManager::__construct	(	ResourceBuilder	$resource_builder,
		CollectionBuilder	$collection_builder,
		RepositoryPreloader	$preloader
	)

Manager constructor.

Definition at line 49 of file BaseManager.php.

References ILIAS\ResourceStorage\Manager\BaseManager\$collection_builder, ILIAS\ResourceStorage\Manager\BaseManager\$preloader, and ILIAS\ResourceStorage\Manager\BaseManager\$resource_builder.

       {
         $this->resource_builder = $resource_builder;
         $this->collection_builder = $collection_builder;
         $this->preloader = $preloader;
     }

Member Function Documentation

◆ appendNewRevision()

ILIAS\ResourceStorage\Manager\BaseManager::appendNewRevision	(	ResourceIdentification	$identification,
		UploadResult	$result,
		ResourceStakeholder	$stakeholder,
		string	$revision_title = `null`,
		bool	$draft = `false`
	)

Append a new revision from an UploadResult.

By passing $draft = true, the revision will be created as a DRAFT on top of the current revision. Consumers will always use the latest published revision. Appending new Revisions is not possible if the latest revision is already a DRAFT. In this case, the DRAFT will be updated.

Definition at line 155 of file BaseManager.php.

References ILIAS\ResourceStorage\Manager\BaseManager\checkZIP(), ILIAS\ResourceStorage\Resource\CONTAINER, ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\FileUpload\DTO\UploadResult\getMimeType(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder\getOwnerOfNewResources(), ILIAS\FileUpload\DTO\UploadResult\getStatus(), ILIAS\FileUpload\DTO\UploadResult\isOK(), and ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

      : Revision {
         if ($result->isOK()) {
             if (!$this->resource_builder->has($identification)) {
                 throw new \LogicException(
                     "Resource not found, can't append new version in: " . $identification->serialize()
                 );
             }
             $resource = $this->resource_builder->get($identification);
             if ($resource->getType() === ResourceType::CONTAINER) {
                 $this->checkZIP($result->getMimeType());
             }
 
             $info_resolver = new UploadInfoResolver(
                 $result,
                 $resource->getMaxRevision(true) + 1,
                 $stakeholder->getOwnerOfNewResources(),
                 $revision_title ?? $result->getName()
             );
 
             $this->resource_builder->append(
                 $resource,
                 $result,
                 $info_resolver,
                 $draft ? RevisionStatus::DRAFT : RevisionStatus::PUBLISHED
             );
             $resource->addStakeholder($stakeholder);
 
             $this->resource_builder->store($resource);
 
             return $resource->getCurrentRevisionIncludingDraft();
         }
         throw new \LogicException("Can't handle UploadResult: " . $result->getStatus()->getMessage());
     }

Here is the call graph for this function:

◆ appendNewRevisionFromStream()

ILIAS\ResourceStorage\Manager\BaseManager::appendNewRevisionFromStream	(	ResourceIdentification	$identification,
		FileStream	$stream,
		ResourceStakeholder	$stakeholder,
		string	$revision_title = `null`,
		bool	$draft = `false`
	)

Append a new revision from a stream.

By passing $draft = true, the revision will be created as a DRAFT on top of the current revision. Consumers will always use the latest published revision. Appending new Revisions is not possible if the latest revision is already a DRAFT. In this case, the DRAFT will be updated.

Definition at line 248 of file BaseManager.php.

References ILIAS\ResourceStorage\Manager\BaseManager\checkZIP(), ILIAS\ResourceStorage\Resource\CONTAINER, ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder\getOwnerOfNewResources(), and ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

      : Revision {
         if (!$this->resource_builder->has($identification)) {
             throw new \LogicException(
                 "Resource not found, can't append new version in: " . $identification->serialize()
             );
         }
 
         $resource = $this->resource_builder->get($identification);
         if ($resource->getType() === ResourceType::CONTAINER) {
             $this->checkZIP(mime_content_type($stream->getMetadata()['uri']));
         }
         $info_resolver = new StreamInfoResolver(
             $stream,
             $resource->getMaxRevision(true) + 1,
             $stakeholder->getOwnerOfNewResources(),
             $revision_title ?? $stream->getMetadata()['uri']
         );
 
         $this->resource_builder->appendFromStream(
             $resource,
             $stream,
             $info_resolver,
             $draft ? RevisionStatus::DRAFT : RevisionStatus::PUBLISHED,
             true
         );
 
         $resource->addStakeholder($stakeholder);
 
         $this->resource_builder->store($resource);
 
         return $resource->getCurrentRevisionIncludingDraft();
     }

Here is the call graph for this function:

◆ checkZIP()

ILIAS\ResourceStorage\Manager\BaseManager::checkZIP ( bool|string $mimetype )

protected

Parameters

bool | string $mimetype

Returns: void

Definition at line 63 of file BaseManager.php.

Referenced by ILIAS\ResourceStorage\Manager\BaseManager\appendNewRevision(), ILIAS\ResourceStorage\Manager\BaseManager\appendNewRevisionFromStream(), ILIAS\ResourceStorage\Manager\ContainerManager\containerFromStream(), ILIAS\ResourceStorage\Manager\ContainerManager\containerFromUpload(), ILIAS\ResourceStorage\Manager\BaseManager\replaceWithStream(), and ILIAS\ResourceStorage\Manager\BaseManager\replaceWithUpload().

                                                       : void
     {
         if (!in_array($mimetype, ['application/zip', 'application/x-zip-compressed'])) {
             throw new \LogicException("Cant create container resource since stream is not a ZIP");
         }
     }

Here is the caller graph for this function:

◆ clone()

ILIAS\ResourceStorage\Manager\BaseManager::clone ( ResourceIdentification $identification )

Definition at line 140 of file BaseManager.php.

                                                                  : ResourceIdentification
     {
         $resource = $this->resource_builder->clone($this->resource_builder->get($identification));
 
         return $resource->getIdentification();
     }

◆ find()

ILIAS\ResourceStorage\Manager\BaseManager::find ( string $identification )

Definition at line 113 of file BaseManager.php.

                                                 : ?ResourceIdentification
     {
         $resource_identification = new ResourceIdentification($identification);
 
         if ($this->resource_builder->has($resource_identification)) {
             return $resource_identification;
         }
 
         return null;
     }

◆ getCurrentRevision()

ILIAS\ResourceStorage\Manager\BaseManager::getCurrentRevision ( ResourceIdentification $identification )

Definition at line 334 of file BaseManager.php.

      : Revision {
         return $this->resource_builder->get($identification)->getCurrentRevision();
     }

◆ getCurrentRevisionIncludingDraft()

ILIAS\ResourceStorage\Manager\BaseManager::getCurrentRevisionIncludingDraft ( ResourceIdentification $identification )

Definition at line 340 of file BaseManager.php.

      : Revision {
         return $this->resource_builder->get($identification)->getCurrentRevisionIncludingDraft();
     }

◆ getResource()

ILIAS\ResourceStorage\Manager\BaseManager::getResource ( ResourceIdentification $i )

Definition at line 126 of file BaseManager.php.

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Referenced by ILIAS\ResourceStorage\Manager\ContainerManager\addStreamToContainer(), ILIAS\ResourceStorage\Manager\ContainerManager\addUploadToContainer(), ILIAS\ResourceStorage\Manager\ContainerManager\createDirectoryInsideContainer(), and ILIAS\ResourceStorage\Manager\ContainerManager\removePathInsideContainer().

                                                           : StorableResource
     {
         $this->preloader->preload([$i->serialize()]);
         return $this->resource_builder->get($i);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ newStreamBased()

ILIAS\ResourceStorage\Manager\BaseManager::newStreamBased	(	FileStream	$stream,
		ResourceStakeholder	$stakeholder,
		ResourceType	$type,
		string	$revision_title = `null`
	)

protected

Definition at line 88 of file BaseManager.php.

References ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder\getOwnerOfNewResources().

Referenced by ILIAS\ResourceStorage\Manager\ContainerManager\containerFromStream(), and ILIAS\ResourceStorage\Manager\Manager\stream().

      : ResourceIdentification {
         $info_resolver = new StreamInfoResolver(
             $stream,
             1,
             $stakeholder->getOwnerOfNewResources(),
             $revision_title ?? $stream->getMetadata()['uri']
         );
 
         $resource = $this->resource_builder->newFromStream(
             $stream,
             $info_resolver,
             true,
             $type
         );
         $resource->addStakeholder($stakeholder);
         $this->resource_builder->store($resource);
 
         return $resource->getIdentification();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ publish()

ILIAS\ResourceStorage\Manager\BaseManager::publish ( ResourceIdentification $rid )

Publish a resource.

A resource can contain a maximum of one revision in DRAFT on top status. This method can be used to publish this revision. If the latest revision is already published, nothing changes.

Definition at line 74 of file BaseManager.php.

                                                         : void
     {
         $this->resource_builder->publish($this->resource_builder->get($rid));
     }

◆ remove()

ILIAS\ResourceStorage\Manager\BaseManager::remove	(	ResourceIdentification	$identification,
		ResourceStakeholder	$stakeholder
	)

Definition at line 132 of file BaseManager.php.

                                                                                                     : void
     {
         $this->resource_builder->remove($this->resource_builder->get($identification), $stakeholder);
         if (!$this->resource_builder->has($identification)) {
             $this->collection_builder->notififyResourceDeletion($identification);
         }
     }

◆ removeRevision()

ILIAS\ResourceStorage\Manager\BaseManager::removeRevision	(	ResourceIdentification	$identification,
		int	$revision_number
	)

Definition at line 362 of file BaseManager.php.

                                                                                                 : bool
     {
         $resource = $this->resource_builder->get($identification);
         $this->resource_builder->removeRevision($resource, $revision_number);
         $this->resource_builder->store($resource);
 
         return true;
     }

◆ replaceWithStream()

ILIAS\ResourceStorage\Manager\BaseManager::replaceWithStream	(	ResourceIdentification	$identification,
		FileStream	$stream,
		ResourceStakeholder	$stakeholder,
		string	$revision_title = `null`
	)

Exceptions

Definition at line 293 of file BaseManager.php.

References ILIAS\ResourceStorage\Manager\BaseManager\checkZIP(), ILIAS\ResourceStorage\Resource\CONTAINER, ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder\getOwnerOfNewResources(), and ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

      : Revision {
         if (!$this->resource_builder->has($identification)) {
             throw new \LogicException(
                 "Resource not found, can't append new version in: " . $identification->serialize()
             );
         }
 
         $resource = $this->resource_builder->get($identification);
         if ($resource->getCurrentRevisionIncludingDraft()->getStatus() === RevisionStatus::DRAFT) {
             throw new \LogicException(
                 "Can't replace DRAFT revision, use appendNewRevisionFromStream instead to update the DRAFT"
             );
         }
         if ($resource->getType() === ResourceType::CONTAINER) {
             $this->checkZIP(mime_content_type($stream->getMetadata()['uri']));
         }
         $info_resolver = new StreamInfoResolver(
             $stream,
             $resource->getMaxRevision(true) + 1,
             $stakeholder->getOwnerOfNewResources(),
             $revision_title ?? $stream->getMetadata()['uri']
         );
 
         $this->resource_builder->replaceWithStream(
             $resource,
             $stream,
             $info_resolver,
             true
         );
         $resource->addStakeholder($stakeholder);
 
         $this->resource_builder->store($resource);
 
         return $resource->getCurrentRevisionIncludingDraft();
     }

Here is the call graph for this function:

◆ replaceWithUpload()

ILIAS\ResourceStorage\Manager\BaseManager::replaceWithUpload	(	ResourceIdentification	$identification,
		UploadResult	$result,
		ResourceStakeholder	$stakeholder,
		string	$revision_title = `null`
	)

Exceptions

Definition at line 201 of file BaseManager.php.

References ILIAS\ResourceStorage\Manager\BaseManager\checkZIP(), ILIAS\ResourceStorage\Resource\CONTAINER, ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\FileUpload\DTO\UploadResult\getMimeType(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder\getOwnerOfNewResources(), ILIAS\FileUpload\DTO\UploadResult\getStatus(), ILIAS\FileUpload\DTO\UploadResult\isOK(), and ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

      : Revision {
         if ($result->isOK()) {
             if (!$this->resource_builder->has($identification)) {
                 throw new \LogicException(
                     "Resource not found, can't append new version in: " . $identification->serialize()
                 );
             }
             $resource = $this->resource_builder->get($identification);
             if ($resource->getType() === ResourceType::CONTAINER) {
                 $this->checkZIP($result->getMimeType());
             }
             if ($resource->getCurrentRevisionIncludingDraft()->getStatus() === RevisionStatus::DRAFT) {
                 throw new \LogicException(
                     "Can't replace DRAFT revision, use appendNewRevision instead to update the DRAFT"
                 );
             }
             $info_resolver = new UploadInfoResolver(
                 $result,
                 $resource->getMaxRevision(true) + 1,
                 $stakeholder->getOwnerOfNewResources(),
                 $revision_title ?? $result->getName()
             );
             $this->resource_builder->replaceWithUpload(
                 $resource,
                 $result,
                 $info_resolver
             );
             $resource->addStakeholder($stakeholder);
 
             $this->resource_builder->store($resource);
 
             return $resource->getCurrentRevisionIncludingDraft();
         }
         throw new \LogicException("Can't handle UploadResult: " . $result->getStatus()->getMessage());
     }

Here is the call graph for this function:

◆ rollbackRevision()

ILIAS\ResourceStorage\Manager\BaseManager::rollbackRevision	(	ResourceIdentification	$identification,
		int	$revision_number
	)

Definition at line 353 of file BaseManager.php.

                                                                                                   : bool
     {
         $resource = $this->resource_builder->get($identification);
         $this->resource_builder->appendFromRevision($resource, $revision_number);
         $this->resource_builder->store($resource);
 
         return true;
     }

◆ unpublish()

ILIAS\ResourceStorage\Manager\BaseManager::unpublish ( ResourceIdentification $rid )

Unpublish a resource.

The newest revision of a resource is set to the DRAFT status. If the latest revision is already in DRAFT, nothing changes.

Definition at line 83 of file BaseManager.php.

                                                           : void
     {
         $this->resource_builder->unpublish($this->resource_builder->get($rid));
     }

◆ updateRevision()

ILIAS\ResourceStorage\Manager\BaseManager::updateRevision ( Revision $revision )

Definition at line 346 of file BaseManager.php.

                                                       : bool
     {
         $this->resource_builder->storeRevision($revision);
 
         return true;
     }

Field Documentation

◆ $collection_builder

CollectionBuilder ILIAS\ResourceStorage\Manager\BaseManager::$collection_builder

protected

Definition at line 43 of file BaseManager.php.

Referenced by ILIAS\ResourceStorage\Manager\BaseManager\__construct().

◆ $preloader

RepositoryPreloader ILIAS\ResourceStorage\Manager\BaseManager::$preloader

protected

Definition at line 44 of file BaseManager.php.

Referenced by ILIAS\ResourceStorage\Manager\BaseManager\__construct().

◆ $resource_builder

ResourceBuilder ILIAS\ResourceStorage\Manager\BaseManager::$resource_builder

protected

Definition at line 42 of file BaseManager.php.

Referenced by ILIAS\ResourceStorage\Manager\BaseManager\__construct().

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

components/ILIAS/ResourceStorage/src/Manager/BaseManager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appendNewRevision()

◆ appendNewRevisionFromStream()

◆ checkZIP()

◆ clone()

◆ find()

◆ getCurrentRevision()

◆ getCurrentRevisionIncludingDraft()

◆ getResource()

◆ newStreamBased()

◆ publish()

◆ remove()

◆ removeRevision()

◆ replaceWithStream()

◆ replaceWithUpload()

◆ rollbackRevision()

◆ unpublish()

◆ updateRevision()

Field Documentation

◆ $collection_builder

◆ $preloader

◆ $resource_builder