Class StorageManager. More...

Collaboration diagram for ILIAS\ResourceStorage\Manager\Manager:

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

	upload (UploadResult $result, ResourceStakeholder $stakeholder, string $revision_title=null)

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

	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)

	replaceWithUpload (ResourceIdentification $identification, UploadResult $result, ResourceStakeholder $stakeholder, string $revision_title=null)

	appendNewRevisionFromStream (ResourceIdentification $identification, FileStream $stream, ResourceStakeholder $stakeholder, string $revision_title=null)

	replaceWithStream (ResourceIdentification $identification, FileStream $stream, ResourceStakeholder $stakeholder, string $revision_title=null)

	getCurrentRevision (ResourceIdentification $identification)

	updateRevision (Revision $revision)

	rollbackRevision (ResourceIdentification $identification, int $revision_number)

	removeRevision (ResourceIdentification $identification, int $revision_number)

Protected Attributes
ResourceBuilder	$resource_builder

CollectionBuilder	$collection_builder

RepositoryPreloader	$preloader

Detailed Description

Class StorageManager.

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

Definition at line 39 of file Manager.php.

Constructor & Destructor Documentation

◆ __construct()

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

Manager constructor.

Definition at line 48 of file Manager.php.

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

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

Member Function Documentation

◆ appendNewRevision()

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

Definition at line 143 of file Manager.php.

References 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);
             $info_resolver = new UploadInfoResolver(
                 $result,
                 $resource->getMaxRevision() + 1,
                 $stakeholder->getOwnerOfNewResources(),
                 $revision_title ?? $result->getName()
             );
 
             $this->resource_builder->append(
                 $resource,
                 $result,
                 $info_resolver
             );
             $resource->addStakeholder($stakeholder);
 
             $this->resource_builder->store($resource);
 
             return $resource->getCurrentRevision();
         }
         throw new \LogicException("Can't handle UploadResult: " . $result->getStatus()->getMessage());
     }

Here is the call graph for this function:

◆ appendNewRevisionFromStream()

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

Definition at line 210 of file Manager.php.

References 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);
         $info_resolver = new StreamInfoResolver(
             $stream,
             $resource->getMaxRevision() + 1,
             $stakeholder->getOwnerOfNewResources(),
             $revision_title ?? $stream->getMetadata()['uri']
         );
 
         $this->resource_builder->appendFromStream(
             $resource,
             $stream,
             $info_resolver,
             true
         );
         $resource->addStakeholder($stakeholder);
 
         $this->resource_builder->store($resource);
 
         return $resource->getCurrentRevision();
     }

Here is the call graph for this function:

◆ clone()

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

Definition at line 134 of file Manager.php.

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

◆ find()

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

Definition at line 106 of file Manager.php.

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

◆ getCurrentRevision()

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

Definition at line 276 of file Manager.php.

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

◆ getResource()

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

Definition at line 119 of file Manager.php.

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

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

Here is the call graph for this function:

◆ remove()

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

Definition at line 126 of file Manager.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\Manager::removeRevision	(	ResourceIdentification	$identification,
		int	$revision_number
	)

Definition at line 297 of file Manager.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\Manager::replaceWithStream	(	ResourceIdentification	$identification,
		FileStream	$stream,
		ResourceStakeholder	$stakeholder,
		string	$revision_title = `null`
	)

Definition at line 243 of file Manager.php.

References 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);
         $info_resolver = new StreamInfoResolver(
             $stream,
             $resource->getMaxRevision() + 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->getCurrentRevision();
     }

Here is the call graph for this function:

◆ replaceWithUpload()

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

Definition at line 177 of file Manager.php.

References 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);
             $info_resolver = new UploadInfoResolver(
                 $result,
                 $resource->getMaxRevision() + 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->getCurrentRevision();
         }
         throw new \LogicException("Can't handle UploadResult: " . $result->getStatus()->getMessage());
     }

Here is the call graph for this function:

◆ rollbackRevision()

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

Definition at line 288 of file Manager.php.

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

◆ stream()

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

Definition at line 83 of file Manager.php.

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

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

Here is the call graph for this function:

◆ updateRevision()

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

Definition at line 281 of file Manager.php.

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

◆ upload()

ILIAS\ResourceStorage\Manager\Manager::upload	(	UploadResult	$result,
		ResourceStakeholder	$stakeholder,
		string	$revision_title = `null`
	)

Definition at line 58 of file Manager.php.

References ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder\getOwnerOfNewResources(), ILIAS\FileUpload\DTO\UploadResult\getStatus(), and ILIAS\FileUpload\DTO\UploadResult\isOK().

      : ResourceIdentification {
         if ($result->isOK()) {
             $info_resolver = new UploadInfoResolver(
                 $result,
                 1,
                 $stakeholder->getOwnerOfNewResources(),
                 $revision_title ?? $result->getName()
             );
 
             $resource = $this->resource_builder->new(
                 $result,
                 $info_resolver
             );
             $resource->addStakeholder($stakeholder);
             $this->resource_builder->store($resource);
 
             return $resource->getIdentification();
         }
         throw new \LogicException("Can't handle UploadResult: " . $result->getStatus()->getMessage());
     }

Here is the call graph for this function:

Field Documentation

◆ $collection_builder

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

protected

Definition at line 42 of file Manager.php.

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

◆ $preloader

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

protected

Definition at line 43 of file Manager.php.

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

◆ $resource_builder

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

protected

Definition at line 41 of file Manager.php.

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

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

src/ResourceStorage/Manager/Manager.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appendNewRevision()

◆ appendNewRevisionFromStream()

◆ clone()

◆ find()

◆ getCurrentRevision()

◆ getResource()

◆ remove()

◆ removeRevision()

◆ replaceWithStream()

◆ replaceWithUpload()

◆ rollbackRevision()

◆ stream()

◆ updateRevision()

◆ upload()

Field Documentation

◆ $collection_builder

◆ $preloader

◆ $resource_builder