diff --git a/UPGRADE.md b/UPGRADE.md index 68817dd..f2f053c 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -2,3 +2,4 @@ - The class `FileSystem` was renamed `NativeFileSystem`. `FileSystem` is now an interface. +- Deprecated the `::getFileContents()` method in favour of the `::readFile()`. diff --git a/src/FileSystem.php b/src/FileSystem.php index cff95fb..ba048fc 100644 --- a/src/FileSystem.php +++ b/src/FileSystem.php @@ -66,13 +66,10 @@ public function escapePath(string $path): string; public function dumpFile(string $filename, $content = ''): void; /** - * Gets the contents of a file. - * - * @param string $file File path + * @deprecated Use the `::readFile()` method. Deprecated since 2.0 and it will be removed in 3.0. + * @see readFile * * @throws IOException If the file cannot be read - * - * @return string File contents */ public function getFileContents(string $file): string;