ILIAS  trunk Revision v11.0_alpha-1769-g99a433fe2dc
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ILIAS\Filesystem\Provider\DirectoryReadAccess Interface Reference
+ 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

Member Function Documentation

◆ hasDir()

ILIAS\Filesystem\Provider\DirectoryReadAccess::hasDir ( string  $path)

Checks whether the directory exists or not.

Parameters
string$pathThe path which should be checked.
Returns
bool True if the directory exists otherwise false.

Implemented in ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Provider\FlySystem\FlySystemDirectoryAccess, ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, and ILIAS\Filesystem\Decorator\ReadOnlyDecorator.

◆ listContents()

ILIAS\Filesystem\Provider\DirectoryReadAccess::listContents ( string  $path = '',
bool  $recursive = false 
)

Lists the content of a directory.

Parameters
string$pathThe directory which should listed. Defaults to the adapter root directory.
bool$recursiveSet 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
DirectoryNotFoundExceptionIf the directory is not found or inaccessible.

Implemented in ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, and ILIAS\Filesystem\Decorator\ReadOnlyDecorator.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemDirectoryAccess\copyDir(), ILIAS\Filesystem\Provider\FlySystem\FlySystemDirectoryAccess\ensureEmptyDirectory(), and ILIAS\Filesystem\Provider\FlySystem\FlySystemDirectoryAccess\hasDir().

+ Here is the caller graph for this function:

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