Interface for the filesystem adapters.
This interface defines the contract for adapters that manage the interaction with different types of filesystems. The implementing classes provide basic operations like reading, writing, and deleting files, as well as working with file metadata.
read(string $key) : string|bool
Reads the content of the file.
This method reads the contents of a file identified by its key. If the file cannot be read, it returns false.
| string | $key | The key or path of the file to read. |
The content of the file or false if it cannot be read.
write(string $key, string $content) : int|bool
Writes the given content into the file.
This method writes the provided content into a file identified by its key. It returns the number of bytes written or false if the write operation fails.
| string | $key | The key or path of the file to write. |
| string | $content | The content to write into the file. |
The number of bytes written or false on failure.
mtime(string $key) : int|bool
Returns the last modified time.
This method returns the last modified time of a file, in a UNIX timestamp format. If the file cannot be found or accessed, it returns false.
| string | $key | The key or path of the file. |
The last modified time as a UNIX timestamp, or false on failure.
rename(string $sourceKey, string $targetKey) : bool
Renames a file.
This method renames a file from the source key to the target key. It returns true if the operation is successful, or false if it fails.
| string | $sourceKey | The current key or path of the file. |
| string | $targetKey | The new key or path for the file. |
True on success, false on failure.