ILIAS\Filesystem\Provider\DirectoryReadAccess Interface Reference
Interface DirectoryReadAccess. More...
Inheritance diagram for ILIAS\Filesystem\Provider\DirectoryReadAccess:
Collaboration diagram for ILIAS\Filesystem\Provider\DirectoryReadAccess:
Public Member Functions | |
| hasDir (string $path) | |
| Checks whether the directory exists or not. More... | |
| listContents (string $path='', bool $recursive=false) | |
| Lists the content of a directory. More... | |
Detailed Description
Interface DirectoryReadAccess.
Defines the readonly directory access operations of the filesystem.
- Since
- 5.3
- Version
- 1.0
- See also
- DirectoryAccess
Definition at line 21 of file DirectoryReadAccess.php.
Member Function Documentation
◆ hasDir()
| ILIAS\Filesystem\Provider\DirectoryReadAccess::hasDir | ( | string | $path | ) |
Checks whether the directory exists or not.
- Parameters
-
string $path The path which should be checked.
- Returns
- bool True if the directory exists otherwise false.
- Since
- 5.3
- Version
- 1.0
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Provider\FlySystem\FlySystemDirectoryAccess.
◆ listContents()
| ILIAS\Filesystem\Provider\DirectoryReadAccess::listContents | ( | string | $path = '', |
| bool | $recursive = false |
||
| ) |
Lists the content of a directory.
- Parameters
-
string $path The directory which should listed. Defaults to the adapter root directory. bool $recursive Set to true if the child directories also should be listed. Defaults to false.
- Returns
- Metadata[] An array of metadata about all known files, in the given directory.
- Exceptions
-
DirectoryNotFoundException If the directory is not found or inaccessible.
- Since
- 5.3
- Version
- 1.0
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Provider\FlySystem\FlySystemDirectoryAccess.
The documentation for this interface was generated from the following file:
- src/Filesystem/Provider/DirectoryReadAccess.php
