ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess Class Reference

Inheritance diagram for ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess:

Collaboration diagram for ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess:

Public Member Functions
	__construct (private FilesystemOperator $flysystem_operator)
	readStream (string $path)
	Opens a readable stream of the file. More...
	writeStream (string $path, FileStream $stream)
	Writes the stream to a new file. More...
	putStream (string $path, FileStream $stream)
	Creates a new file or updates an existing one. More...
	updateStream (string $path, FileStream $stream)
	Updates an existing file. More...

Detailed Description

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Definition at line 38 of file FlySystemFileStreamAccess.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess::__construct

(

private FilesystemOperator

$flysystem_operator

)

Definition at line 40 of file FlySystemFileStreamAccess.php.

      {
    }

Member Function Documentation

putStream()

ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess::putStream	(	string	$path,
		FileStream	$stream
	)

Creates a new file or updates an existing one.

If the file is updated its content will be truncated before writing the stream.

See also

FileStream::detach()

Implements ILIAS\Filesystem\Provider\FileStreamWriteAccess.

Definition at line 96 of file FlySystemFileStreamAccess.php.

                                                               : void
    {
        $resource = $stream->detach();
        try {
            if (!is_resource($resource)) {
                throw new \InvalidArgumentException('The given stream must not be detached.');
            }

            $result = $this->flysystem_operator->putStream($path, $resource);

            if ($result === false) {
                throw new IOException("Could not put stream content into \"$path\"");
            }
        } finally {
            if (is_resource($resource)) {
                fclose($resource);
            }
        }
    }

readStream()

ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess::readStream

(

string

$path

)

Opens a readable stream of the file.

Please make sure to close the stream after the work is done with Stream::close()

See also

FileStream::close()

Implements ILIAS\Filesystem\Provider\FileStreamReadAccess.

Definition at line 50 of file FlySystemFileStreamAccess.php.

References ILIAS\Filesystem\Stream\Streams\ofResource().

                                            : FileStream
    {
        try {
            $resource = $this->flysystem_operator->readStream($path);
            if ($resource === false) {
                throw new IOException("Could not open stream for file \"$path\"");
            }
            return Streams::ofResource($resource);
        } catch (UnableToRetrieveMetadata|UnableToReadFile $ex) {
            throw new FileNotFoundException("File \"$path\" not found.", 0, $ex);
        }
    }

Here is the call graph for this function:

updateStream()

ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess::updateStream	(	string	$path,
		FileStream	$stream
	)

Updates an existing file.

The file content will be truncated to 0.

The stream will be closed after the write operation is done. Please note that the resource must be detached from the stream in order to write to the file.

Implements ILIAS\Filesystem\Provider\FileStreamWriteAccess.

Definition at line 123 of file FlySystemFileStreamAccess.php.

                                                                  : void
    {
        $resource = $stream->detach();
        try {
            if (!is_resource($resource)) {
                throw new \InvalidArgumentException('The given stream must not be detached.');
            }
            // FlySystem 3 has no updateStream method, so we have to use writeStream instead.
            $this->flysystem_operator->writeStream($path, $resource);
        } catch (UnableToWriteFile $ex) {
            throw new FileNotFoundException("Unable to update Stream in \"$path\".", 0, $ex);
        } finally {
            if (is_resource($resource)) {
                fclose($resource);
            }
        }
    }

writeStream()

ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess::writeStream	(	string	$path,
		FileStream	$stream
	)

Writes the stream to a new file.

The directory path to the file will be created.

The stream will be closed after the write operation is done. Please note that the resource must be detached from the stream in order to write to the file.

See also

FileStream::detach()

Implements ILIAS\Filesystem\Provider\FileStreamWriteAccess.

Definition at line 71 of file FlySystemFileStreamAccess.php.

                                                                 : void
    {
        $resource = $stream->detach();
        if (!is_resource($resource)) {
            throw new \InvalidArgumentException('The given stream must not be detached.');
        }
        if ($this->flysystem_operator->fileExists($path)) {
            throw new FileAlreadyExistsException("File \"$path\" already exists.");
        }
        try {
            $this->flysystem_operator->writeStream($path, $resource);
        } catch (UnableToWriteFile $ex) {
            throw new IOException("Could not write stream to file \"$path\"", 0, $ex);
        } finally {
            if (is_resource($resource)) {
                fclose($resource);
            }
        }
    }

---

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

• components/ILIAS/Filesystem/src/Provider/FlySystem/FlySystemFileStreamAccess.php