array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ru', ), 'this' => array ( 0 => 'function.fgets.php', 1 => 'fgets', 2 => 'Получает строку из указателя на файл', ), 'up' => array ( 0 => 'ref.filesystem.php', 1 => 'Функции файловой системы', ), 'prev' => array ( 0 => 'function.fgetcsv.php', 1 => 'fgetcsv', ), 'next' => array ( 0 => 'function.fgetss.php', 1 => 'fgetss', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ru', 'path' => 'reference/filesystem/functions/fgets.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

fgets

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

fgets — Получает строку из указателя на файл

Описание

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

Функция получает строку из файлового указателя.

Список параметров

stream

Требуется допустимый указатель на файл, который успешно открыли функцией fopen() или функцией fsockopen() и ещё не закрыли функцией fclose().

length

Чтение заканчивается, когда: а) функция прочитала length - 1 байтов, б) встретился конец строки (который функция включает в возвращаемое значение) или в) наступило состояние EOF (функция достигла конца файла) — в зависимости от того, что наступит раньше. Чтение из потока будет продолжаться до тех пор, пока функция не достигнет конца строки, если длину не указали.

Возвращаемые значения

Функция возвращает строку размером до length - 1 байтов, которую функция прочитала из дескриптора файла, на который указывает параметр stream. Функция возвращает false, если данных для чтения не осталось.

Функция возвращает false, если возникла ошибка.

Примеры

Пример #1 Пример построчного чтения файла

<?php

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

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

if (!feof($fp)) {
echo "Ошибка: неожиданный сбой функций fgets()\n";
}

fclose($fp);
}

?>

Примечания

Замечание: Включение опции auto_detect_line_endings во время выполнения иногда помогает исправить неправильное распознавание языком PHP концов строк при чтении файлов на Macintosh-совместимом компьютере или файлов, которые создали на Макинтоше.

Замечание:

Программистам, которые привыкли к семантике функции fgets() языка C, требуется принять во внимание разницу в том, как возвращается признак конца файла (EOF).

Смотрите также