Skip to content

feat: Deprecated the getFileContents() method in favour of ::readFile() #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2025
Merged

feat: Deprecated the getFileContents() method in favour of ::readFile() #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d499f16
fix
theofidry Nov 12, 2025
1830c04
Merge branch 'main' into fix/get-contents
theofidry Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions UPGRADE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

- The class `FileSystem` was renamed `NativeFileSystem`. `FileSystem` is now an
interface.
- Deprecated the `::getFileContents()` method in favour of the `::readFile()`.
7 changes: 2 additions & 5 deletions src/FileSystem.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down