ILIAS  trunk Revision v5.2.0beta1-34115-g3a2438be29
ILIAS\Filesystem\Filesystem Interface Reference

The filesystem interface provides the public interface for the Filesystem service API consumer. More...

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

Public Member Functions

 finder ()
 
- Public Member Functions inherited from ILIAS\Filesystem\Provider\FileStreamReadAccess
 readStream (string $path)
 Opens a readable stream of the file. More...
 
- Public Member Functions inherited from ILIAS\Filesystem\Provider\FileStreamWriteAccess
 writeStream (string $path, FileStream $stream)
 Writes the stream to a new file. More...
 
 putStream (string $path, FileStream $stream)
 Creates a new file or updates an existing one. More...
 
 updateStream (string $path, FileStream $stream)
 Updates an existing file. More...
 
- Public Member Functions inherited from ILIAS\Filesystem\Provider\FileReadAccess
 read (string $path)
 Reads a file content to a string. More...
 
 has (string $path)
 Checks whether a file exists. More...
 
 getMimeType (string $path)
 Get a files mime-type. More...
 
 getTimestamp (string $path)
 Get the timestamp of the file. More...
 
 getSize (string $path, int $unit)
 Get the size of a file. More...
 
 setVisibility (string $path, string $visibility)
 Sets the visibility for a file. More...
 
 getVisibility (string $path)
 Get the file visibility. More...
 
- Public Member Functions inherited from ILIAS\Filesystem\Provider\FileWriteAccess
 write (string $path, string $content)
 Writes the content to a new file. More...
 
 update (string $path, string $new_content)
 Updates the content of a file. More...
 
 put (string $path, string $content)
 Creates a file or updates an existing one. More...
 
 delete (string $path)
 Deletes a file. More...
 
 readAndDelete (string $path)
 Reads the entire file content into a string and removes the file afterwards. More...
 
 rename (string $path, string $new_path)
 Moves a file from the source to the destination. More...
 
 copy (string $path, string $copy_path)
 Copy the source file to a destination. More...
 
- Public Member Functions inherited from ILIAS\Filesystem\Provider\DirectoryReadAccess
 hasDir (string $path)
 Checks whether the directory exists or not. More...
 
 listContents (string $path='', bool $recursive=false)
 Lists the content of a directory. More...
 
- Public Member Functions inherited from ILIAS\Filesystem\Provider\DirectoryWriteAccess
 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

The filesystem interface provides the public interface for the Filesystem service API consumer.

The interface consists of several more specific interfaces which are defining the actual access methods of the filesystem. With the smaller interfaces a developer is able to expose only certain parts of the filesystem functionality to his own code.

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 36 of file Filesystem.php.

Member Function Documentation

◆ finder()


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