fgets

(PHP 4, PHP 5, PHP 7, PHP 8)

fgets — Gets line from file pointer

Опис

fgets(resource $stream, ?int $length = null): string|false

Gets a line from file pointer.

Параметри

stream: Вказівник на файл має бути дійсним та має вказувати на файл, успішно відкритий функцією fopen() або fsockopen() (та не закритий функцією fclose()).
length: Reading ends when length - 1 bytes have been read, or a newline (which is included in the return value), or an EOF (whichever comes first). If no length is specified, it will keep reading from the stream until it reaches the end of the line.

Значення, що повертаються

Returns a string of up to length - 1 bytes read from the file pointed to by stream. If there is no more data to read in the file pointer, then false is returned.

If an error occurs, false is returned.

Приклади

Приклад #1 Reading a file line by line

<?php

$fp = @fopen("/tmp/inputfile.txt", "r");

if ($fp) {
    while (($buffer = fgets($fp, 4096)) !== false) {
        echo $buffer, PHP_EOL;
    }

    if (!feof($fp)) {
        echo "Error: unexpected fgets() fail\n";
    }

    fclose($fp);
}

?>

Примітки

Зауваження: Якщо виникають проблеми з розпізнаванням закінчення рядків під час читання чи створення файлів на компʼютері Macintosh, може допомогти застосування директиви auto_detect_line_endings під час виконання.

Зауваження:
People used to the 'C' semantics of fgets() should note the difference in how EOF is returned.

Прогляньте також

fgetss() - Gets line from file pointer and strip HTML tags
fread() - Binary-safe file read
fgetc() - Gets character from file pointer
stream_get_line() - Gets line from stream resource up to a given delimiter
fopen() - Opens file or URL
popen() - Opens process file pointer
fsockopen() - Open Internet or Unix domain socket connection
stream_set_timeout() - Set timeout period on a stream