SplFileObject::fgets

(PHP 5 >= 5.1.0, PHP 7)

SplFileObject::fgetsGets line from file

Description

public string SplFileObject::fgets ( void )

Gets a line from the file.

Parameters

This function has no parameters.

Return Values

Returns a string containing the next line from the file, or FALSE on error.

Errors/Exceptions

Throws a RuntimeException if the file cannot be read.

Examples

Example #1 SplFileObject::fgets() example

This example simply outputs the contents of file.txt line-by-line.

<?php
$file 
= new SplFileObject("file.txt");
while (!
$file->eof()) {
    echo 
$file->fgets();
}
?>

See Also

add a note add a note

User Contributed Notes 1 note

up
0
Chris Johnson
9 months ago
Note that this method will cause a PHP fatal error if the file being read contains no recognizable line termination characters and is larger than the allowable memory size for PHP to allocate, i.e. memory_limit set in php.ini or similar.  In other words, PHP keeps reading until it finds a line termination, if it runs out of memory first, it will throw a fatal error.

This is different from the file resource fread() function, which allows an optional maximum length argument to be passed to limit this behavior.
To Top