Collaboration diagram for ILIAS\MainMenu\Storage\Services:

Public Member Functions
	__construct ()
	Services constructor. More...

	upload (UploadResult $result, ResourceStakeholder $stakeholder, string $title=null)
	this is the fast-lane: in most cases you want to store a uploaded file in the storage and use it's identification. More...

	find (string $identification)

	getRevision (ResourceIdentification $identification)

	remove (ResourceIdentification $identification)

	download (ResourceIdentification $identification)

	inline (ResourceIdentification $identification)

	stream (ResourceIdentification $identification)

Private Attributes
	$consumer_factory

	$resource_builder

Detailed Description

Class Services.

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

Definition at line 29 of file Services.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MainMenu\Storage\Services::__construct ( )

Services constructor.

Definition at line 45 of file Services.php.

     {
         $this->resource_builder = new ResourceBuilder(
             new FileSystemStorageHandler(),
             new RevisionARRepository(),
             new ResourceARRepository(),
             new InformationARRepository()
         );
         $this->consumer_factory = new ConsumerFactory(new StorageHandlerFactory());
     }

Member Function Documentation

◆ download()

ILIAS\MainMenu\Storage\Services::download ( ResourceIdentification $identification )

Definition at line 123 of file Services.php.

                                                                      : DownloadConsumer
     {
         return $this->consumer_factory->download($this->resource_builder->get($identification));
     }

◆ find()

ILIAS\MainMenu\Storage\Services::find ( string $identification )

Definition at line 81 of file Services.php.

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

◆ getRevision()

ILIAS\MainMenu\Storage\Services::getRevision ( ResourceIdentification $identification )

Definition at line 93 of file Services.php.

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

◆ inline()

ILIAS\MainMenu\Storage\Services::inline ( ResourceIdentification $identification )

Definition at line 129 of file Services.php.

                                                                    : InlineConsumer
     {
         return $this->consumer_factory->inline($this->resource_builder->get($identification));
     }

◆ remove()

ILIAS\MainMenu\Storage\Services::remove ( ResourceIdentification $identification )

Definition at line 99 of file Services.php.

                                                                    : void
     {
         $this->resource_builder->remove($this->resource_builder->get($identification));
     }

◆ stream()

ILIAS\MainMenu\Storage\Services::stream ( ResourceIdentification $identification )

Definition at line 135 of file Services.php.

                                                                    : FileStreamConsumer
     {
         return $this->consumer_factory->fileStream($this->resource_builder->get($identification));
     }

◆ upload()

ILIAS\MainMenu\Storage\Services::upload	(	UploadResult	$result,
		ResourceStakeholder	$stakeholder,
		string	$title = `null`
	)

this is the fast-lane: in most cases you want to store a uploaded file in the storage and use it's identification.

Parameters

UploadResult	$result
ResourceStakeholder	$stakeholder
string	$title

Returns: ResourceIdentification

Definition at line 67 of file Services.php.

References ILIAS\FileUpload\DTO\UploadResult\getStatus(), and ILIAS\FileUpload\DTO\UploadResult\isOK().

                                                                                                          : ResourceIdentification
     {
         if ($result->isOK()) {
             $resource = $this->resource_builder->new($result);
 
             $this->resource_builder->store($resource);
 
             return $resource->getIdentification();
         } else {
             throw new LogicException("Can't handle UploadResult: " . $result->getStatus()->getMessage());
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $consumer_factory

ILIAS\MainMenu\Storage\Services::$consumer_factory

private

Definition at line 35 of file Services.php.

◆ $resource_builder

ILIAS\MainMenu\Storage\Services::$resource_builder