ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ILIAS\Filesystem\Filesystems Interface Reference

Class Filesystems. More...

+ Inheritance diagram for ILIAS\Filesystem\Filesystems:
+ Collaboration diagram for ILIAS\Filesystem\Filesystems:

Public Member Functions

 web ()
 Fetches the web filesystem. More...
 
 storage ()
 Fetches the storage filesystem. More...
 
 temp ()
 Fetches the temporary filesystem which can be used for temporary file operations. More...
 
 customizing ()
 Fetches the customizing filesystem which is located at the root of the customizing directory of ILIAS. More...
 
 libs ()
 Fetches the libs filesystem which is located at the root of the libs directory of ILIAS. More...
 

Detailed Description

Class Filesystems.

The Filesystems interface defines the access methods which can be used to fetch the different filesystems.

Author
Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Since
5.3
Version
1.0

Definition at line 16 of file Filesystems.php.

Member Function Documentation

◆ customizing()

ILIAS\Filesystem\Filesystems::customizing ( )

Fetches the customizing filesystem which is located at the root of the customizing directory of ILIAS.

Returns
Filesystem
Exceptions
IllegalStateExceptionThrown if the filesystem is requested without initialisation.
Since
5.3

Implemented in ILIAS\Filesystem\FilesystemsImpl.

◆ libs()

ILIAS\Filesystem\Filesystems::libs ( )

Fetches the libs filesystem which is located at the root of the libs directory of ILIAS.

This is read only

Returns
Filesystem
Exceptions
IllegalStateExceptionThrown if the filesystem is requested without initialisation.
Since
5.3

Implemented in ILIAS\Filesystem\FilesystemsImpl.

◆ storage()

ILIAS\Filesystem\Filesystems::storage ( )

Fetches the storage filesystem.

The storage filesystem is the data directory which located outside of the ILIAS web root.

Returns
Filesystem
Exceptions
IllegalStateExceptionThrown if the filesystem is requested without initialisation.
Since
5.3

Implemented in ILIAS\Filesystem\FilesystemsImpl.

◆ temp()

ILIAS\Filesystem\Filesystems::temp ( )

Fetches the temporary filesystem which can be used for temporary file operations.

Returns
Filesystem
Exceptions
IllegalStateExceptionThrown if the filesystem is requested without initialisation.
Since
5.3

Implemented in ILIAS\Filesystem\FilesystemsImpl.

◆ web()

ILIAS\Filesystem\Filesystems::web ( )

Fetches the web filesystem.

The web filesystem points to the data directory within the ILIAS web root.

Returns
Filesystem
Exceptions
IllegalStateExceptionThrown if the filesystem is requested without initialisation.
Since
5.3

Implemented in ILIAS\Filesystem\FilesystemsImpl.


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