SplFileObject::fread

(PHP 5 >= 5.5.11, PHP 7, PHP 8)

SplFileObject::freadRead from file

Description

public SplFileObject::fread(int $length): string|false

Reads the given number of bytes from the file.

Parameters

length

The number of bytes to read.

Return Values

Returns the string read from the file or false on failure.

Examples

Example #1 SplFileObject::fread() example

<?php
// Get contents of a file into a string
$filename = "/usr/local/something.txt";
$file = new SplFileObject($filename, "r");
$contents = $file->fread($file->getSize());
?>

Notes

Note:

Note that SplFileObject::fread() reads from the current position of the file pointer. Use SplFileObject::ftell() to find the current position of the pointer and SplFileObject::rewind() (or SplFileObject::fseek()) to rewind the pointer position.

See Also

add a note add a note

User Contributed Notes 1 note

up
0
Sander de Goeij
7 years ago
The manual seems to be wrong about the minimum required version PHP version, this should be PHP 5.6.0. See https://github.com/php/php-src/blob/php-5.6.0/NEWS. On PHP 5.5.9-1ubuntu4.20 I get Attempted to call an undefined method named "fread" of class "SplFileObject"
To Top