Skip to content
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

Jump to bottom

[Filesystem] Document the readFile() method #19689

Merged
merged 1 commit into from
Mar 19, 2024
Merged

[Filesystem] Document the readFile() method #19689

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 16 additions & 0 deletions components/filesystem.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,22 @@ contents at the end of some file::
If either the file or its containing directory doesn't exist, this method
creates them before appending the contents.

``readFile``
~~~~~~~~~~~~

.. versionadded:: 7.1
javiereguiluz marked this conversation as resolved.
Show resolved Hide resolved

The ``readFile()`` method was introduced in Symfony 7.1.

:method:`Symfony\\Component\\Filesystem\\Filesystem::readFile` returns all the
contents of a file as a string. Unlike the :phpfunction:`file_get_contents` function
from PHP, it throws an exception when the given file path is not readable and
when passing the path to a directory instead of a file::

$contents = $filesystem->readFile('/some/path/to/file.txt');

The ``$contents`` variable now stores all the contents of the ``file.txt`` file.

Path Manipulation Utilities
---------------------------

Expand Down