Collaboration diagram for ILIAS\Exercise\IRSS\CollectionWrapper:

Public Member Functions
	__construct (InternalDataService $data)

	createEmptyCollection ()

	getCollectionForIdString (string $rcid)

	deleteCollectionForIdString (string $rcid, ResourceStakeholder $stakeholder)

	copyResourcesToDir (string $rcid, ResourceStakeholder $stakeholder, string $dir)

	importFilesFromLegacyUploadToCollection (ResourceCollection $collection, array $file_input, ResourceStakeholder $stakeholder)

	importFilesFromDirectoryToCollection (ResourceCollection $collection, string $directory, ResourceStakeholder $stakeholder)

	importFileFromLegacyUpload (array $file_input, ResourceStakeholder $stakeholder)

	importFileFromUploadResult (UploadResult $result, ResourceStakeholder $stakeholder)

	deliverFile (string $rid)

	stream (string $rid)

	getCollectionResourcesInfo (ResourceCollection $collection)

	clone (string $from_rc_id)

	cloneResource (string $from_rid)

	deleteResource (string $rid, ResourceStakeholder $stakeholder)

	addEntryOfZipResourceToCollection (string $rid, string $entry, ResourceCollection $target_collection, ResourceStakeholder $target_stakeholder)

Protected Member Functions
	getNewCollectionId ()

	getNewCollectionIdAsString ()

	getResourceIdForIdString (string $rid)

Protected Attributes
InternalDataService	$data

ILIAS FileUpload FileUpload	$upload

ILIAS ResourceStorage Services	$irss

Detailed Description

Definition at line 33 of file CollectionWrapper.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Exercise\IRSS\CollectionWrapper::__construct ( InternalDataService $data )

Definition at line 39 of file CollectionWrapper.php.

References ILIAS\Exercise\IRSS\CollectionWrapper\$data, $DIC, and ILIAS\Repository\upload().

       {
         global $DIC;
 
         $this->irss = $DIC->resourceStorage();
         $this->upload = $DIC->upload();
         $this->data = $data;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addEntryOfZipResourceToCollection()

ILIAS\Exercise\IRSS\CollectionWrapper::addEntryOfZipResourceToCollection	(	string	$rid,
		string	$entry,
		ResourceCollection	$target_collection,
		ResourceStakeholder	$target_stakeholder
	)

Definition at line 280 of file CollectionWrapper.php.

References ILIAS\ResourceStorage\Collection\ResourceCollection\add(), ILIAS\Filesystem\Stream\Streams\ofFileInsideZIP(), and ILIAS\Exercise\IRSS\CollectionWrapper\stream().

       {
         $entry_parts = explode("/", $entry);
         $zip_path = $this->stream($rid)->getMetadata("uri");
 
         $stream = Streams::ofFileInsideZIP(
             $zip_path,
             $entry
         );
         $feedback_rid = $this->irss->manage()->stream(
             $stream,
             $target_stakeholder,
             $entry_parts[2]
         );
         $target_collection->add($feedback_rid);
         $this->irss->collection()->store($target_collection);
     }

Here is the call graph for this function:

◆ clone()

ILIAS\Exercise\IRSS\CollectionWrapper::clone ( string $from_rc_id )

Definition at line 250 of file CollectionWrapper.php.

      : string {
         if ($from_rc_id !== "") {
             $cloned_rcid = $this->irss->collection()->clone($this->irss->collection()->id($from_rc_id));
             return $cloned_rcid->serialize();
         }
         return "";
     }

◆ cloneResource()

ILIAS\Exercise\IRSS\CollectionWrapper::cloneResource ( string $from_rid )

Definition at line 260 of file CollectionWrapper.php.

References ILIAS\Exercise\IRSS\CollectionWrapper\getResourceIdForIdString().

      : string {
         if ($from_rid !== "") {
             $cloned_rid = $this->irss->manage()->clone($this->getResourceIdForIdString($from_rid));
             return $cloned_rid->serialize();
         }
         return "";
     }

Here is the call graph for this function:

◆ copyResourcesToDir()

ILIAS\Exercise\IRSS\CollectionWrapper::copyResourcesToDir	(	string	$rcid,
		ResourceStakeholder	$stakeholder,
		string	$dir
	)

Definition at line 80 of file CollectionWrapper.php.

       {
         $collection = $this->irss->collection()->get($this->irss->collection()->id($rcid));
         foreach ($collection->getResourceIdentifications() as $rid) {
             $info = $this->irss->manage()->getResource($rid)
                                ->getCurrentRevision()
                                ->getInformation();
             $stream = $this->irss->consume()->stream($rid);
             $stream->getContents();
         }
     }

◆ createEmptyCollection()

ILIAS\Exercise\IRSS\CollectionWrapper::createEmptyCollection ( )

Definition at line 59 of file CollectionWrapper.php.

References ILIAS\Exercise\IRSS\CollectionWrapper\getNewCollectionId().

                                            : string
     {
         $new_id = $this->getNewCollectionId();
         $new_collection = $this->irss->collection()->get($new_id);
         $this->irss->collection()->store($new_collection);
         return $new_id->serialize();
     }

Here is the call graph for this function:

◆ deleteCollectionForIdString()

ILIAS\Exercise\IRSS\CollectionWrapper::deleteCollectionForIdString	(	string	$rcid,
		ResourceStakeholder	$stakeholder
	)

Definition at line 72 of file CollectionWrapper.php.

References $id.

      : void {
         $id = $this->irss->collection()->id($rcid);
         $this->irss->collection()->remove($id, $stakeholder, true);
     }

◆ deleteResource()

ILIAS\Exercise\IRSS\CollectionWrapper::deleteResource	(	string	$rid,
		ResourceStakeholder	$stakeholder
	)

Definition at line 270 of file CollectionWrapper.php.

References $res, and ILIAS\Exercise\IRSS\CollectionWrapper\getResourceIdForIdString().

                                                                                  : void
     {
         if ($rid !== "") {
             $res = $this->getResourceIdForIdString($rid);
             if ($res) {
                 $this->irss->manage()->remove($this->getResourceIdForIdString($rid), $stakeholder);
             }
         }
     }

Here is the call graph for this function:

◆ deliverFile()

ILIAS\Exercise\IRSS\CollectionWrapper::deliverFile ( string $rid )

Definition at line 214 of file CollectionWrapper.php.

References $id, and ILIAS\Exercise\IRSS\CollectionWrapper\getResourceIdForIdString().

                                             : void
     {
         $id = $this->getResourceIdForIdString($rid);
         if ($id) {
             $this->irss->consume()->download($id)->run();
         }
     }

Here is the call graph for this function:

◆ getCollectionForIdString()

ILIAS\Exercise\IRSS\CollectionWrapper::getCollectionForIdString ( string $rcid )

Definition at line 67 of file CollectionWrapper.php.

                                                           : ResourceCollection
     {
         return $this->irss->collection()->get($this->irss->collection()->id($rcid));
     }

◆ getCollectionResourcesInfo()

ILIAS\Exercise\IRSS\CollectionWrapper::getCollectionResourcesInfo ( ResourceCollection $collection )

Definition at line 231 of file CollectionWrapper.php.

References ILIAS\ResourceStorage\Collection\ResourceCollection\getResourceIdentifications().

      : \Generator {
         foreach ($collection->getResourceIdentifications() as $rid) {
             $info = $this->irss->manage()->getResource($rid)
                                ->getCurrentRevision()
                                ->getInformation();
             $src = $this->irss->consume()->src($rid)->getSrc();
             yield $this->data->resourceInformation(
                 $rid->serialize(),
                 $info->getTitle(),
                 $info->getSize(),
                 $info->getCreationDate()->getTimestamp(),
                 $info->getMimeType(),
                 $src
             );
         }
     }

Here is the call graph for this function:

◆ getNewCollectionId()

ILIAS\Exercise\IRSS\CollectionWrapper::getNewCollectionId ( )

protected

Definition at line 49 of file CollectionWrapper.php.

Referenced by ILIAS\Exercise\IRSS\CollectionWrapper\createEmptyCollection(), and ILIAS\Exercise\IRSS\CollectionWrapper\getNewCollectionIdAsString().

                                            : ResourceCollectionIdentification
     {
         return $this->irss->collection()->id();
     }

Here is the caller graph for this function:

◆ getNewCollectionIdAsString()

ILIAS\Exercise\IRSS\CollectionWrapper::getNewCollectionIdAsString ( )

protected

Definition at line 54 of file CollectionWrapper.php.

References ILIAS\Exercise\IRSS\CollectionWrapper\getNewCollectionId().

                                                    : string
     {
         return $this->getNewCollectionId()->serialize();
     }

Here is the call graph for this function:

◆ getResourceIdForIdString()

ILIAS\Exercise\IRSS\CollectionWrapper::getResourceIdForIdString ( string $rid )

protected

Definition at line 161 of file CollectionWrapper.php.

Referenced by ILIAS\Exercise\IRSS\CollectionWrapper\cloneResource(), ILIAS\Exercise\IRSS\CollectionWrapper\deleteResource(), ILIAS\Exercise\IRSS\CollectionWrapper\deliverFile(), and ILIAS\Exercise\IRSS\CollectionWrapper\stream().

                                                             : ?ResourceIdentification
     {
         return $this->irss->manage()->find($rid);
     }

Here is the caller graph for this function:

◆ importFileFromLegacyUpload()

ILIAS\Exercise\IRSS\CollectionWrapper::importFileFromLegacyUpload	(	array	$file_input,
		ResourceStakeholder	$stakeholder
	)

Definition at line 166 of file CollectionWrapper.php.

References ILIAS\Exercise\IRSS\CollectionWrapper\$upload.

      : string {
         $upload = $this->upload;
 
         if (is_array($file_input)) {
             if (!$upload->hasBeenProcessed()) {
                 $upload->process();
             }
             foreach ($upload->getResults() as $name => $result) {
                 // we must check if these are files from this input
                 if ($name !== ($file_input["tmp_name"] ?? "")) {
                     continue;
                 }
                 // if the result is not OK, we skip it
                 if (!$result->isOK()) {
                     continue;
                 }
 
                 // we store the file in the IRSS
                 $rid = $this->irss->manage()->upload(
                     $result,
                     $stakeholder
                 );
                 return $rid->serialize();
             }
         }
         return "";
     }

◆ importFileFromUploadResult()

ILIAS\Exercise\IRSS\CollectionWrapper::importFileFromUploadResult	(	UploadResult	$result,
		ResourceStakeholder	$stakeholder
	)

Definition at line 197 of file CollectionWrapper.php.

References ILIAS\FileUpload\DTO\UploadResult\isOK().

      : string {
         // if the result is not OK, we skip it
         if (!$result->isOK()) {
             return "";
         }
 
         // we store the file in the IRSS
         $rid = $this->irss->manage()->upload(
             $result,
             $stakeholder
         );
         return $rid->serialize();
     }

Here is the call graph for this function:

◆ importFilesFromDirectoryToCollection()

ILIAS\Exercise\IRSS\CollectionWrapper::importFilesFromDirectoryToCollection	(	ResourceCollection	$collection,
		string	$directory,
		ResourceStakeholder	$stakeholder
	)

Definition at line 129 of file CollectionWrapper.php.

References Vendor\Package\$e, ILIAS\ResourceStorage\Collection\ResourceCollection\add(), ILIAS\Filesystem\Util\LegacyPathHelper\createRelativePath(), and ILIAS\Filesystem\Util\LegacyPathHelper\deriveFilesystemFrom().

      : void {
         $sourceFS = LegacyPathHelper::deriveFilesystemFrom($directory);
         $sourceDir = LegacyPathHelper::createRelativePath($directory);
 
         // check if arguments are directories
         if (!$sourceFS->hasDir($sourceDir)) {
             return;
         }
 
         $sourceList = $sourceFS->listContents($sourceDir, false);
 
         foreach ($sourceList as $item) {
             if ($item->isDir()) {
                 continue;
             }
             try {
                 $stream = $sourceFS->readStream($item->getPath());
                 $rid = $this->irss->manage()->stream(
                     $stream,
                     $stakeholder
                 );
                 $collection->add($rid);
             } catch (\ILIAS\Filesystem\Exception\FileAlreadyExistsException $e) {
             }
         }
         $this->irss->collection()->store($collection);
     }

Here is the call graph for this function:

◆ importFilesFromLegacyUploadToCollection()

ILIAS\Exercise\IRSS\CollectionWrapper::importFilesFromLegacyUploadToCollection	(	ResourceCollection	$collection,
		array	$file_input,
		ResourceStakeholder	$stakeholder
	)

Definition at line 95 of file CollectionWrapper.php.

References ILIAS\Exercise\IRSS\CollectionWrapper\$upload, and ILIAS\ResourceStorage\Collection\ResourceCollection\add().

      : void {
         $upload = $this->upload;
 
         if (is_array($file_input)) {
             if (!$upload->hasBeenProcessed()) {
                 $upload->process();
             }
             foreach ($upload->getResults() as $name => $result) {
                 // we must check if these are files from this input
                 if (!in_array($name, $file_input["tmp_name"] ?? [], true)) {
                     continue;
                 }
                 // if the result is not OK, we skip it
                 if (!$result->isOK()) {
                     continue;
                 }
 
                 // we store the file in the IRSS
                 $rid = $this->irss->manage()->upload(
                     $result,
                     $stakeholder
                 );
                 // and add its identification to the collection
                 $collection->add($rid);
             }
             // we store the collection after all files have been added
             $this->irss->collection()->store($collection);
         }
     }

Here is the call graph for this function:

◆ stream()

ILIAS\Exercise\IRSS\CollectionWrapper::stream ( string $rid )

Definition at line 222 of file CollectionWrapper.php.

References $id, and ILIAS\Exercise\IRSS\CollectionWrapper\getResourceIdForIdString().

Referenced by ILIAS\Exercise\IRSS\CollectionWrapper\addEntryOfZipResourceToCollection().

                                        : ?FileStream
     {
         $id = $this->getResourceIdForIdString($rid);
         if ($id) {
             return $this->irss->consume()->stream($id)->getStream();
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $data

InternalDataService ILIAS\Exercise\IRSS\CollectionWrapper::$data

protected

Definition at line 35 of file CollectionWrapper.php.

Referenced by ILIAS\Exercise\IRSS\CollectionWrapper\__construct().

◆ $irss

ILIAS ResourceStorage Services ILIAS\Exercise\IRSS\CollectionWrapper::$irss

protected

Definition at line 37 of file CollectionWrapper.php.

◆ $upload

ILIAS FileUpload FileUpload ILIAS\Exercise\IRSS\CollectionWrapper::$upload

protected

Definition at line 36 of file CollectionWrapper.php.

Referenced by ILIAS\Exercise\IRSS\CollectionWrapper\importFileFromLegacyUpload(), and ILIAS\Exercise\IRSS\CollectionWrapper\importFilesFromLegacyUploadToCollection().

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

Modules/Exercise/IRSS/CollectionWrapper.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addEntryOfZipResourceToCollection()

◆ clone()

◆ cloneResource()

◆ copyResourcesToDir()

◆ createEmptyCollection()

◆ deleteCollectionForIdString()

◆ deleteResource()

◆ deliverFile()

◆ getCollectionForIdString()

◆ getCollectionResourcesInfo()

◆ getNewCollectionId()

◆ getNewCollectionIdAsString()

◆ getResourceIdForIdString()

◆ importFileFromLegacyUpload()

◆ importFileFromUploadResult()

◆ importFilesFromDirectoryToCollection()

◆ importFilesFromLegacyUploadToCollection()

◆ stream()

Field Documentation

◆ $data

◆ $irss

◆ $upload