ILIAS  trunk Revision v11.0_alpha-1761-g6dbbfa7b760
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ILIAS\Filesystem\Provider\DirectoryWriteAccess Interface Reference
+ Inheritance diagram for ILIAS\Filesystem\Provider\DirectoryWriteAccess:
+ Collaboration diagram for ILIAS\Filesystem\Provider\DirectoryWriteAccess:

Public Member Functions

 createDir (string $path, string $visibility=Visibility::PUBLIC_ACCESS)
 Create a new directory. More...
 
 copyDir (string $source, string $destination)
 Copy all childes of the source recursive to the destination. More...
 
 deleteDir (string $path)
 Deletes a directory recursive. More...
 

Detailed Description

Member Function Documentation

◆ copyDir()

ILIAS\Filesystem\Provider\DirectoryWriteAccess::copyDir ( string  $source,
string  $destination 
)

Copy all childes of the source recursive to the destination.

The file access rights will be copied as well.

The operation will fail fast if the destination directory is not empty. All destination folders will be created if needed.

Parameters
string$sourceThe source which should be scanned and copied.
string$destinationThe destination of the recursive copy.
Exceptions
DirectoryNotFoundExceptionThrown if the source directory could not be found.
IOExceptionThrown if the directory could not be copied.

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

◆ createDir()

ILIAS\Filesystem\Provider\DirectoryWriteAccess::createDir ( string  $path,
string  $visibility = Visibility::PUBLIC_ACCESS 
)

Create a new directory.

Please note that the Visibility interface defines two constants PUBLIC_ACCESS and PRIVATE_ACCESS to ease the development process.

Parameters
string$pathThe directory path which should be created.
string$visibilityThe visibility of the directory. Defaults to visibility public.
Exceptions
IOExceptionIf the directory could not be created.

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

◆ deleteDir()

ILIAS\Filesystem\Provider\DirectoryWriteAccess::deleteDir ( string  $path)

Deletes a directory recursive.

Parameters
string$pathThe path which should be deleted.
Exceptions
IOExceptionIf the path could not be deleted.

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


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