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

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 28 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.

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.

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

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

Here is the caller graph for this function:

---

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

• components/ILIAS/Filesystem/src/Provider/DirectoryReadAccess.php