ILIAS\Filesystem\Provider\FileStreamReadAccess Interface Reference
Interface FileStreamReadAccess. More...
Inheritance diagram for ILIAS\Filesystem\Provider\FileStreamReadAccess:
Collaboration diagram for ILIAS\Filesystem\Provider\FileStreamReadAccess:
Public Member Functions | |
| readStream (string $path) | |
| Opens a readable stream of the file. More... | |
Detailed Description
Interface FileStreamReadAccess.
This interface describes all readonly streaming filesystem operations.
- Since
- 5.3
- Version
- 1.0
- See also
- FileStreamAccess
Definition at line 22 of file FileStreamReadAccess.php.
Member Function Documentation
◆ readStream()
| ILIAS\Filesystem\Provider\FileStreamReadAccess::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()
- Parameters
-
string $path The path to the file which should be used to open the new stream.
- Returns
- FileStream The newly created file stream.
- Exceptions
-
FileNotFoundException If the file could not be found. IOException If the stream could not be opened.
- Since
- 5.3
- Version
- 1.0
- See also
- FileStream::close()
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/FileStreamReadAccess.php
