Interface FileWriteAccess. More...
Inheritance diagram for ILIAS\Filesystem\Provider\FileWriteAccess:
Collaboration diagram for ILIAS\Filesystem\Provider\FileWriteAccess:
Public Member Functions | |
| 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... | |
Detailed Description
Interface FileWriteAccess.
All write file operations of the filesystem service.
- Since
- 5.3
- Version
- 1.0
- See also
- FileAccess
Definition at line 35 of file FileWriteAccess.php.
Member Function Documentation
◆ copy()
| ILIAS\Filesystem\Provider\FileWriteAccess::copy | ( | string | $path, |
| string | $copy_path | ||
| ) |
Copy the source file to a destination.
- Parameters
-
string $path The source path to the file which should be copied. string $copyPath The destination path of the file copy.
- Returns
- void
- Exceptions
-
FileNotFoundException If the source file does not exist. FileAlreadyExistsException If the destination file already exists. IOException If the file could not be copied to the destination.
- Since
- 5.3
- Version
- 1.0
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.
◆ delete()
| ILIAS\Filesystem\Provider\FileWriteAccess::delete | ( | string | $path | ) |
Deletes a file.
- Parameters
-
string $path The path to the file which should be deleted.
- Returns
- void
- Exceptions
-
FileNotFoundException If the file was not found. IOException If the file was found but the delete operation finished with errors.
- Since
- 5.3
- Version
- 1.0
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.
◆ put()
| ILIAS\Filesystem\Provider\FileWriteAccess::put | ( | string | $path, |
| string | $content | ||
| ) |
Creates a file or updates an existing one.
- Parameters
-
string $path The path to the file which should be created or updated. string $content The content which should be written to the file.
- Returns
- void
- Exceptions
-
IOException If the file could not be created or updated.
- Since
- 5.3
- Version
- 1.0
- Since
- 5.3
- Version
- 1.0
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.
◆ readAndDelete()
| ILIAS\Filesystem\Provider\FileWriteAccess::readAndDelete | ( | string | $path | ) |
Reads the entire file content into a string and removes the file afterwards.
- Parameters
-
string $path The file which should be red and removed.
- Returns
- string The entire file content.
- Exceptions
-
FileNotFoundException If the file was not found. IOException If the file could not red or deleted.
- Since
- 5.3
- Version
- 1.0
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.
◆ rename()
| ILIAS\Filesystem\Provider\FileWriteAccess::rename | ( | string | $path, |
| string | $new_path | ||
| ) |
Moves a file from the source to the destination.
- Parameters
-
string $path The current path of the file which should be moved. string $newPath The new path of the file.
- Returns
- void
- Exceptions
-
FileNotFoundException If the source file is not found. FileAlreadyExistsException If the destination file is already existing. IOException If the file could not be moved.
- Since
- 5.3
- Version
- 1.0
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.
◆ update()
| ILIAS\Filesystem\Provider\FileWriteAccess::update | ( | string | $path, |
| string | $new_content | ||
| ) |
Updates the content of a file.
Replaces the file content with a new one.
- Parameters
-
string $path The path to the file which should be updated. string $newContent The new file content.
- Returns
- void
- Exceptions
-
FileNotFoundException If the file is not found. IOException If the file could not be updated.
- Since
- 5.3
- Version
- 1.0
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.
◆ write()
| ILIAS\Filesystem\Provider\FileWriteAccess::write | ( | string | $path, |
| string | $content | ||
| ) |
Writes the content to a new file.
- Parameters
-
string $path The path to the file which should be created. string $content The content which should be written to the new file.
- Returns
- void
- Exceptions
-
FileAlreadyExistsException If the file already exists. IOException If the file could not be created or written.
- Since
- 5.3
- Version
- 1.0
Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.
The documentation for this interface was generated from the following file:
- src/Filesystem/Provider/FileWriteAccess.php
