ILIAS\Repository\IRSS\IRSSWrapper Class Reference

Collaboration diagram for ILIAS\Repository\IRSS\IRSSWrapper:

Public Member Functions
	__construct (protected DataService $data)
	createEmptyCollection ()
	getCollectionForIdString (string $rcid)
	deleteCollectionForIdString (string $rcid, ResourceStakeholder $stakeholder)
	importFilesFromLegacyUploadToCollection (ResourceCollection $collection, array $file_input, ResourceStakeholder $stakeholder)
	importFilesFromDirectoryToCollection (ResourceCollection $collection, string $directory, ResourceStakeholder $stakeholder)
	getResourceIdForIdString (string $rid)
	importFileFromLegacyUpload (array $file_input, ResourceStakeholder $stakeholder)
	importFileFromUploadResult (UploadResult $result, ResourceStakeholder $stakeholder)
	importLocalFile (string $file, string $name, ResourceStakeholder $stakeholder)
	importStream (Stream $stream, ResourceStakeholder $stakeholder)
	renameCurrentRevision (string $rid, string $title)
	deliverFile (string $rid)
	stream (string $rid)
	getResourcePath (string $rid)
	getResource (string $rid)
	getCollectionResourcesInfo (ResourceCollection $collection)
	getResourceInfo (string $rid)
	clone (string $from_rc_id)
	cloneResource (string $from_rid)
	cloneContainer (string $from_rid)
	deleteResource (string $rid, ResourceStakeholder $stakeholder)
	addEntryOfZipResourceToCollection (string $rid, string $entry, ResourceCollection $target_collection, ResourceStakeholder $target_stakeholder)
	getStreamOfContainerEntry (string $rid, string $entry)
	getContainerEntryInfo (string $container_id, string $path)
	deliverContainerEntry (string $container_id, string $path)
	hasContainerEntry (string $rid, string $entry)
	Is there a better way to check this? More...
	getContainerStreams (string $container_id, ResourceStakeholder $stakeholder)
	getContainerPaths (string $container_id)
	getContainerEntries (string $container_id)
	getContainerEntriesOfPath (string $container_id, string $dir_path)
	addContainerDirToTargetContainer (string $source_container_id, string $target_container_id, string $source_dir_path="", string $target_dir_path="")
	createContainer (ResourceStakeholder $stakeholder, string $title="container.zip")
	createContainerFromLocalZip (string $local_zip_path, ResourceStakeholder $stakeholder)
	createContainerFromLocalDir (string $local_dir_path, ResourceStakeholder $stakeholder, string $container_path="", bool $recursive=true, string $title="container.zip")
	addLocalFileToContainer (string $rid, string $fullpath, string $path)
	addStringToContainer (string $rid, string $content, string $path)
	addDirectoryToContainer (string $rid, string $source_dir, string $target_path="")
	addUploadToContainer (string $rid, UploadResult $result)
	getContainerUri (string $rid, string $path)
	getContainerZip (string $rid)
	importFileFromLegacyUploadToContainer (string $rid, string $tmp_name, string $target_path)
	importFileFromUploadResultToContainer (string $rid, UploadResult $result, string $target_path)
	addStreamToContainer (string $rid, FileStream $stream, string $path)
	removePathFromContainer (string $rid, string $path)
	renameContainer (string $rid, string $title)

Protected Member Functions
	getNewCollectionId ()
	getNewCollectionIdAsString ()

Protected Attributes
	$filesystems
ILIAS FileDelivery Services	$file_delivery
ILIAS FileUpload FileUpload	$upload
ILIAS ResourceStorage Services	$irss
Archives	$archives

Detailed Description

Definition at line 41 of file IRSSWrapper.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Repository\IRSS\IRSSWrapper::__construct

(

protected DataService

$data

)

Definition at line 49 of file IRSSWrapper.php.

References $DIC, ILIAS\Filesystem\filesystems(), and ILIAS\Repository\upload().

      {
        global $DIC;

        if (!$DIC->isDependencyAvailable("resourceStorage")) {
            return;
        }
        $this->irss = $DIC->resourceStorage();
        $this->archives = $DIC->archives();
        $this->upload = $DIC->upload();
        $this->archives = $DIC->archives();
        $this->file_delivery = $DIC->fileDelivery();
        $this->filesystems = $DIC->filesystem();
    }

Here is the call graph for this function:

Member Function Documentation

addContainerDirToTargetContainer()

ILIAS\Repository\IRSS\IRSSWrapper::addContainerDirToTargetContainer	(	string	$source_container_id,
		string	$target_container_id,
		string	$source_dir_path = "",
		string	$target_dir_path = ""
	)

Definition at line 538 of file IRSSWrapper.php.

References $path, ILIAS\Repository\IRSS\IRSSWrapper\addStreamToContainer(), ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString(), and ILIAS\Repository\IRSS\IRSSWrapper\getStreamOfContainerEntry().

     : void {
        $reader = new ZipReader(
            $this->irss->consume()->stream($this->getResourceIdForIdString($source_container_id))->getStream()
        );
        $entries = [];
        foreach ($reader->getStructure() as $path => $entry) {
            if (str_starts_with($entry['dirname'], $source_dir_path) && !$entry['is_dir']) {
                $this->addStreamToContainer(
                    $target_container_id,
                    $this->getStreamOfContainerEntry($source_container_id, $path),
                    $target_dir_path . "/" . substr($path, strlen($source_dir_path))
                );
            }
        }
    }

Here is the call graph for this function:

addDirectoryToContainer()

ILIAS\Repository\IRSS\IRSSWrapper::addDirectoryToContainer	(	string	$rid,
		string	$source_dir,
		string	$target_path = ""
	)

Definition at line 672 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\addLocalFileToContainer().

     : void {
        $source_dir = realpath($source_dir);
        $directoryIterator = new \RecursiveDirectoryIterator(
            $source_dir,
            \FilesystemIterator::SKIP_DOTS
        );

        $recursiveIterator = new \RecursiveIteratorIterator(
            $directoryIterator,
            \RecursiveIteratorIterator::LEAVES_ONLY
        );

        foreach ($recursiveIterator as $fileInfo) {
            if ($fileInfo->isFile()) {
                $fullPath = $fileInfo->getPathname();
                $relativePath = substr($fullPath, strlen($source_dir) + 1);
                $files[] = $relativePath;
                $this->addLocalFileToContainer(
                    $rid,
                    $fullPath,
                    $target_path . "/" . $relativePath
                );
            }
        }
    }

Here is the call graph for this function:

addEntryOfZipResourceToCollection()

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

Definition at line 388 of file IRSSWrapper.php.

References ILIAS\Export\ImportHandler\Parser\NodeInfo\Collection\ResourceCollection\add(), and ILIAS\Repository\IRSS\IRSSWrapper\getStreamOfContainerEntry().

      {
        $entry_parts = explode("/", $entry);
        $stream = $this->getStreamOfContainerEntry($rid, $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:

addLocalFileToContainer()

ILIAS\Repository\IRSS\IRSSWrapper::addLocalFileToContainer	(	string	$rid,
		string	$fullpath,
		string	$path
	)

Definition at line 636 of file IRSSWrapper.php.

References $id, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

Referenced by ILIAS\Repository\IRSS\IRSSWrapper\addDirectoryToContainer(), ILIAS\Repository\IRSS\IRSSWrapper\createContainerFromLocalDir(), and ILIAS\Repository\IRSS\IRSSWrapper\importFileFromLegacyUploadToContainer().

     : void {
        $id = $this->getResourceIdForIdString($rid);
        $stream = fopen($fullpath, 'r');
        $fs = new Stream($stream);
        $this->irss->manageContainer()->removePathInsideContainer($id, $path);
        $this->irss->manageContainer()->addStreamToContainer(
            $id,
            $fs,
            $path
        );
        fclose($stream);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addStreamToContainer()

ILIAS\Repository\IRSS\IRSSWrapper::addStreamToContainer	(	string	$rid,
		FileStream	$stream,
		string	$path
	)

Definition at line 805 of file IRSSWrapper.php.

References $id, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

Referenced by ILIAS\Repository\IRSS\IRSSWrapper\addContainerDirToTargetContainer().

     : void {
        $id = $this->getResourceIdForIdString($rid);

        if (!is_null($id)) {
            $this->irss->manageContainer()->addStreamToContainer(
                $id,
                $stream,
                $path
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addStringToContainer()

ILIAS\Repository\IRSS\IRSSWrapper::addStringToContainer	(	string	$rid,
		string	$content,
		string	$path
	)

Definition at line 653 of file IRSSWrapper.php.

References $id, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : void {
        $id = $this->getResourceIdForIdString($rid);
        $stream = fopen('php://memory', 'r+');
        fwrite($stream, $content);
        rewind($stream);
        $fs = new Stream($stream);
        $this->irss->manageContainer()->removePathInsideContainer($id, $path);
        $this->irss->manageContainer()->addStreamToContainer(
            $id,
            $fs,
            $path
        );
        fclose($stream);
    }

Here is the call graph for this function:

addUploadToContainer()

ILIAS\Repository\IRSS\IRSSWrapper::addUploadToContainer	(	string	$rid,
		UploadResult	$result
	)

Definition at line 702 of file IRSSWrapper.php.

References $id, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : void {
        $id = $this->getResourceIdForIdString($rid);
        $this->irss->manageContainer()->addUploadToContainer(
            $id,
            $result,
            "images"
        );
    }

Here is the call graph for this function:

clone()

ILIAS\Repository\IRSS\IRSSWrapper::clone

(

string

$from_rc_id

)

Definition at line 348 of file IRSSWrapper.php.

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

cloneContainer()

ILIAS\Repository\IRSS\IRSSWrapper::cloneContainer

(

string

$from_rid

)

Definition at line 368 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

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

Here is the call graph for this function:

cloneResource()

ILIAS\Repository\IRSS\IRSSWrapper::cloneResource

(

string

$from_rid

)

Definition at line 358 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\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:

createContainer()

ILIAS\Repository\IRSS\IRSSWrapper::createContainer	(	ResourceStakeholder	$stakeholder,
		string	$title = "container.zip"
	)

Definition at line 559 of file IRSSWrapper.php.

References ilFileUtils\delDir(), ILIAS\Filesystem\filesystems(), and ilFileUtils\ilTempnam().

Referenced by ILIAS\Repository\IRSS\IRSSWrapper\createContainerFromLocalDir().

     : string {
        if ($title === "") {
            throw new \ilException("Container title missing.");
        }
        // create empty container resource. empty zips are not allowed, we need at least one file which is hidden
        $tmp_dir_info = new \SplFileInfo(\ilFileUtils::ilTempnam());
        $this->filesystems->temp()->createDir($tmp_dir_info->getFilename());
        $tmp_dir = $tmp_dir_info->getRealPath();
        $options = (new ZipOptions())
            ->withZipOutputName($title)
            ->withZipOutputPath($tmp_dir);
        $empty_zip = $this->archives->zip(
            [],
            $options
        );
        $rid = $this->irss->manageContainer()->containerFromStream(
            $empty_zip->get(),
            $stakeholder,
            $title
        );
        \ilFileUtils::delDir($tmp_dir);
        return $rid->serialize();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createContainerFromLocalDir()

ILIAS\Repository\IRSS\IRSSWrapper::createContainerFromLocalDir	(	string	$local_dir_path,
		ResourceStakeholder	$stakeholder,
		string	$container_path = "",
		bool	$recursive = true,
		string	$title = "container.zip"
	)

Definition at line 600 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\addLocalFileToContainer(), and ILIAS\Repository\IRSS\IRSSWrapper\createContainer().

     : string {
        $real_dir_path = realpath($local_dir_path);
        $rid = $this->createContainer($stakeholder, $title);
        if ($recursive) {
            $iterator = new \RecursiveIteratorIterator(
                new \RecursiveDirectoryIterator(
                    $local_dir_path,
                    \RecursiveDirectoryIterator::SKIP_DOTS | \RecursiveDirectoryIterator::CURRENT_AS_SELF
                ),
                \RecursiveIteratorIterator::SELF_FIRST
            );
        } else {
            $iterator = new \DirectoryIterator($local_dir_path);
        }
        if ($container_path !== "") {
            $container_path = $container_path . "/";
        }
        foreach ($iterator as $file) {
            if (!$file->isDir() && !$file->isDot()) {
                $file->getRealPath();
                $this->addLocalFileToContainer(
                    $rid,
                    $file->getRealPath(),
                    $container_path . substr($file->getRealPath(), strlen($real_dir_path) + 1)
                );
            }
        }
        return $rid;
    }

Here is the call graph for this function:

createContainerFromLocalZip()

ILIAS\Repository\IRSS\IRSSWrapper::createContainerFromLocalZip	(	string	$local_zip_path,
		ResourceStakeholder	$stakeholder
	)

Definition at line 586 of file IRSSWrapper.php.

     : string {
        $stream = fopen($local_zip_path, 'r');
        $fs = new Stream($stream);

        $rid = $this->irss->manageContainer()->containerFromStream(
            $fs,
            $stakeholder
        );
        return $rid->serialize();
    }

createEmptyCollection()

ILIAS\Repository\IRSS\IRSSWrapper::createEmptyCollection

(

)

Definition at line 75 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\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\Repository\IRSS\IRSSWrapper::deleteCollectionForIdString	(	string	$rcid,
		ResourceStakeholder	$stakeholder
	)

Definition at line 88 of file IRSSWrapper.php.

References $id.

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

deleteResource()

ILIAS\Repository\IRSS\IRSSWrapper::deleteResource	(	string	$rid,
		ResourceStakeholder	$stakeholder
	)

Definition at line 378 of file IRSSWrapper.php.

References $res, and ILIAS\Repository\IRSS\IRSSWrapper\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:

deliverContainerEntry()

ILIAS\Repository\IRSS\IRSSWrapper::deliverContainerEntry	(	string	$container_id,
		string	$path
	)

Definition at line 430 of file IRSSWrapper.php.

References $info, ILIAS\components\ResourceStorage\Container\Wrapper\ZipReader\getItem(), and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : void {
        $reader = new ZipReader(
            $this->irss->consume()->stream($this->getResourceIdForIdString($container_id))->getStream()
        );
        [$stream, $info] = $reader->getItem($path);

        $this->file_delivery->delivery()->deliver(
            $stream,
            $info['basename'],
            $info['mime_type'],
            Disposition::ATTACHMENT
        );
    }

Here is the call graph for this function:

deliverFile()

ILIAS\Repository\IRSS\IRSSWrapper::deliverFile

(

string

$rid

)

Definition at line 275 of file IRSSWrapper.php.

References $id, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

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

Here is the call graph for this function:

getCollectionForIdString()

ILIAS\Repository\IRSS\IRSSWrapper::getCollectionForIdString

(

string

$rcid

)

Definition at line 83 of file IRSSWrapper.php.

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

getCollectionResourcesInfo()

ILIAS\Repository\IRSS\IRSSWrapper::getCollectionResourcesInfo

(

ResourceCollection

$collection

)

Definition at line 311 of file IRSSWrapper.php.

References $info, and ILIAS\Export\ImportHandler\Parser\NodeInfo\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:

getContainerEntries()

ILIAS\Repository\IRSS\IRSSWrapper::getContainerEntries

(

string

$container_id

)

Definition at line 511 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString(), and ILIAS\components\ResourceStorage\Container\Wrapper\ZipReader\getStructure().

     : array {
        $reader = new ZipReader(
            $this->irss->consume()->stream($this->getResourceIdForIdString($container_id))->getStream()
        );
        return $reader->getStructure();
    }

Here is the call graph for this function:

getContainerEntriesOfPath()

ILIAS\Repository\IRSS\IRSSWrapper::getContainerEntriesOfPath	(	string	$container_id,
		string	$dir_path
	)

Definition at line 520 of file IRSSWrapper.php.

References $path, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : array {
        $reader = new ZipReader(
            $this->irss->consume()->stream($this->getResourceIdForIdString($container_id))->getStream()
        );
        $entries = [];
        foreach ($reader->getStructure() as $path => $entry) {
            $dirname = $entry['dirname'] ?? '';
            if ($dirname !== $dir_path) {
                continue;
            }
            $entries[$path] = $entry;
        }
        return $entries;
    }

Here is the call graph for this function:

getContainerEntryInfo()

ILIAS\Repository\IRSS\IRSSWrapper::getContainerEntryInfo	(	string	$container_id,
		string	$path
	)

Definition at line 420 of file IRSSWrapper.php.

References ILIAS\components\ResourceStorage\Container\Wrapper\ZipReader\getItem(), and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : array {
        $reader = new ZipReader(
            $this->irss->consume()->stream($this->getResourceIdForIdString($container_id))->getStream()
        );
        return $reader->getItem($path)[1];
    }

Here is the call graph for this function:

getContainerPaths()

ILIAS\Repository\IRSS\IRSSWrapper::getContainerPaths

(

string

$container_id

)

Definition at line 501 of file IRSSWrapper.php.

References $path, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : \Generator {
        foreach ($this->irss->consume()->containerZIP(
            $this->getResourceIdForIdString($container_id)
        )->getZIP()->getPaths() as $path) {
            yield $path;
        }
    }

Here is the call graph for this function:

getContainerStreams()

ILIAS\Repository\IRSS\IRSSWrapper::getContainerStreams	(	string	$container_id,
		ResourceStakeholder	$stakeholder
	)

Returns

<Stream>

Definition at line 490 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : \Generator {
        foreach ($this->irss->consume()->containerZIP(
            $this->getResourceIdForIdString($container_id)
        )->getZIP()->getFileStreams() as $stream) {
            yield $stream;
        }
    }

Here is the call graph for this function:

getContainerUri()

ILIAS\Repository\IRSS\IRSSWrapper::getContainerUri	(	string	$rid,
		string	$path
	)

Definition at line 714 of file IRSSWrapper.php.

References $id, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : string {
        $id = $this->getResourceIdForIdString($rid);
        $uri = $this->irss->consume()->containerURI(
            $id,
            $path,
            8 * 60
        )->getURI();
        // temp fixes wrong slash escaping, maybe due to 24805bcaabb33b1c5c82609dbe6791c55577c6a4
        $uri = str_replace("%2F", "/", (string) $uri);
        return (string) $uri;
    }

Here is the call graph for this function:

getContainerZip()

ILIAS\Repository\IRSS\IRSSWrapper::getContainerZip

(

string

$rid

)

Definition at line 729 of file IRSSWrapper.php.

References $id, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : Unzip {
        $id = $this->getResourceIdForIdString($rid);
        return $this->irss->consume()->containerZIP(
            $id
        )->getZIP();
    }

Here is the call graph for this function:

getNewCollectionId()

ILIAS\Repository\IRSS\IRSSWrapper::getNewCollectionId ( )

protected

Definition at line 65 of file IRSSWrapper.php.

Referenced by ILIAS\Repository\IRSS\IRSSWrapper\createEmptyCollection(), and ILIAS\Repository\IRSS\IRSSWrapper\getNewCollectionIdAsString().

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

Here is the caller graph for this function:

getNewCollectionIdAsString()

ILIAS\Repository\IRSS\IRSSWrapper::getNewCollectionIdAsString ( )

protected

Definition at line 70 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\getNewCollectionId().

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

Here is the call graph for this function:

getResource()

ILIAS\Repository\IRSS\IRSSWrapper::getResource

(

string

$rid

)

Definition at line 302 of file IRSSWrapper.php.

References $id, ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString(), and null.

                                            : ?StorableResource
    {
        $id = $this->getResourceIdForIdString($rid);
        if ($id) {
            return $this->irss->manage()->getResource($id);
        }
        return null;
    }

Here is the call graph for this function:

getResourceIdForIdString()

ILIAS\Repository\IRSS\IRSSWrapper::getResourceIdForIdString

(

string

$rid

)

Definition at line 178 of file IRSSWrapper.php.

Referenced by ILIAS\Repository\IRSS\IRSSWrapper\addContainerDirToTargetContainer(), ILIAS\Repository\IRSS\IRSSWrapper\addLocalFileToContainer(), ILIAS\Repository\IRSS\IRSSWrapper\addStreamToContainer(), ILIAS\Repository\IRSS\IRSSWrapper\addStringToContainer(), ILIAS\Repository\IRSS\IRSSWrapper\addUploadToContainer(), ILIAS\Repository\IRSS\IRSSWrapper\cloneContainer(), ILIAS\Repository\IRSS\IRSSWrapper\cloneResource(), ILIAS\Repository\IRSS\IRSSWrapper\deleteResource(), ILIAS\Repository\IRSS\IRSSWrapper\deliverContainerEntry(), ILIAS\Repository\IRSS\IRSSWrapper\deliverFile(), ILIAS\Repository\IRSS\IRSSWrapper\getContainerEntries(), ILIAS\Repository\IRSS\IRSSWrapper\getContainerEntriesOfPath(), ILIAS\Repository\IRSS\IRSSWrapper\getContainerEntryInfo(), ILIAS\Repository\IRSS\IRSSWrapper\getContainerPaths(), ILIAS\Repository\IRSS\IRSSWrapper\getContainerStreams(), ILIAS\Repository\IRSS\IRSSWrapper\getContainerUri(), ILIAS\Repository\IRSS\IRSSWrapper\getContainerZip(), ILIAS\Repository\IRSS\IRSSWrapper\getResource(), ILIAS\Repository\IRSS\IRSSWrapper\getResourceInfo(), ILIAS\Repository\IRSS\IRSSWrapper\importFileFromLegacyUploadToContainer(), ILIAS\Repository\IRSS\IRSSWrapper\importFileFromUploadResultToContainer(), ILIAS\Repository\IRSS\IRSSWrapper\removePathFromContainer(), ILIAS\Repository\IRSS\IRSSWrapper\renameContainer(), ILIAS\Repository\IRSS\IRSSWrapper\renameCurrentRevision(), and ILIAS\Repository\IRSS\IRSSWrapper\stream().

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

Here is the caller graph for this function:

getResourceInfo()

ILIAS\Repository\IRSS\IRSSWrapper::getResourceInfo

(

string

$rid

)

Definition at line 330 of file IRSSWrapper.php.

References $info, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : ResourceInformation {
        $rid = $this->getResourceIdForIdString($rid);
        $info = $this->irss->manage()->getResource($rid)
                           ->getCurrentRevision()
                           ->getInformation();
        $src = $this->irss->consume()->src($rid)->getSrc();
        return $this->data->resourceInformation(
            $rid->serialize(),
            $info->getTitle(),
            $info->getSize(),
            $info->getCreationDate()->getTimestamp(),
            $info->getMimeType(),
            $src
        );
    }

Here is the call graph for this function:

getResourcePath()

ILIAS\Repository\IRSS\IRSSWrapper::getResourcePath

(

string

$rid

)

Definition at line 293 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\stream().

                                                : string
    {
        $stream = $this->stream($rid);
        if ($stream) {
            return $stream->getMetadata('uri') ?? '';
        }
        return "";
    }

Here is the call graph for this function:

getStreamOfContainerEntry()

ILIAS\Repository\IRSS\IRSSWrapper::getStreamOfContainerEntry	(	string	$rid,
		string	$entry
	)

Definition at line 409 of file IRSSWrapper.php.

References ILIAS\Filesystem\Stream\Streams\ofFileInsideZIP(), and ILIAS\Repository\IRSS\IRSSWrapper\stream().

Referenced by ILIAS\Repository\IRSS\IRSSWrapper\addContainerDirToTargetContainer(), and ILIAS\Repository\IRSS\IRSSWrapper\addEntryOfZipResourceToCollection().

     : ZIPStream {
        $zip_path = $this->stream($rid)->getMetadata("uri");
        return Streams::ofFileInsideZIP(
            $zip_path,
            $entry
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasContainerEntry()

ILIAS\Repository\IRSS\IRSSWrapper::hasContainerEntry	(	string	$rid,
		string	$entry
	)

Is there a better way to check this?

Definition at line 450 of file IRSSWrapper.php.

References Vendor\Package\$e, ILIAS\Filesystem\Stream\Streams\ofFileInsideZIP(), and ILIAS\Repository\IRSS\IRSSWrapper\stream().

     : bool {
        $zip_path = $this->stream($rid)?->getMetadata("uri");
        try {
            $stream = Streams::ofFileInsideZIP(
                $zip_path,
                $entry
            );
            $stream->close();
            return true;
        } catch (\Exception $e) {
            return false;
        }
    }

Here is the call graph for this function:

importFileFromLegacyUpload()

ILIAS\Repository\IRSS\IRSSWrapper::importFileFromLegacyUpload	(	array	$file_input,
		ResourceStakeholder	$stakeholder
	)

Definition at line 183 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\$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 "";
    }

importFileFromLegacyUploadToContainer()

ILIAS\Repository\IRSS\IRSSWrapper::importFileFromLegacyUploadToContainer	(	string	$rid,
		string	$tmp_name,
		string	$target_path
	)

Definition at line 740 of file IRSSWrapper.php.

References $id, ILIAS\Repository\IRSS\IRSSWrapper\$upload, ILIAS\Repository\IRSS\IRSSWrapper\addLocalFileToContainer(), and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : void {
        $upload = $this->upload;

        if (!$upload->hasBeenProcessed()) {
            $upload->process();
        }
        foreach ($upload->getResults() as $name => $result) {
            // we must check if these are files from this input
            if ($name !== $tmp_name) {
                continue;
            }
            // if the result is not OK, we skip it
            if (!$result->isOK()) {
                continue;
            }

            $id = $this->getResourceIdForIdString($rid);

            if (!is_null($id)) {
                // if target path is a directory, addUploadToContainer
                // can be used, the original filename will be appended
                if ($target_path === "" || str_ends_with($target_path, "/")) {
                    $this->irss->manageContainer()->addUploadToContainer(
                        $id,
                        $result,
                        "/"
                    );
                } else {
                    // we have a full path given (renaming the
                    // original name)
                    $this->addLocalFileToContainer(
                        $rid,
                        $result->getPath(),
                        $target_path
                    );
                }
            }
        }
    }

Here is the call graph for this function:

importFileFromUploadResult()

ILIAS\Repository\IRSS\IRSSWrapper::importFileFromUploadResult	(	UploadResult	$result,
		ResourceStakeholder	$stakeholder
	)

Definition at line 214 of file IRSSWrapper.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:

importFileFromUploadResultToContainer()

ILIAS\Repository\IRSS\IRSSWrapper::importFileFromUploadResultToContainer	(	string	$rid,
		UploadResult	$result,
		string	$target_path
	)

Definition at line 784 of file IRSSWrapper.php.

References $id, ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString(), and ILIAS\FileUpload\DTO\UploadResult\isOK().

     : void {
        // if the result is not OK, we skip it
        if (!$result->isOK()) {
            return;
        }

        $id = $this->getResourceIdForIdString($rid);

        if (!is_null($id)) {
            $this->irss->manageContainer()->addUploadToContainer(
                $id,
                $result,
                $target_path
            );
        }
    }

Here is the call graph for this function:

importFilesFromDirectoryToCollection()

ILIAS\Repository\IRSS\IRSSWrapper::importFilesFromDirectoryToCollection	(	ResourceCollection	$collection,
		string	$directory,
		ResourceStakeholder	$stakeholder
	)

Definition at line 146 of file IRSSWrapper.php.

References Vendor\Package\$e, ILIAS\Export\ImportHandler\Parser\NodeInfo\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\Repository\IRSS\IRSSWrapper::importFilesFromLegacyUploadToCollection	(	ResourceCollection	$collection,
		array	$file_input,
		ResourceStakeholder	$stakeholder
	)

Definition at line 112 of file IRSSWrapper.php.

References ILIAS\Repository\IRSS\IRSSWrapper\$upload, and ILIAS\Export\ImportHandler\Parser\NodeInfo\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:

importLocalFile()

ILIAS\Repository\IRSS\IRSSWrapper::importLocalFile	(	string	$file,
		string	$name,
		ResourceStakeholder	$stakeholder
	)

Definition at line 231 of file IRSSWrapper.php.

References ILIAS\Filesystem\Util\LegacyPathHelper\createRelativePath(), and ILIAS\Filesystem\Util\LegacyPathHelper\deriveFilesystemFrom().

     : string {
        $sourceFS = LegacyPathHelper::deriveFilesystemFrom($file);
        $sourceFile = LegacyPathHelper::createRelativePath($file);

        //try {
        $stream = $sourceFS->readStream($sourceFile);
        $rid = $this->irss->manage()->stream(
            $stream,
            $stakeholder,
            $name
        );
        //} catch (\Exception $e) {
        //    return "";
        //}
        return $rid->serialize();
    }

Here is the call graph for this function:

importStream()

ILIAS\Repository\IRSS\IRSSWrapper::importStream	(	Stream	$stream,
		ResourceStakeholder	$stakeholder
	)

Definition at line 252 of file IRSSWrapper.php.

     : string {
        $rid = $this->irss->manage()->stream(
            $stream,
            $stakeholder
        );
        return $rid->serialize();
    }

removePathFromContainer()

ILIAS\Repository\IRSS\IRSSWrapper::removePathFromContainer	(	string	$rid,
		string	$path
	)

Definition at line 821 of file IRSSWrapper.php.

References $id, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : void {
        $id = $this->getResourceIdForIdString($rid);
        if (!is_null($id)) {
            $this->irss->manageContainer()->removePathInsideContainer($id, $path);
        }
    }

Here is the call graph for this function:

renameContainer()

ILIAS\Repository\IRSS\IRSSWrapper::renameContainer	(	string	$rid,
		string	$title
	)

Definition at line 832 of file IRSSWrapper.php.

References $id, $info, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : void {
        $id = $this->getResourceIdForIdString($rid);
        $rev = $this->irss->manageContainer()->getCurrentRevision($id);
        $info = $rev->getInformation();
        $info->setTitle($title);
        $rev->setInformation($info);
        $this->irss->manageContainer()->updateRevision($rev);
    }

Here is the call graph for this function:

renameCurrentRevision()

ILIAS\Repository\IRSS\IRSSWrapper::renameCurrentRevision	(	string	$rid,
		string	$title
	)

Definition at line 263 of file IRSSWrapper.php.

References $id, $info, and ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString().

     : void {
        $id = $this->getResourceIdForIdString($rid);
        $rev = $this->irss->manage()->getCurrentRevision($id);
        $info = $rev->getInformation();
        $info->setTitle($title);
        $rev->setInformation($info);
        $this->irss->manage()->updateRevision($rev);
    }

Here is the call graph for this function:

stream()

ILIAS\Repository\IRSS\IRSSWrapper::stream

(

string

$rid

)

Definition at line 284 of file IRSSWrapper.php.

References $id, ILIAS\Repository\IRSS\IRSSWrapper\getResourceIdForIdString(), and null.

Referenced by ILIAS\Repository\IRSS\IRSSWrapper\getResourcePath(), ILIAS\Repository\IRSS\IRSSWrapper\getStreamOfContainerEntry(), and ILIAS\Repository\IRSS\IRSSWrapper\hasContainerEntry().

                                       : ?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

$archives

Archives ILIAS\Repository\IRSS\IRSSWrapper::$archives

protected

Definition at line 47 of file IRSSWrapper.php.

$file_delivery

ILIAS FileDelivery Services ILIAS\Repository\IRSS\IRSSWrapper::$file_delivery

protected

Definition at line 44 of file IRSSWrapper.php.

$filesystems

ILIAS\Repository\IRSS\IRSSWrapper::$filesystems

protected

Definition at line 43 of file IRSSWrapper.php.

$irss

ILIAS ResourceStorage Services ILIAS\Repository\IRSS\IRSSWrapper::$irss

protected

Definition at line 46 of file IRSSWrapper.php.

$upload

ILIAS FileUpload FileUpload ILIAS\Repository\IRSS\IRSSWrapper::$upload

protected

Definition at line 45 of file IRSSWrapper.php.

Referenced by ILIAS\Repository\IRSS\IRSSWrapper\importFileFromLegacyUpload(), ILIAS\Repository\IRSS\IRSSWrapper\importFileFromLegacyUploadToContainer(), and ILIAS\Repository\IRSS\IRSSWrapper\importFilesFromLegacyUploadToCollection().

---

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

• components/ILIAS/Repository/Service/IRSS/IRSSWrapper.php