Interface FileStreamWriteAccess. More...
Inheritance diagram for ILIAS\Filesystem\Provider\FileStreamWriteAccess:
Collaboration diagram for ILIAS\Filesystem\Provider\FileStreamWriteAccess:
Public Member Functions | |
| 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
Interface FileStreamWriteAccess.
This interface describes the write operations for the streaming filesystem access.
- Since
- 5.3
- Version
- 1.0
- See also
- FileStreamAccess
Definition at line 24 of file FileStreamWriteAccess.php.
Member Function Documentation
◆ putStream()
| ILIAS\Filesystem\Provider\FileStreamWriteAccess::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.
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.
- Parameters
-
string $path The file which should be used to write the stream into. FileStream $stream The stream which should be written to the file.
- Returns
- void
- Since
- 5.3
- Version
- 1.0
- See also
- FileStream::detach()
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess.
◆ updateStream()
| ILIAS\Filesystem\Provider\FileStreamWriteAccess::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.
- Parameters
-
string $path The path to the file which should be updated. FileStream $stream The stream which should be used to update the file content.
- Returns
- void
- Since
- 5.3
- Version
- 1.0
- See also
- FileStream::detach()
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess.
◆ writeStream()
| ILIAS\Filesystem\Provider\FileStreamWriteAccess::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.
- Parameters
-
string $path The file which should be used to write the stream into. FileStream $stream The stream which should be written into the new file.
- Returns
- void
- Since
- 5.3
- Version
- 1.0
- See also
- FileStream::detach()
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess.
The documentation for this interface was generated from the following file:
- src/Filesystem/Provider/FileStreamWriteAccess.php
